Skip to content

fix(routers): fix legacy routers implementation about "?plain=1" #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linrongbin16 merged 3 commits into from
Jan 16, 2026
Merged

fix(routers): fix legacy routers implementation about "?plain=1" #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7c58f1
c
linrongbin16 Jan 16, 2026
b89537f
c
linrongbin16 Jan 16, 2026
ad65b90
c
linrongbin16 Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 13 additions & 24 deletions lua/gitlinker/routers.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ local Builder = {}

--- @param r gitlinker.Range?
--- @return string?
local function LC_range(r)
local function gitlab_line_range(r)
if not range.is_range(r) then
return nil
end
Expand All @@ -29,7 +29,7 @@ end

--- @param r gitlinker.Range?
--- @return string?
local function github_LC_range(r)
local function github_line_range(r)
if not range.is_range(r) then
return nil
end
Expand All @@ -43,7 +43,7 @@ end

--- @param r gitlinker.Range?
--- @return string?
local function codeberg_LC_range(r)
local function codeberg_line_range(r)
if not range.is_range(r) then
return nil
end
Expand All @@ -57,7 +57,7 @@ end

--- @param r gitlinker.Range?
--- @return string?
local function lines_range(r)
local function bitbucket_line_range(r)
if not range.is_range(r) then
return nil
end
Expand All @@ -83,11 +83,7 @@ function Builder:new(lk, range_maker)
org = lk.org,
repo = str.endswith(lk.repo, ".git") and lk.repo:sub(1, #lk.repo - 4) or lk.repo,
rev = lk.rev,
location = string.format(
"%s%s",
lk.file .. (str.endswith(lk.file, ".md", { ignorecase = true }) and "?plain=1" or ""),
type(r) == "string" and r or ""
),
location = string.format("%s%s", lk.file, type(r) == "string" and r or ""),
}
setmetatable(o, self)
self.__index = self
Expand Down Expand Up @@ -132,28 +128,28 @@ end
--- @param lk gitlinker.Linker
--- @return string
local function github_browse(lk)
local builder = Builder:new(lk, github_LC_range)
local builder = Builder:new(lk, github_line_range)
return builder:build("blob")
end

--- @param lk gitlinker.Linker
--- @return string
local function gitlab_browse(lk)
local builder = Builder:new(lk, LC_range)
local builder = Builder:new(lk, gitlab_line_range)
return builder:build("blob")
end

--- @param lk gitlinker.Linker
--- @return string
local function bitbucket_browse(lk)
local builder = Builder:new(lk, lines_range)
local builder = Builder:new(lk, bitbucket_line_range)
return builder:build("src")
end

--- @param lk gitlinker.Linker
--- @return string
local function codeberg_browse(lk)
local builder = Builder:new(lk, codeberg_LC_range)
local builder = Builder:new(lk, codeberg_line_range)
return builder:build("src/commit")
end

Expand All @@ -164,41 +160,34 @@ end
--- @param lk gitlinker.Linker
--- @return string
local function github_blame(lk)
local builder = Builder:new(lk, github_LC_range)
local builder = Builder:new(lk, github_line_range)
return builder:build("blame")
end

--- @param lk gitlinker.Linker
--- @return string
local function gitlab_blame(lk)
local builder = Builder:new(lk, LC_range)
local builder = Builder:new(lk, gitlab_line_range)
return builder:build("blame")
end

--- @param lk gitlinker.Linker
--- @return string
local function bitbucket_blame(lk)
local builder = Builder:new(lk, lines_range)
local builder = Builder:new(lk, bitbucket_line_range)
return builder:build("annotate")
end

--- @param lk gitlinker.Linker
--- @return string
local function codeberg_blame(lk)
local builder = Builder:new(lk, codeberg_LC_range)
local builder = Builder:new(lk, codeberg_line_range)
return builder:build("blame/commit")
end

-- blame }

local M = {
-- Builder
Builder = Builder,

-- line ranges
LC_range = LC_range,
lines_range = lines_range,

-- browse: `/blob`, `/src`
samba_browse = samba_browse,
github_browse = github_browse,
Expand Down
160 changes: 160 additions & 0 deletions spec/gitlinker/gitlinker/router_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
local cwd = vim.fn.getcwd()

describe("gitlinker.routers", function()
local assert_eq = assert.is_equal
local assert_true = assert.is_true
local assert_false = assert.is_false

before_each(function()
vim.api.nvim_command("cd " .. cwd)
vim.opt.swapfile = false
end)

local routers = require("gitlinker.routers")
describe("[samba_browse]", function()
it("test1", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "vim.toml",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.samba_browse(lk)
print(string.format("samba_browse:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://git.samba.org/?p=linrongbin16/lin.nvim;a=blob;f=vim.toml;hb=e3ef741ac8814fc0895e26772c5059af2f064543#l1"
)
end)
it("test2", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "README.md",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.samba_browse(lk)
print(string.format("samba_browse:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://git.samba.org/?p=linrongbin16/lin.nvim;a=blob;f=README.md;hb=e3ef741ac8814fc0895e26772c5059af2f064543#l1"
)
end)
end)

describe("[github_browse]", function()
it("test1", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "vim.toml",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.github_browse(lk)
print(string.format("github_browse:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://github.com/linrongbin16/lin.nvim/blob/e3ef741ac8814fc0895e26772c5059af2f064543/vim.toml?plain=1#L1"
)
end)
it("test2", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "README.md",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.github_browse(lk)
print(string.format("github_browse:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://github.com/linrongbin16/lin.nvim/blob/e3ef741ac8814fc0895e26772c5059af2f064543/README.md?plain=1#L1"
)
end)
end)

describe("[github_blame]", function()
it("test1", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "vim.toml",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.github_blame(lk)
print(string.format("github_blame:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://github.com/linrongbin16/lin.nvim/blame/e3ef741ac8814fc0895e26772c5059af2f064543/vim.toml?plain=1#L1"
)
end)
it("test2", function()
local lk = {
current_branch = "dev-plugin",
default_branch = "main",
file = "README.md",
file_changed = false,
host = "github.com",
lend = 1,
lstart = 1,
org = "linrongbin16",
protocol = "https",
remote_url = "https://github.com/linrongbin16/lin.nvim",
repo = "lin.nvim",
rev = "e3ef741ac8814fc0895e26772c5059af2f064543",
user = "linrongbin16",
}
local actual = routers.github_blame(lk)
print(string.format("github_blame:%s", vim.inspect(actual)))
assert_eq(
actual,
"https://github.com/linrongbin16/lin.nvim/blame/e3ef741ac8814fc0895e26772c5059af2f064543/README.md?plain=1#L1"
)
end)
end)
end)