Disable recursive globbing for $HOME

[lithammer]

When opening a shell script in your home folder (~/foo.sh), bash-language-server starts looking through your entire home directory for files. There are two main problems with this:

1. It takes forever for the server to start. I have around 2 million files in my home directory, and that's after removing things like node_modules/ which are notoriously big. It takes 2.5 minutes for the server to start on my 2017 MacBook Pro with SSD.

2. Even after the scan is complete, 99% of the information is going to be irrelevant for the file I'm editing. Getting completion result about Bash variables defined 6 directories down in some repo I cloned 9 months ago just isn't very interesting.

Personally I basically never want recursive globbing, It's just not that interesting. In my experience related shell scripts are usually located in the same directory. But I'll settle with just the home directory.

Now, of course I could just set GLOB_PATTERN and continue with my day. But the problem is the constant issues raised over at https://github.com/neovim/nvim-lspconfig about the bash-language-server not working with Neovim's native language server client. Most of the time it's because they opened some file directly in the home directory and they think it's not working (but it's just busy globbing).

A workaround (neovim/nvim-lspconfig#686) was recently merged try to prevent any such issues. But it would be better if the server itself just handled this more gracefully.

[skovhus]

Thanks for reporting and bringing this issue to our attention. I wasn't aware of this.

I see a few options:

1. making *@(.sh|.inc|.bash|.command) the default for GLOB_PATTERN seems like the simplest workaround (like https://github.com/neovim/nvim-lspconfig/pull/686/files)
2. special-casing the home folder like recommended by nvim. This isn't really a proper fix as similar issues could appear in other parts of the file system
3. limiting the recursion to the subfolder by using another globbing library: fg.sync('**/*@(.sh|.inc|.bash|.command)', {suppressErrors: true, onlyFiles: true, deep: 1}) would work using https://www.npmjs.com/package/fast-glob

[lithammer]

1. making *@(.sh|.inc|.bash|.command) the default for GLOB_PATTERN seems like the simplest workaround (like https://github.com/neovim/nvim-lspconfig/pull/686/files)

Definitely an easy fix and hopefully won't cause too many user regressions.

2. special-casing the home folder like recommended by nvim. This isn't really a proper fix as similar issues could appear in other parts of the file system

This is my least favorite option. As you mentioned, it's not really a proper fix since the issue can really happen anywhere. It's just that it's easy to reproduce in $HOME.

3. limiting the recursion to the subfolder by using another globbing library: fg.sync('**/*@(.sh|.inc|.bash|.command)', {suppressErrors: true, onlyFiles: true, deep: 1}) would work using https://www.npmjs.com/package/fast-glob

This is my favorite option and is a nice compromise. Maybe even expose the deep variable via some setting or environment variable for the odd chance someone wants to tweak it.

[oblitum]

Disabling recursive scan isn't necessary if null workspaces are properly supported from both sides (client/server). See neovim/neovim#15430 (comment) and LuaLS/lua-language-server#480 (comment). At the moment, coc.nvim for example supports it client-side, and due to that, has managed to fix its long time home scan issues with bash-language-server.

[skovhus]

A more performant, robust and stable analyzer has been released as version 3.3.0 (which is part of the latest VSCode extension 1.17.0). You can find more details in #569

I believe this should reduce the need for making any custom rules for disabling recursive globbing.

Feel free to report back how it works for you.