Adds a button to the Sourcegraph's extension panel and at the top of files in code hosts like GitHub (when the Sourcegraph browser extension is installed) that will open the current file in your editor of choice.

**This extension requires all git repos to be cloned and available on your local machine.

• Add openineditor.editor to your user settings to open files in the editor. Copy one of the following lines depending on the editor you would like to use. This extension only supports opening in one editor at a time. Supported editors:

  • vscode (Visual Studio Code): "openineditor.editor": "vscode"
  • idea (JetBrains IntelliJ IDEA): "openineditor.editor": "idea"
  • sublime (Sublime Text, requires a URL handler installed such as this one for macOS)
  • custom (requires also setting openineditor.customUrlPattern): "openineditor.editor": "custom"

• openineditor.basePath: The absolute path on your computer where your git repositories live. This extension requires all git repos to be already cloned under this path with their original names. "/Users/yourusername/src" is a valid absolute path, while "~/src" is not.

• openineditor.customUrlPattern: If you set openineditor.editor to custom, this must be set. Use placeholders %file, %line, and %col to mark where the file path, line number, and column number must be replaced. Example URL for IntelliJ IDEA: idea://open?file=%file&line=%line&column=%col

• openineditor.replacements: Takes object, where each key is replaced by value in the final url. The key can be a string or a RegExp, and the value must be a string. For example, "openineditor.replacements": {"(?<=Documents\/)(.*[\\\/])": "sourcegraph-$1"}, will add sourcegraph- in front of the string that matches the (?<=Documents\/)(.*[\\\/]) RegExp pattern, which is the string after Documents/ and before the final slash: vscode://file//Users/USERNAME/Documents/REPO-NAME/package.json => vscode://file//Users/USERNAME/Documents/sourcegraph-REPO-NAME/package.json

To open repository files in your Documents directory:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.editor" : "idea",
  "openineditor.basePath": "/Users/USERNAME/Documents/"
}

The idea:// protocol handler is currently not supported on Windows. As a workaround, Windows user can use the Intellij's built-in REST API to open files directly from a URL with extra configuration steps.

1. In the Intellij's Settings panel, go to Build, Execution, Deployment

2. Click on the Debugger tab and mark the box next to Allow unsigned requests as checked. This allows requests to be made to the built-in server from outside IntelliJ IDEA as stated in their docs

3. Add the following settings to your User Settings on Sourcegraph to open repository files in your user's IdeaProjects directory. Intellij IDEA must be remained open for this workaround to work.

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.editor" : "custom",
  "openineditor.basePath": "/C:/Users/USERNAME/IdeaProjects/",
  "openineditor.customUrlPattern" : "http://localhost:63342/api/file%file&line=%line&column=%col"
}

To open repository files in your Documents directory:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.editor" : "vscode",
  "openineditor.basePath": "/Users/USERNAME/Documents/"
}

To open repository files in your Documents directory:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.editor" : "vscode",
  "openineditor.basePath": "/Users/USERNAME/Documents/"
}

To open repository files in your Home directory:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.basePath": "//wsl$/Ubuntu-18.04/home",
  "openineditor.editor" : "custom",
  "openineditor.customUrlPattern" : "vscode://file/%file&line=%line&column=%col"
}

To open repository files in your Documents directory:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.basePath": "/Users/USERNAME/Documents/",
  "openineditor.editor" : "custom",
  "openineditor.customUrlPattern" : "vscode-insiders://file%file&line=%line&column=%col"
}

Uses the assigned path for the detected Operating System when available:

{
  "extensions": {
    "sourcegraph/open-in-editor": true
  },
  "openineditor.osPaths": {
    "windows": "/C:/Users/USERNAME/folder/",
    "mac": "/Users/USERNAME/folder/",
    "linux": "/home/USERNAME/folder/"
  },
  "openineditor.editor" : "vscode",
  // basePath is required as the default path when no Operating System is detected
  "openineditor.basePath": "/Users/USERNAME/Documents/",
}

This requires VS Code extension Remote Development by Microsoft to work.

To open directory where the repository files reside in a remote server:

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.basePath": "/Users/USERNAME/Documents/",
  "openineditor.editor" : "custom",
  // Replaces USER@HOSTNAME as appropriate.
  "openineditor.customUrlPattern": "vscode://vscode-remote/ssh-remote+USER@HOSTNAME%file",
  //removes file name as the vscode-remote protocol handler only supports directory-opening
  "openineditor.replacements": {"\/[^\/]*$": ""}, 
}

Adds sourcegraph- in front of the string that matches the (?<=Documents\/)(.*[\\\/]) RegExp pattern, which is the string after Documents/ and before the final slash.

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.basePath": "/Users/USERNAME/Documents/",
  "openineditor.editor" : "vscode",
  "openineditor.replacements": {"(?<=Documents\/)(.*[\\\/])": "sourcegraph-$1"},
  // vscode://file//Users/USERNAME/Documents/REPO-NAME/package.json => vscode://file//Users/USERNAME/Documents/sourcegraph-REPO-NAME/package.json
}

Removes sourcegraph- from the final URL.

{
  "extensions": {
    "sourcegraph/open-in-editor": true,
  },
  "openineditor.basePath": "/Users/USERNAME/Documents/",
  "openineditor.editor" : "vscode",
  "openineditor.replacements": {"sourcegraph-": ""},
  // vscode://file//Users/USERNAME/Documents/sourcegraph-REPO-NAME/package.json => vscode://file//Users/USERNAME/Documents/REPO-NAME/package.json
}

1. Run yarn && yarn run serve and keep the Parcel bundler process running
2. Sideload the extension (at the URL http://localhost:1234 by default) on your Sourcegraph instance or Sourcegraph.com

When you edit a source file in your editor, Parcel will recompile the extension. Reload the Sourcegraph web page to use the updated extension.