ofirgall/open.nvim

github github
marks
star 15
alert-circle 1
users 1
git-branch 1
CREATED

2022-10-16

UPDATED

last month


open.nvim

Open the current word (or other text) with custom openers, extensible.

E.g: Open GitHub shorthand "ofirgall/open.nvim" at your default browser.

Installation

use { 'ofirgall/open.nvim', requires = 'nvim-lua/plenary.nvim' }

You can install vim.ui.select wrapper to change the ui for selecting multiple results:

Usage

-- Leave empty for default values
require('open').setup {
}

require('open').setup {
     -- List of disabled openers, 'github' for example see `:help open.default_openers`
     disabled_openers = {
     }
     -- fallback function if no opener succeeds
    fallback = function(text)
        system_open.open(text)
    end,
    -- Override system opener, the defaults should work out of the box
    system_open = {
        cmd = "",
        args = {},
    },
}

By default, no keymaps are set, you have to set your own keymap:

vim.keymap.set('n', 'gx', require('open').open_cword)

Register a custom opener

Please share awesome custom openers with PR.

require('open').register_opener({
    name = 'Example Opener',
    open_fn = function(text)
        return { 'www.example.org' }
    end
})

List of Custom Openers

Feel free to add your opener to the list.

Credits