Skip to content

daniperil/watermelon-extension

Β 
Β 

Repository files navigation

Watermelon GitHub Plugin for Visual Studio Code

Report an issue

GitHub Repo stars Contributors Twitter Follow Installs Downloads Rating Discord

Watermelon is your Open Source Code Archeology Toolbox for Visual Studio Code. We allow developers to find the most relevant piece of context for a given block of code. We help you grok codebases by indexing information from git, ticketing, and messaging systems.

Free Features

Watermelon has 2 features that you can use for free:

  • Hover to get context
  • Get most relevant Pull Request (500 queries per month)

Hover To Get Context

The fastest way to use Watermelon is to hover over a line of code to get its context.

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

hover

  • The author and date of the latest commit
  • The message of the latest commit
  • The number of times the current file has changed
  • A button that says "View the code context with Watermelon"

If you want to do a deeper research about the code context history, simply click such button.

Get Full Code Context

Highlight a piece of code to get its full code context from git (free), ticketing and messaging (paid) systems. There are 3 ways you can use this feature.

NOTE: This takes up to 10 seconds right now. Please be patient while we work on making this faster.

Click get code context button on the sidebar

sidebarButton

Click button from the hover context box

hoverGetContext

Click get code context button on the right-click menu

rightClickMenu

Paid Features

In addition to getting unlimited code context queries, paying for Watermelon also gives you access to context from the following sources via its integrations:

  • Jira (get the most relevant ticket)
  • Slack (get the most relevant message thread)

More integrations coming soon!

Requirements

  • macOS 10.11+, Windows 10+ or Linux
  • Visual Studio Code v1.63.0+
  • Visual Studio Code Insiders v1.63.0+
  • VS Codium v1.63.0+ (BETA INTEGRATION)
  • 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

Download from the VS Codium Marketplace (Open VSX Registry)

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

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 Discord community. Alternatively, comment on our issues if you plan to solve one.

Analytics

We use VS Code's telemetry library. The library respects the user's decision about whether or not to send telemetry data.

We don't store your code

Supporters

Stargazers repo roster for @watermelontools/watermelon-extension

Forkers repo roster for @watermelontools/watermelon-extension


About Watermelon

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

License

About

πŸ‰ Your code archeology toolbox

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%