feat: add option to remap URLs before opening (#24)

This adds two options:
sourcegraph.ignoreRemoteHostname: strips the hostname from a git-based
remote. For example, `git@company.com:repo` becomes just `repo` if this
is true
sourcegraph.remoteUrlPrepend: a mapping from string -> string that
allows simple remapping of remote names. If the remote hostname
(user@host) matches the key, the value is prepended to the remote. For
example, if this is `{"git@secondary.company.com": "two/"}, the repo
`git@secondary.company.com:repo` becomes `two/repo`

Fixes #8

Author: Matthew Bentley

README.md

@@ -25,6 +25,7 @@ Keyboard Shortcuts:
 This extension contributes the following settings:
 
 - `sourcegraph.url`: The Sourcegraph instance to use. Specify your on-premises Sourcegraph instance here, if applicable.
+- `sourcegraph.remoteUrlReplacements`: Object, where each `key` is replaced by `value` in the remote url.
 
 ## Questions & Feedback
 

package.json

@@ -2,7 +2,7 @@
   "name": "sourcegraph",
   "displayName": "Sourcegraph",
   "description": "Sourcegraph for VS Code",
-  "version": "1.0.12",
+  "version": "1.0.16",
   "publisher": "sourcegraph",
   "license": "MIT",
   "icon": "images/logo.png",
@@ -11,7 +11,7 @@
     "url": "https://github.com/sourcegraph/sourcegraph-vscode.git"
   },
   "engines": {
-    "vscode": "^1.11.0"
+    "vscode": "^1.37.0"
   },
   "categories": [
     "Other"
@@ -56,6 +56,13 @@
           ],
           "default": "https://sourcegraph.com",
           "description": "The base URL of the Sourcegraph instance to use."
+        },
+        "sourcegraph.remoteUrlReplacements": {
+          "type": [
+            "object"
+          ],
+          "default": {},
+          "description": "For each item in this object, replace key with value in the remote url."
         }
       }
     }

src/config.ts

@@ -9,3 +9,12 @@ export function getSourcegraphUrl(): string {
     }
     return url
 }
+
+export function getRemoteUrlReplacements(): Record<string, string> {
+    // has default value
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const replacements = vscode.workspace
+        .getConfiguration('sourcegraph')
+        .get<Record<string, string>>('remoteUrlReplacements')!
+    return replacements
+}

src/git.ts

@@ -1,6 +1,7 @@
 import execa from 'execa'
 import * as path from 'path'
 import { log } from './log'
+import { getRemoteUrlReplacements } from './config'
 
 /**
  * Returns the names of all git remotes, e.g. ["origin", "foobar"]
@@ -15,7 +16,15 @@ async function gitRemotes(repoDir: string): Promise<string[]> {
  * e.g. `origin` -> `git@github.com:foo/bar`
  */
 async function gitRemoteURL(repoDir: string, remoteName: string): Promise<string> {
-    const { stdout } = await execa('git', ['remote', 'get-url', remoteName], { cwd: repoDir })
+    let { stdout } = await execa('git', ['remote', 'get-url', remoteName], { cwd: repoDir })
+    const replacementsList = getRemoteUrlReplacements()
+
+    for (const r in replacementsList) {
+        if (typeof r === 'string') {
+            stdout = stdout.replace(r, replacementsList[r])
+        }
+    }
+
     return stdout
 }