feat: support url replacements & multi-platform paths (#10)

* Add support for url replacements
* Add support to multi-platform paths

Author: abeatrix

README.md

@@ -1,15 +1,76 @@
 # Open in Sublime Sourcegraph extension
 
-Adds a button at the top of files in both Sourcegraph app and code hosts like GitHub (when the Sourcegraph browser extension is installed) that will open the current file in Sublime Text.
+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 Sublime Text.
+
+**This extension requires all git repos to be cloned and available on your local machine.**
 
 <picture>
-<source srcset="https://user-images.githubusercontent.com/37420160/96816775-e9760400-13eb-11eb-812f-85046bd4db6d.png" media="(prefers-color-scheme: dark)" />
-<source srcset="https://user-images.githubusercontent.com/37420160/96816847-0ad6f000-13ec-11eb-9ef8-b1c3b2009a4d.png" media="(prefers-color-scheme: light)" />
-<img src="https://user-images.githubusercontent.com/37420160/96816847-0ad6f000-13ec-11eb-9ef8-b1c3b2009a4d.png" alt="Screenshot" />
+<source srcset="https://user-images.githubusercontent.com/37420160/96816775-e9760400-13eb-11eb-812f-85046bd4db6d.png" width="100%" media="(prefers-color-scheme: dark)" />
+<source srcset="https://user-images.githubusercontent.com/37420160/96816847-0ad6f000-13ec-11eb-9ef8-b1c3b2009a4d.png" width="100%" media="(prefers-color-scheme: light)" />
+<img src="https://user-images.githubusercontent.com/37420160/96816847-0ad6f000-13ec-11eb-9ef8-b1c3b2009a4d.png" width="100%" alt="Screenshot" />
 </picture>
 
-## Settings
 
-- `openInSublime.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.
+## Prerequisites
+
+- This extension requires all git repos to be cloned and available on your local machine.
+
+- Sublime Text requires a URL handler installed such as [this one for macOS](https://github.com/inopinatus/sublime_url).
+
+## Configurations
+
+- `openInSublime.basePath`: [REQUIRED] String. The absolute path on your computer where your git repositories live. The extension will try to open the file in a clone named by the last segment of the repository name in that folder. 
+  - This extension requires all git repos to be already cloned under this path with their original names, which the final path can later be altered using the `openInSublime.replacements` option.
+  - `"/Users/yourusername/src"` is a valid absolute path, while `"~/src"` is not.
+
+- `openInSublime.replacements`: [OPTIONAL] Object. Set to an object that includes pairs of strings, where each key will be replaced by its value in the final url. The key can be a string or a RegExp, and the value must be a string. 
+  - Example: using `"openInSublime.replacements": {"(?<=Documents\/)(.*[\\\/])": "sourcegraph-$1"}` will add `sourcegraph-` in front of the string that matches the `(?<=Documents\/)(.*[\\\/])` RegExp pattern, while `"openInSublime.replacements": {"sourcegraph-": ""}` will remove `sourcegraph-` from the final URL.
+
+- `openInSublime.osPaths`: [OPTIONAL] Object. The extension uses the assigned path for the detected Operating System when available. If no platform is detected then we will keep using the basePath provided with `openInSublime.basePath`. 
+  - Note: Currently support `"windows"`, `"mac"`, and `"linux"` as keys.
+
+## Examples
+
+### Mac
+
+**Requires a URL handler installed such as [this one for macOS](https://github.com/inopinatus/sublime_url).**
+
+Opens repository files in your Documents directory:
+
+```json
+{
+  "extensions": {
+    "sourcegraph/open-in-sublime": true,
+  },
+  // where the cloned git repositories are located
+  "openInSublime.basePath": "/Users/USERNAME/Documents/"
+}
+```
+
+### Set basePath for multiple platforms
+
+**Requires a URL handler installed such as [this one for macOS](https://github.com/inopinatus/sublime_url).**
+
+Uses the assigned path for the detected Operating System when available:
+
+```json
+{
+  "extensions": {
+    "sourcegraph/open-in-sublime": true,
+  },
+  "openInSublime.osPaths": {
+    "windows": "/C:/Users/USERNAME/folder/",
+    "mac": "/Users/USERNAME/folder/",
+    "linux": "/home/USERNAME/folder/"
+  },
+  // set basePath as fallback path when no operating system is detected
+  "openInSublime.basePath": "/Users/USERNAME/Documents/"
+}
+```
+
+## Development
+
+1. Run `yarn && yarn run serve` and keep the Parcel bundler process running
+1. [Sideload the extension](https://docs.sourcegraph.com/extensions/authoring/local_development) (at the URL http://localhost:1234 by default) on your Sourcegraph instance or Sourcegraph.com
 
-Sublime Text requires a URL handler installed such as [this one for macOS](https://github.com/inopinatus/sublime_url).
+When you edit a source file in your editor, Parcel will recompile the extension. Reload the Sourcegraph web page to use the updated extension.

package.json

@@ -52,6 +52,17 @@
           "type": "string",
           "format": "regex",
           "pattern": "^[^~]+"
+        },
+        "openInSublime.replacements": {
+          "description": "Take key-value pairs where each key is replaced by its value in the final url. The key can be a string or a RegExp pattern, and the value must be a string. The final path must be a valid path on the machine to the folder that is expected to contain all repositories.",
+          "type": "object",
+          "format": "{}",
+          "examples": ["'(?<=Documents\/)(.*[\\\/])': 'string-to-add-$1'", "'string-to-remove': ''"]
+        },
+        "openInSublime.osPaths": {
+          "description": "The absolute path on each platform to the folder that is expected to contain all repositories. Currently supports 'windows', 'mac', and 'linux' as keys.",
+          "type": "object",
+          "format": "{}"
         }
       }
     }

src/open-in-sublime.ts

@@ -3,14 +3,28 @@ import * as path from 'path'
 
 interface Settings {
     'openInSublime.basePath'?: string
+    'openInSublime.replacements'?: Record<string, string>
+    'openInAtom.osPaths'?: Record<string, string>
 }
 
 function getOpenUrl(textDocumentUri: URL): URL {
-    const basePath = sourcegraph.configuration.get<Settings>().value['openInSublime.basePath']
+    let basePath = sourcegraph.configuration.get<Settings>().value['openInSublime.basePath']
+    const replacements = sourcegraph.configuration.get().value['openInSublime.replacements'] as Record<string, string>
+    const osPaths: Record<string, string> = sourcegraph.configuration.get().value['openInAtom.osPaths'] as Record<string, string>
     const learnMorePath = new URL('/extensions/sourcegraph/open-in-sublime', sourcegraph.internal.sourcegraphURL.href)
         .href
     const userSettingsPath = new URL('/user/settings', sourcegraph.internal.sourcegraphURL.href).href
 
+    // check platform and use assigned path when available;
+    if(osPaths){
+        if (navigator.userAgent.includes('Win') && osPaths.windows) {
+            basePath = osPaths.windows;
+        } else if (navigator.userAgent.includes('Mac') && osPaths.mac) {
+            basePath = osPaths.mac;
+        } else if (navigator.userAgent.includes('Linux') && osPaths.linux) {
+            basePath = osPaths.linux;
+        }
+    }
     if (typeof basePath !== 'string') {
         throw new TypeError(
             `Add \`openInSublime.basePath\` to your [user settings](${userSettingsPath}) to open files in the editor. [Learn more](${learnMorePath})`
@@ -26,20 +40,30 @@ function getOpenUrl(textDocumentUri: URL): URL {
     const repoBaseName = rawRepoName.split('/').pop() ?? ''
     const relativePath = decodeURIComponent(textDocumentUri.hash.slice('#'.length))
     const absolutePath = path.join(basePath, repoBaseName, relativePath)
-    const openUrl = new URL('subl://open?url=' + absolutePath)
+    let openUrl = 'subl://open?url=file://' + absolutePath;
 
     if (sourcegraph.app.activeWindow?.activeViewComponent?.type === 'CodeEditor') {
         const selection = sourcegraph.app.activeWindow?.activeViewComponent?.selection
         if (selection) {
-            openUrl.searchParams.set('line', (selection.start.line + 1).toString())
+            openUrl += `:${selection.start.line + 1}`
 
             if (selection && selection.start.character !== 0) {
-                openUrl.searchParams.set('column', (selection.start.character + 1).toString())
+                openUrl += `:${selection.start.character + 1}`
+            }
+        }
+    }
+
+    // If configured, run replacements before returning final URL
+    if(replacements) {
+        for (const replacement in replacements) {
+            if (typeof replacement === 'string') {
+                const POST_REGEX = new RegExp(replacement);
+                openUrl = openUrl.replace(POST_REGEX, replacements[replacement])
             }
         }
     }
 
-    return openUrl
+    return new URL(openUrl)
 }
 
 export function activate(context: sourcegraph.ExtensionContext): void {

yarn.lock

@@ -1683,9 +1683,9 @@ caniuse-api@^3.0.0:
     lodash.uniq "^4.5.0"
 
 caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001093:
-  version "1.0.30001111"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001111.tgz#dd0ce822c70eb6c7c068e4a55c22e19ec1501298"
-  integrity sha512-xnDje2wchd/8mlJu8sXvWxOGvMgv+uT3iZ3bkIAynKOzToCssWCmkz/ZIkQBs/2pUB4uwnJKVORWQ31UkbVjOg==
+  version "1.0.30001269"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001269.tgz"
+  integrity sha512-UOy8okEVs48MyHYgV+RdW1Oiudl1H6KolybD6ZquD0VcrPSgj25omXO1S7rDydjpqaISCwA8Pyx+jUQKZwWO5w==
 
 caseless@~0.12.0:
   version "0.12.0"