A Neovim plugin that extends the functionality of the gx mapping.
In Neovim, the gx
mapping in normal mode allows you to navigate to the url under the cursor. This plugin extends that behaviour to more than just urls.
package.json
- gx
when cursor is under an npm dependency, navigates to https://www.npmjs.com/package/[packageName]plugins.lua
- In packer.nvim's convention plugins.lua
file, gx
when cursor is under a plugin dependency, navigates to https://github.com/[user/org]/[repo]*.tf
- In a terraform file, gx
when cursor is under a terraform resource definition navigates to https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/[resourceName]*
- In any file, gx
navigates to no-protocol-urls like google.com
, docs.google.com
, etc.Opening the registry docs for aws terraform resources
https://user-images.githubusercontent.com/2881382/230259520-c2e84260-4e79-47ff-9c40-62a5162b15c0.mov
use {
'rmagatti/gx-extended.nvim',
config = function()
require('gx-extended').setup {}
end
}
You can pass custom extensions to the extensions
table. Each extension should have at least two properties:
patterns
: a list of file glob patterns to run the autocommands for
plugins.lua
won't match correctly but *plugins.lua
will.match_to_url
: a function to run the match and return the composed url to be used by the gx
commandname
: the name to be shown in a picker in case of handler/extension conflictsThe following is an example of hitting gx
on a terraform file on a line where an aws resource is defined and opening your browser directly on the terraform registry documentation for the specific resource.
use {
'rmagatti/gx-extended.nvim',
config = function()
require("gx-extended").setup {
extensions = {
{ -- match github repos in lazy.nvim plugin specs
patterns = { '*/plugins/**/*.lua' },
name = "neovim plugins",
match_to_url = function(line_string)
local line = string.match(line_string, '["|\'].*/.*["|\']')
local repo = vim.split(line, ':')[1]:gsub('["|\']', '')
local url = 'https://github.com/' .. repo
return line and repo and url or nil
end,
}
},
}
end
}
By default, gx-extended uses netrw to open urls. You can pass a custom open
function to config to change this behaviour. For example, if you use
lazy.nvim
, you can configure gx-extended to use it's open
function:
return { 'rmagatti/gx-extended.nvim',
keys = { 'gx' },
opts = {
open_fn = require'lazy.util'.open,
}
}
visual
mode