Bug: Duplicated `?plain=1` when using the `github_browse` router

[boiledfroginthewell]

1. What's the output of git remote get-url origin?

   It's https://github.com/linrongbin16/gitlinker.nvim.git

2. what's the expect git host url you want to generate?

   It's
   https://github.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1#L1
   but was
   https://github.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1?plain=1#L1

3. how do you configure this plugin?

   It's ...

{
  "linrongbin16/gitlinker.nvim",
  cmd = "GitLink",
  opts = function ()
    return {
      router = {
        browse = {
          ["my.custom.github.enterprise.host.example.com"] = require('gitlinker.routers').github_browse,
          -- The default router for github.com works correctly.
          -- The following line intentionally assigns the github_browse router
          -- to github.com in order to reproduce this bug.
          ["^github.com"] = require('gitlinker.routers').github_browse,
        }
      }
    }
  end,
},

(This issue occurs with GitHub Enterprise, but can be reproduced on github.com by intentionally assigning the github_browse router.)

4. What's your OS and Neovim version?

   The OS is: Manjaro x86_64 (Intel chip), MacOS M1 chip

   The Neovim version (nvim --version) is: ...

NVIM v0.11.5
Build type: RelWithDebInfo
LuaJIT 2.1.1753364724

Description

When generating a link for a Markdown file with GitHub Enterprise, ?plain=1 is incorrectly appended twice to the URL. As a result, the generated URL is

• unable to open a link in plain mode.
• not replaced with a code preview when pasted in issue/PR comments.

Example:

• https://github.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1#L1
  

  gitlinker.nvim/README.md

  Line 1 in d2a250e

  # gitlinker.nvim

• https://github.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1?plain=1#L1
  https://github.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1?plain=1#L1

It seems this issue is specific to Markdown files.

Repro

1. Clone https://github.com/linrongbin16/gitlinker.nvim.git and open README.md.
2. Run :GitLink with the above config.
3. The generated URL contains the duplicated ?plain=1.

[linrongbin16]

will take a look later

[linrongbin16]

hi @boiledfroginthewell ,

That is strange, I cannot reproduce this issue on my local macbook M1-chip. Can you give some more details about the issue?

You can debug the issue with your local machine by setting debug=true options:

require("gitlinker").setup({
  debug = true,
})

Also see:

gitlinker.nvim/lua/gitlinker/configs.lua

Lines 181 to 182 in 0a746e6

	-- enable debug
	debug = false,

It will dump a lot of debugging logs in your local machine, then you can upload the logs here, and please take care about your own privacy information :)

BTW here are some comments about your setup options:

{
  "linrongbin16/gitlinker.nvim",
  cmd = "GitLink",
  opts = function ()
    return {
      router = {
        browse = {
          ["my.custom.github.enterprise.host.example.com"] = require('gitlinker.routers').github_browse,
          -- The default router for github.com works correctly.
          -- The following line intentionally assigns the github_browse router
          -- to github.com in order to reproduce this bug.
          ["^github.com"] = require('gitlinker.routers').github_browse,
        }
      }
    }
  end,
},

1. Please write your GitHub Enterprise host with ^my%.custom%.github%.enterprise%.host%.example%.com. Note: Add ^ at the beginning, use %. instead of . for the dot char. The ^ will match lua string from the beginning, the %. will match the lua char . (a special lua regex syntax). Also see:

   gitlinker.nvim/lua/gitlinker/configs.lua

   Line 20 in 0a746e6

   ["^github%.com"] = "https://github.com/"

2. Remove the 2nd config ["^github.com"] = require('gitlinker.routers').github_browse, your custom config will not disable the defaults, they can work together.

[boiledfroginthewell]

Thanks for taking a look. I wasn’t expecting this issue to be affected by the environment.

You can debug the issue with your local machine by setting debug=true options:

I added the following options:

    debug = true,
    file_log = true,

and ran the :GitLink command.
This is the generated file: gitlinker.log

---

Please write your GitHub Enterprise host with ^my%.custom%.github%.enterprise%.host%.example%.com. Note: Add ^ at the beginning, use %. instead of . for the dot char. The ^ will match lua string from the beginning, the %. will match the lua char . (a special lua regex syntax). Also see:

Thanks for pointing this out.
My actual config already uses ^ and %.. I also tested with and without them, but the bug is reproducible in all cases in my environment.

---

Remove the 2nd config ["^github.com"] = require('gitlinker.routers').github_browse, your custom config will not disable the defaults, they can work together.

Oh, I noticed that the output of :GitLink for github.com changes every time I restart Neovim with this config. Most of the time it shows ...?plain=1?plain=1, but occasionally it shows the correct URL.

It seems that modifying the github.com config is not a good idea to reproduce this issue.
I came up with a more appropriate repro instead. Does this work in your environment?

1. Clone https://github.com/linrongbin16/gitlinker.nvim.git
2. Edit .git/config:

[core]
	repositoryformatversion = 0
	filemode = true
	bare = false
	logallrefupdates = true
[remote "origin"]
- 	url = https://github.com/linrongbin16/gitlinker.nvim.git
+ 	url = https://github.enterprise.com/linrongbin16/gitlinker.nvim.git
	fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
	remote = origin
	merge = refs/heads/master

3. Configure gitlinker:

	{
		"linrongbin16/gitlinker.nvim",
		cmd = "GitLink",
		opts = function ()
			return {
				debug = true,
				file_log = true,
				router = {
					browse = {
						["^github%.enterprise%.com"] = require('gitlinker.routers').github_browse,
					}
				}
			}
		end,
		keys = {
			{ "<leader>gy", "<cmd>GitLink<cr>", mode = { "n", "v" }, desc = "Yank git link" },
			{ "<leader>gY", "<cmd>GitLink!<cr>", mode = { "n", "v" }, desc = "Open git link" },
		},
	},

4. Open README.md
5. Run :GitLink
6. https://github.enterprise.com/linrongbin16/gitlinker.nvim/blob/d2a250e65207ddc04724579b99e564da01922a65/README.md?plain=1?plain=1#L1 is generated.

[linrongbin16]

hi @boiledfroginthewell , this is fixed in #290 , please pull default branch and have a try

[boiledfroginthewell]

Thanks for the fix!
I've tested with the actual GitHub Enterprise instance and it works perfectly🙌