Implement GitLab source linking

Closes TypeStrong#1728
srmagura · Oct 24, 2021 · 53ed8bd · 53ed8bd
1 parent 8c44bb3
commit 53ed8bd
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/src/lib/converter/plugins/SourceLinkPlugin.ts b/src/lib/converter/plugins/SourceLinkPlugin.ts
@@ -89,6 +89,10 @@ export class Repository {
                 match = /(bitbucket.org)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             }
 
+            if (!match) {
+                match = /(gitlab.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
+
             if (match) {
                 this.hostname = match[1];
                 this.user = match[2];
@@ -103,9 +107,13 @@ export class Repository {
             }
         }
 
-        if (this.hostname.includes("bitbucket.org"))
+        if (this.hostname.includes("bitbucket.org")) {
             this.type = RepositoryType.Bitbucket;
-        else this.type = RepositoryType.GitHub;
+        } else if (this.hostname.includes("gitlab.com")) {
+            this.type = RepositoryType.GitLab;
+        } else {
+            this.type = RepositoryType.GitHub;
+        }
 
         let out = git("-C", path, "ls-files");
         if (out.status === 0) {
@@ -149,10 +157,13 @@ export class Repository {
             `https://${this.hostname}`,
             this.user,
             this.project,
-            this.type === "github" ? "blob" : "src",
+            this.type === RepositoryType.GitLab ? "-" : undefined,
+            this.type === RepositoryType.Bitbucket ? "src" : "blob",
             this.branch,
             fileName.substr(this.path.length + 1),
-        ].join("/");
+        ]
+            .filter((s) => !!s)
+            .join("/");
     }
 
     /**
@@ -190,6 +201,7 @@ export class Repository {
         switch (repositoryType) {
             default:
             case RepositoryType.GitHub:
+            case RepositoryType.GitLab:
                 return "L" + lineNumber;
             case RepositoryType.Bitbucket:
                 return "lines-" + lineNumber;

diff --git a/src/lib/models/sources/repository.ts b/src/lib/models/sources/repository.ts
@@ -1,4 +1,5 @@
 export enum RepositoryType {
     GitHub = "github",
     Bitbucket = "bitbucket",
+    GitLab = "gitlab",
 }
diff --git a/src/test/SourceLinkPlugin.test.ts b/src/test/SourceLinkPlugin.test.ts
@@ -69,6 +69,28 @@ describe("Repository", function () {
             equal(repository.project, "foobar");
             equal(repository.type, RepositoryType.Bitbucket);
         });
+
+        it("handles a GitLab HTTPS URL", function () {
+            const mockRemotes = ["https://gitlab.com/joebloggs/foobar.git"];
+
+            const repository = new Repository("", "", mockRemotes);
+
+            equal(repository.hostname, "gitlab.com");
+            equal(repository.user, "joebloggs");
+            equal(repository.project, "foobar");
+            equal(repository.type, RepositoryType.GitLab);
+        });
+
+        it("handles a GitLab SSH URL", function () {
+            const mockRemotes = ["git@gitlab.com:joebloggs/foobar.git"];
+
+            const repository = new Repository("", "", mockRemotes);
+
+            equal(repository.hostname, "gitlab.com");
+            equal(repository.user, "joebloggs");
+            equal(repository.project, "foobar");
+            equal(repository.type, RepositoryType.GitLab);
+        });
     });
 
     describe("getURL", () => {
@@ -108,5 +130,21 @@ describe("Repository", function () {
                 "https://bitbucket.org/joebloggs/foobar/src/main/src/index.ts"
             );
         });
+
+        it("returns a GitLab URL", function () {
+            const mockRemotes = ["https://gitlab.com/joebloggs/foobar.git"];
+
+            const repository = new Repository(
+                repositoryPath,
+                "main",
+                mockRemotes
+            );
+            repository.files = [filePath];
+
+            equal(
+                repository.getURL(filePath),
+                "https://gitlab.com/joebloggs/foobar/-/blob/main/src/index.ts"
+            );
+        });
     });
 });