https://github.com/sourcegraph/sourcegraph-atom

Sourcegraph for Atom
https://github.com/sourcegraph/sourcegraph-atom

atom editor plugin repo-type-editor sourcegraph

Last synced: about 1 month ago
JSON representation

Sourcegraph for Atom

• Host: GitHub
• URL: https://github.com/sourcegraph/sourcegraph-atom
• Owner: sourcegraph
• License: apache-2.0
• Archived: true
• Created: 2016-07-07T21:39:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T21:51:01.000Z (over 2 years ago)
• Last Synced: 2024-08-03T22:15:58.489Z (5 months ago)
• Topics: atom, editor, plugin, repo-type-editor, sourcegraph
• Language: JavaScript
• Homepage: https://sourcegraph.com
• Size: 26.4 KB
• Stars: 5
• Watchers: 67
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sourcegraph for Atom [![Atom Plugin](https://img.shields.io/badge/Atom-Sourcegraph-green.svg)](https://atom.io/packages/sourcegraph)

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)

  3. `lib/sourcegraph.js` (`VERSION` constant)

  4. `git commit -m "all: release v" && git push`

  5. `apm publish `

## Version History

See [CHANGELOG.md](CHANGELOG.md)