Watermelon GitHub Plugin for Visual Studio Code

Watermelon is an open-source integration between GitHub and Visual Studio Code to help developers go beyond Git Blame. Watermelon makes you an expert on any file instantly by running git blame for you and telling you why a block of code was written that way by someone else.

Features

Watermelon has 3 main features that you can use:

View Git Blame
View Pull Requests
Daily Summary

The main UI to use Watermelon is the context box you see when you hover over lines of code with our extension installed. This UI is complemented with the sidebar we have.

In the image below you can see how hovering over a line of code provides us the following data:

hover

The latest commit message for that line
The amount of changes for the file that you're currently in, usually called churn

If you want to do a deeper research about the code context history, simply click one of the links in the context box.

View Commit History

Highlight a piece of code, and then click the View Commit History button. We will run Git Blame for you, and give you a table with the Git commit messages relevant to the piece of code you highlighted.

commit-hisotry

You may also highlight and right click on the code, you will find the 'View Commit History with Watermelon' command at the end.

As a final way to use, only with your keyboard, you may pull the Command Palette (CTRL+SHIFT+P on Windows and Linux and CMD+SHIFT+P on Mac) and type "Get commit history with Watermelon".

View Pull Requests

Highlight a piece of code, and then click the View Pull Requests button to run Git Blame on the background. We will get the PR bodies and comments that are relevant to the highlighted piece of code for you.

Depending on the size of your GitHub history, this might take a few seconds.

pull-request

Alternatively, you can run with our watermelon.start command

You may also highlight and right click on the code, you will find the 'Get Pull Requests with Watermelon' command at the end.

Daily Summary

Get an overview of which issues and PR reviews are assigned to you. Both on the current repository and across all GitHub.

To use it, open the Watermelon sidebar.

daily-summary

Requirements

macOS 10.11+, Windows 10+ or Linux
Visual Studio Code v1.63.0+
You must have Git locally installed (try git --version or install it now)

Installation

Download from the VS Code Marketplace.

Alternatively, you can search for "Watermelon" in VS Code's built-in extension marketplace and install from there.
Download on VSCode

Commands

Watermelon comes with a few commands that you can run from VS Code's Command Palette. The result is exactly the same as running a Watermelon query with the green button. Results sit in your sidebar.

Command	Description
`watermelon.start`	Get the historical context of the selected block of code
`watermelon.blame`	Get the commit history of the selected block of code
`watermelon.show`	Reveal the extension
`watermelon.recommend`	Add the extension to the list of recommended
`watermelon.login`	Login using GitHub

Shortcuts

As an alternative, you can use the following shortcuts:

Ctrl+Shift+C (Cmd+Shift+C on Mac) to view Pull Requests
Ctrl+Shift+H (Cmd+Shift+H on Mac) to view the Commit History

Contributing

Check out Contributing.md and be aware of the Code of Conduct!

We're an early stage project, therefore we still have the luxury to coordinate via short chats with our contributors. If you're interested in contributing, please join our Slack community. Alternatively, comment on our issues if you plan to solve one.

Analytics

We track user actions in an anonymous manner to improve our application. We store your GitHub username, repo name and organization.

We don't store your code

Supporters

About Watermelon

Watermelon is built by a globally distributed team of developers devoted to making software development easier. Join our Slack community, follow us on Twitter and go to the Watermelon blog to get the best programming tips.

License

Apache License

Watermelon

WatermelonTools