Neovim: Random "Cannot find module ... tsserverlibrary.js" with workspaces

[mikehaertl]

I work on a quite large Vue3 monorepo project in my /home/jobs/demo/ directory. I get the following error when I open a .vue file from a workspace subdirectory (e.g. /home/jobs/demo/packages/frontend/app/app.vue):

Error executing vim.schedule lua callback: /usr/local/share/nvim/runtime/lua/vim/lsp.lua:955: 
RPC[Error] code_name = InternalError, message = "Request initialize failed with message: 
Cannot find module '/home/jobs/demo/packages/frontend/app/node_modules/typescript/lib/tsserverlibrary.js'
Require stack:
- /usr/local/lib/node_modules/@volar/vue-language-server/out/node.js
- /usr/local/lib/node_modules/@volar/vue-language-server/bin/vue-language-server.js"
stack traceback:
        [C]: in function 'assert'
        /usr/local/share/nvim/runtime/lua/vim/lsp.lua:955: in function 'cb'
        vim/_editor.lua:256: in function <vim/_editor.lua:256>

Notice the Require stack that points to an issue in vue-language-server.

The required file exists in the main node_modules directory (/home/jobs/demo/node_modules/typescript/lib/tsserverlibrary.js).

Important: The issue goes away if I first open a random file from the root node_modules directory (e.g. /home/jobs/demo/node_modules/abab/index.d.ts) and then open the same app.vue as before.

My coworkers use VSCode and don't seem to have the issue.

Environment

• neovim 0.7.0
• nvim-lsp-config
• take-over-mode enabled

Related nvim config:

lspconfig.volar.setup{
  -- cmd = {'node', '/usr/local/bin/vue-language-server', '--stdio', '--max-old-space-size=6144' },
  -- cmd = {"vue-language-server", "--stdio", "--max-old-space-size=4096" },
  filetypes = {'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'vue', 'json'},
}

I've also seen #862 which seems somewhat similar and tried --max-old-space-size=4096 but it made no difference.

I can provide more details if required.

[yaegassy]

Please check here and try the settings. https://github.com/neovim/nvim-lspconfig/blob/master/lua/lspconfig/server_configurations/volar.lua#L97-L135

[mikehaertl]

Ok, it works if I configure the global typescript installation:

lspconfig.volar.setup{
  filetypes = {'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'vue', 'json'},
  init_options = {
    typescript = {
      serverPath = '/usr/local/lib/node_modules/typescript/lib/tsserverlibrary.js',
    },
  },
}

But isn't this rather a workaround? Shouldn't it always use the typescript package from the project directory? I mean, it already works under certain conditions as explained above.

[yaegassy]

This is not a problem with the volar language server itself. It is a problem on the nvim-lspconfig side. Please make the necessary modifications, etc. on the code side of nvim-lspconfig.

[mikehaertl]

Ok, I'll try on the nvim-lspconfig side. The problem there is that the provided script does not work as promised. IMO it should check parent after parent until it finds a node_modules/typescript/lib/tsserverlibrary.js. Instead it only checks in the current working directory.

Opened a related issue: neovim/nvim-lspconfig#1908

Thanks for the pointer.

[yaegassy]

Starting Neovim in the project root (cd /home/jobs/demo/ && nvim) or overriding the root_dir setting may change the behavior. If necessary, try changing the settings, etc., and give it a try. https://github.com/neovim/nvim-lspconfig/blob/master/lua/lspconfig/server_configurations/volar.lua#L60

[mikehaertl]

Thing is that the project is a monorepo. So there are several package.json. But I've modified the nvim-lspconfig script to traverse all parent directories as described above. Seems to work well. I'll probably suggest a change.

[mikehaertl]

Here's my updated script: neovim/nvim-lspconfig#1909