/sourcegraph-vscode

*️⃣+ 🆚 = ❤️

Primary LanguageTypeScriptMIT LicenseMIT

Sourcegraph for Visual Studio Code

vs marketplace downloads build semantic-release codecov

The Sourcegraph extension for VS Code enables you to open and search code on Sourcegraph.com easily and efficiently.

Installation

  1. Open the extensions tab on the left side of VS Code (Cmd+Shift+X or Ctrl+Shift+X).
  2. Search for Sourcegraph -> Install and Reload.

Usage

In the command palette (Cmd+Shift+P or Ctrl+Shift+P), search for Sourcegraph: to see available actions.

Keyboard Shortcuts:

Description Mac Linux / Windows
Open file in Sourcegraph Option+A Alt+A
Search selection in Sourcegraph Option+S Alt+S

Extension Settings

This extension contributes the following settings:

  • sourcegraph.url: The Sourcegraph instance to use. Specify your on-premises Sourcegraph instance here, if applicable.
  • sourcegraph.remoteUrlReplacements: Object, where each key is replaced by value in the remote url.
  • sourcegraph.defaultBranch: String to set the name of the default branch. Always open files in the default branch.

Questions & Feedback

Please file an issue: https://github.com/sourcegraph/sourcegraph-vscode/issues/new

Uninstallation

  1. Open the extensions tab on the left side of VS Code (Cmd+Shift+X or Ctrl+Shift+X).
  2. Search for Sourcegraph -> Gear icon -> Uninstall and Reload.

Development

To develop the extension:

  • git clone the repository somewhere
  • Run npm install in the directory
  • Open the repo with code .
  • Press F5 to open a new VS Code window with the extension loaded.
  • After making changes to src/extension.ts, reload the window by clicking the reload icon in the debug toolbar or with F5.
  • To release a new version: follow Conventional Commit Messages and push to/merge into to master. CI will do the release.