Watermelon is an open-source integration between GitHub and Visual Studio Code to document code and view 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.
Watermelon has 2 features that you can use:
- View Git Blame
- View Pull Requests
Simply click the Watermelon icon on the sidebar. After that you can click any of the 2 different buttons Watermelon has.
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.
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)
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.
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.
- macOS 10.11+, Windows 10+ or Linux
- Visual Studio Code v1.63.0+
- You must have Git locally installed (try
git --versionor install it now)
Download from the VS Code Marketplace.
Alternatively, you can search for "Watermelon" in VS Code's built-in extension marketplace and install from there.
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 |
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.
We track users to improve our application. We store your GitHub username and whether your Watermelon query was successful or not.
We don't store your code
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.