vim.ui.open: "gx" without netrw

[mrshmllow]

Fix #23231

vim.ui.os_open is partially based off https://github.com/folke/lazy.nvim/blob/main/lua/lazy/util.lua#L13-L44, as recommended by @folke on the original issue.

• Implement vim.ui.os_open(uri: string | vim.uri.Uri)
  • Accept a string as uri
  • Accept a vim.uri.Uri as uri
• Implement "gx" in lua. The implementation drops current netrw options, including g:netrw_gx.
• Ability to change impl by using vim.func.on_func(vim.ui, 'open_uri', …)

[glepnir]

the uri need check include some symbols or not , like # . in some lsp hover response the link like file:///usr/local/share/doc/xxx/System-IO.html#v:putStrLn . so you need use vim.fn.escape to escape # in uri .

[clason]

Is deleting code from runtime/plugin/netrwPlugin.vim appropriate / allowed?

No, please leave it as is (for now). It's better to set the corresponding global variables to skip setting up the mapping.

We'll completely remove netrw once we have a full replacement.

What is the correct way to add new built-in keymaps in lua? The best location I found was runtime/plugin/nvim.lua.

Yes, that would be the place. But maybe make it opt-in for now?

[mrshmllow]

God, the commit history in this PR is a complete mess lmao

[mrshmllow]

No, please leave it as is (for now). It's better to set the corresponding global variables to skip setting up the mapping.

I am confused about the execution order, where would you set a global variable in time? I cannot find a place where this is done

the uri need check include some symbols or not , like # . in some lsp hover response the link like file:///usr/local/share/doc/xxx/System-IO.html#v:putStrLn . so you need use vim.fn.escape to escape # in uri .

Im not entirely sure what you mean. Most applications will not understand what #v:putStrLn means. You can try to maybe adjust g:netrw_gx to capture the full #? (as <cfile> rightfully does not expect a file to have #)

[glepnir]

it's a markdown link return by some lsp server. it has a # target symbol . but maybe it should not escape in open_uri function. if I want use open_uri to open it i need escape # symbol by myself :)

[clason]

I am confused about the execution order, where would you set a global variable in time? I cannot find a place where this is done

In your init.vim. The point is only to add the functionality for now so users can use that instead of netRW if they choose. In a second step (after the early access crowd has found the majority of bugs), we can make this the default.

[mrshmllow]

I do hate explorer but start is somehow worse. currently with explorer on windows vim.ui.open("google.com") will open the file manager at some random location without warning.

But start requires a bunch of weird stuff. start for some reason interprets the first argument as the title, but not always(?). start also is entirely different depending on the shell and has some strangeness with spaces, which explorer properly handles.

[justinmk]

currently with explorer on windows vim.ui.open("google.com") will open the file manager at some random location without warning.

without "https://" that would be treated as a filepath on any system, afaik.

If you find that netrw's gx on Windows works better, we could use its start rundll32 url.dll,FileProtocolHandler approach:

neovim/runtime/autoload/netrw.vim

Lines 5431 to 5433 in 3ecd45d

	call s:NetrwExe('sil! !start rundll32 url.dll,FileProtocolHandler '.s:ShellEscape(fname,1))
	elseif executable("rundll32")
	call s:NetrwExe('sil! !rundll32 url.dll,FileProtocolHandler '.s:ShellEscape(fname,1))

[lourenci]

I should be able to not load netrw plugin completely after this, shouldn't I?

vim.g.loaded_netrwPlugin = 1
vim.g.loaded_netrw = 1

gx errors me with:

E117: Unknown function: netrw#GX
E116: Invalid arguments for function netrw#BrowseX

Thanks.

[zeertzjq]

Cannot reproduce

[lourenci]

Got it. I don't know why, but the netrw plugin share/nvim/runtime/plugin/netrwPlugin.vim is being loaded before the init.luafile (where I tell nvim to not load netrw through the vim.g.loaded_netrwPlugin global var). 🤷🏻‍♂️ Maybe there is some other issue there, or even some misconfiguration on my side.

[justinmk]

the netrw plugin share/nvim/runtime/plugin/netrwPlugin.vim is being loaded before the init.luafile (where I tell nvim to not load netrw through the vim.g.loaded_netrwPlugin global var)

May need to revert #24262 , or move this mapping to

neovim/runtime/lua/vim/_editor.lua

Line 1008 in 06c4edf

function vim._init_default_mappings()

[adelarsq]

@justinmk On Windows this call fails:

lua vim.ui.open('https://devdocs.io/#q=lua%20lua_call')

I think that the reason is that Explorer doesn't accept the URL:

The message says the its an invalid URL but its a valid one for devdocs.

Is there any alternative to avoid this dependency?

[justinmk]

I think that the reason is that Explorer doesn't accept the URL ... Is there any alternative to avoid this dependency?

See above, #23401 (comment) . Patch welcome, having someone with a Windows machine would be helpful.

[mrshmllow]

maybe it's worth switching the opener strategy on windows

[justinmk]

is that different than what i said in #23401 (comment) ?

[mrshmllow]

#24392

[adelarsq]

is that different than what i said in #23401 (comment) ?

It's the same issue.

#24392

I had confirmed that with this fix vim.ui.open works as expected on Windows.

[mrshmllow]

May need to revert #24262 , or move this mapping to...

#24420