set mappings = nil could not disable the kemaps

[meijieru]

Describe the bug
As the title, here overrides the mappings.

Here is my config

  require("gitlinker").setup {
    callbacks = {
      ["direct.meijieru.com"] = function(url_data)
        url_data.host = "gitea.meijieru.com"
        return require("gitlinker.hosts").get_gitea_type_url(url_data)
      end,
    },
    mappings = nil,
  }

[ajitid]

Looks like resolving this would result in a breaking API change. If nil is fixed, we would have to remove the default mapping (which may or may not be desirable).

gitlinker.nvim/lua/gitlinker/mappings.lua

Line 20 in d28028b

mappings = mappings or "<leader>gy"

[meijieru]

Maybe as a command and let the user map them.

[ajitid]

Or use mappings as false to remove mappings but nil (which equates to not defining a mapping through options) to use the default one?

Edit: This is something many plugins do, here's Telescope as an example:

[ruifm]

Or use mappings as false to remove mappings but nil (which equates to not defining a mapping through options) to use the default one?

Sounds like the best option.

I think it was a mistake to auto define mappings. I did it to improve the out-of-the-box experience but now I don't think it's such a good idea and whatever is done will definitely break the API 😢

[ajitid]

whatever is done will definitely break the API

Kind of. If nil wasn't working for them, and nobody cared to raise an issue about it, it means people rarely considered nullifying gitlinker mappings. So not a huge user base would be affected.

Would you mind taking a PR for this issue?

---

Unrelated. but in one of the issue I became aware that one cannot give a range through command prompt as the plugin doesn't relies on < and > marks. Was this intended or should I create an issue?

[linrongbin16]

Submit #77, use "" (empty string) to disable default mappings.

[linrongbin16]

Hi @meijieru , @ajitid ,
I have fixed this issue in my fork with PR: linrongbin16/gitlinker.nvim#1
Feel free to use it.

[ajitid]

I've already forked and am using a different method to suppress mappings.
Thanks for mentioning it anyway!

[linrongbin16]

Cool, I have also fixed another issue #75 (open browser in windows).
I use cmd /C start {url}. this method is copied from: https://github.com/axieax/urlview.nvim/blob/main/lua/urlview/actions.lua#L38.

[ArchitBhonsle]

So what's the status for this? Noticed that I still had the default mappings even though I set mappings = nil

[linrongbin16]

Hi all, I have make my own fork: https://github.com/linrongbin16/gitlinker.nvim.

It fixed this issue, and also support Windows, and refactored a lot of things, I believe it's much better.