Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sourcegraph/sourcegraph-sublime
Sourcegraph for Sublime Text 3
https://github.com/sourcegraph/sourcegraph-sublime
editor plugin repo-type-editor sourcegraph st3 sublime
Last synced: 3 months ago
JSON representation
Sourcegraph for Sublime Text 3
- Host: GitHub
- URL: https://github.com/sourcegraph/sourcegraph-sublime
- Owner: sourcegraph
- License: mit
- Archived: true
- Created: 2017-04-29T04:41:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-11T22:39:41.000Z (about 4 years ago)
- Last Synced: 2024-06-23T07:39:43.459Z (5 months ago)
- Topics: editor, plugin, repo-type-editor, sourcegraph, st3, sublime
- Language: Python
- Homepage: https://sourcegraph.com
- Size: 19.5 KB
- Stars: 18
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sourcegraph for Sublime Text 3 [](https://packagecontrol.io/packages/Sourcegraph)
The Sourcegraph plugin for Sublime Text 3 enables you to quickly open and search code on Sourcegraph.com easily and efficiently.
## Installation
1. [Install Package Control](https://packagecontrol.io/installation), if you haven't already.
1. Open the command palette Cmd+Shift+P (Ctrl+Shift+P on Windows/Linux).
2. Search for `Package Control: Install Package` and press enter.
3. Search for `Sourcegraph` and press enter to install the plugin.
## 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 the user package settings (`Sublime Text` -> `Package Settings` -> `Sourcegraph` -> `Settings - User`), then modify this example configuration:
```
{
// The Sourcegraph instance to use. Specify your on-premises Sourcegraph
// instance here, if applicable.
"SOURCEGRAPH_URL": "https://sourcegraph.com",
}
```
## Questions & Feedback
Please file an issue: https://github.com/sourcegraph/sourcegraph-sublime/issues/new
## Logs
Logs show up in the Sublime console, which is accessible via Ctrl+`
## Uninstallation
1. Open the command palette Cmd+Shift+P (Ctrl+Shift+P on Windows/Linux).
2. Search for `Package Control: Remove Package` and press enter.
3. Search for `sourcegraph` and press enter to uninstall the plugin.
## Development
To develop the plugin:
- `git clone` the repository into `~/Library/Application Support/Sublime Text 3/Packages/sourcegraph-sublime`
- Open the console with Ctrl+`
- Make changes to the Python code and watch as Sublime reloads.
- To release a new version, you MUST update the following files:
1. `messages.json` (add a new version entry)
2. `README.md` (describe ALL changes)
3. `messages/welcome.txt` (copy from README.md change above)
4. `sourcegraph.py` (`VERSION` constant)
- Then `git commit -m "all: release v"` and `git push` and `git tag v` and `git push --tags`.
- Note: it sometimes takes a few hours for it to show up on https://packagecontrol.io/packages/Sourcegraph
## Version History
- v1.0.7 - Correctly open the default browser on Mac OS.
- Added a workaround for a Mac OS bug that causes Python to incorrectly open the second (non-default) browser. https://bugs.python.org/issue30392
- v1.0.6 - Fixed search shortcut.
- Updated the search URL to reflect a recent Sourcegraph.com change.
- v1.0.5 - Minor fixes to configuration.
- Fix opening README, LICENSE, etc through "Package Settings" menu.
- Update README to describe how to use with on-premises Sourcegraph instances.
- v1.0.4 - Improved support for on-premises Sourcegraph instances
- Now using the `sourcegraph.com/-/editor` endpoint.
- v1.0.3 - Added usage metrics
- Added minimal and non-obtrusive usage metrics, which lets us at Sourcegraph better improve our editor extensions.
- v1.0.2 - Usability improvements
- Adjusted the global search URL to the correct one, so that the search shortcut will work.
- Added support for non-default git branches (brings you to the checked out branch on Sourcegraph.com)
- Changed the keyboard shortcuts to Option+S (search selection) and Option+A (open selection) (Alt instead of Option for Windows and Linux).
- v1.0.1 - Minor bug fixes
- Fixed a bug where `https` etc. GitHub repo remote URLs would incorrectly build the Sourcegraph.com URL.
- Windows: Fixed a bug where git commands would create Command Prompt pop-up windows.
- v1.0.0 - Initial Release; basic Open File & Search functionality.