config: support custom forge domains

Author: sgvictorino

README.md

@@ -23,6 +23,7 @@ A git blame plugin for Neovim written in Lua
   - [Better Performance](#better-performance)
   - [Use blame commit file URLs](#use-blame-commit-file-urls)
   - [Set displayed commit summary length](#set-displayed-commit-summary-length)
+  - [Remote forge domains](#remote-forge-domains)
 - [Commands](#commands)
   - [Open the commit URL in browser](#open-the-commit-url-in-browser)
   - [Enable/Disable git blame messages](#enabledisable-git-blame-messages)
@@ -293,6 +294,22 @@ Default: `0 (full length)`
 let g:gitblame_max_commit_summary_length = 50
 ```
 
+### Remote forge domains
+
+A map of domain names to forge software, used to generate commit and file URLs. Currently supported software:
+
+- `github`
+- `gitlab`
+- `sourcehut`
+- `azure`
+- `bitbucket`
+
+```lua
+vim.g.gitblame_remote_domains = {
+    "git.sr.ht" = "sourcehut"
+}
+```
+
 ## Commands
 
 ### Open the commit URL in browser

lua/gitblame/config.lua

@@ -17,6 +17,11 @@ M.default_opts = {
     clear_event = "CursorMovedI",
     clipboard_register = "+",
     max_commit_summary_length = 0,
+    remote_domains = {
+        ["git.sr.ht"] = "sourcehut",
+        ["dev.azure.com"] = "azure",
+        ["bitbucket.org"] = "bitbucket"
+    }
 }
 
 ---@param opts SetupOptions?

lua/gitblame/git.lua

@@ -27,7 +27,8 @@ end
 local function get_commit_path(sha, repo_url)
     local domain = get_http_domain(repo_url)
 
-    if domain == "bitbucket.org" then
+    local forge = vim.g.gitblame_remote_domains[domain]
+    if forge == "bitbucket" then
         return "/commits/" .. sha
     end
 
@@ -109,44 +110,42 @@ local function get_file_url(remote_url, branch, filepath, line1, line2)
     local repo_url = get_repo_url(remote_url)
     local domain = get_http_domain(repo_url)
 
-    local isSrcHut = domain == "git.sr.ht"
-    local isBitbucket = domain == "bitbucket.org"
-    local isAzure = domain == "dev.azure.com"
+    local forge = vim.g.gitblame_remote_domains[domain]
 
     local file_path = "/blob/" .. branch .. "/" .. filepath
-    if isSrcHut then
+    if forge == "sourcehut" then
         file_path = "/tree/" .. branch .. "/" .. filepath
     end
-    if isBitbucket then
+    if forge == "bitbucket" then
         file_path = "/src/" .. ref .. "/" .. filepath
     end
-    if isAzure then
+    if forge == "azure" then
         -- Can't use branch here since the URL wouldn't work in cases it's a commit sha
         file_path = "?path=%2F" .. filepath
     end
 
     if line1 == nil then
         return repo_url .. file_path
     elseif line2 == nil or line1 == line2 then
-        if isAzure then
+        if forge == "azure" then
             return repo_url .. file_path .. "&line=" .. line1 .. "&lineEnd=" .. line1 + 1 .. "&lineStartColumn=1&lineEndColumn=1"
         end
 
-        if isBitbucket then
+        if forge == "bitbucket" then
             return repo_url .. file_path .. "#lines-" .. line1
         end
 
         return repo_url .. file_path .. "#L" .. line1
     else
-        if isSrcHut then
+        if forge == "sourcehut" then
             return repo_url .. file_path .. "#L" .. line1 .. "-" .. line2
         end
 
-        if isAzure then
+        if forge == "azure" then
             return repo_url .. file_path .. "&line=" .. line1 .. "&lineEnd=" .. line2 + 1 .. "&lineStartColumn=1&lineEndColumn=1"
         end
 
-        if isBitbucket then
+        if forge == "bitbucket" then
             return repo_url .. file_path .. "#lines-" .. line1 .. ":" .. line2
         end