Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 4.8 KB

README.md

File metadata and controls

78 lines (44 loc) · 4.8 KB

Watermelon GitHub Plugin for Visual Studio Code

Report an issue

GitHub Repo stars Contributors Twitter Follow Installs Downloads Rating Slack

Watermelon is an open-source integration between GitHub and Visual Studio Code. 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 allows you to highlight a piece of code to obtain its historical context.

watermelon screenshot

Usage

Simply click the Watermelon icon on the sidebar, highlight a piece of code, and then click "Run Watermelon".

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

Alternatively, you can run with our watermelon.start command

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 command 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

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 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

Supporters

Stargazers repo roster for @watermelontools/wm-extension

Forkers repo roster for @watermelontools/wm-extension


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