/sourcegraph-atom

Sourcegraph for Atom

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Sourcegraph for Atom Atom Plugin

The Sourcegraph plugin for Atom enables you to quickly open and search code on Sourcegraph.com easily and efficiently.

Status: Prerelease. Not yet ready for use.

Installation

  • Open Atom -> Preferences (Cmd+,).
  • Select Install on the left.
  • Search for Sourcegraph and press enter, then Install.
  • Restart Atom.

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

Settings

  • Open Atom -> Preferences (Cmd+,).
  • Select Packages on the left.
  • Search for Sourcegraph, then Settings.
  • Click the Default: https://sourcegraph.com field to edit it and enter your on-premises Sourcegraph instance.

Questions & Feedback

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

Uninstallation

  • Open Atom -> Preferences (Cmd+,).
  • Select Packages on the left.
  • Search for Sourcegraph, then Uninstall.
  • Restart Atom.

Development

To develop the plugin:

  • git clone the repository into ~/.atom/Packages/sourcegraph (lowercase packages on Mac), npm install and open in Atom.
  • Use Cmd+Shift+P to open the command pallette, and choose Window: Reload to reload the extension in the current Atom window.
  • Atom does some really bad things with respect to reopening the workspace, so File -> Reopen Project and View -> Toggle Tree View (Cmd+\) are your friends here. Consider using a separate editor to make changes.
  • To release a new version, you MUST update the following files:
    1. CHANGELOG.md (describe ALL changes)
    2. lib/sourcegraph.js (VERSION constant)
    3. git commit -m "all: release v<THE VERSION>" && git push
    4. apm publish <major|minor|patch>

Version History

See CHANGELOG.md