add module search path to lsp server configuration

[LeonB]

Based of issue #9

About -L, that should be possible also but i'm not sure how it would be communicated to the lsp serve? thru extension option? some kind of config in jq file?

I think the first and easiest way to implement it, is to use the initializationOptions. There's also workspaceConfiguration and didChangeConfiguration.

The neovim lsp documentation states:

Most language servers expect to be sent client specified settings after initialization. Neovim does not make this assumption. A workspace/didChangeConfiguration notification should be sent to the server during on_init.

So I'm not sure if vim is sending the initializationOptions in the initialize request.

[LeonB]

Ah, I see the rpc parsing is done in jq itself :) Why is that if I may ask? The only options I see at the moment:

1. is do some pre-parsing of the json rpc calls in go

But I think your main goal here is to keep as much code in jq if I'm correct?

2. Use gojq.WithFunction to create a function that adds a path to the gojq.WithModuleLoader function

[wader]

Based of issue #9

About -L, that should be possible also but i'm not sure how it would be communicated to the lsp serve? thru extension option? some kind of config in jq file?

I think the first and easiest way to implement it, is to use the initializationOptions. There's also workspaceConfiguration and didChangeConfiguration.

The neovim lsp documentation states:

Most language servers expect to be sent client specified settings after initialization. Neovim does not make this assumption. A workspace/didChangeConfiguration notification should be sent to the server during on_init.

So I'm not sure if vim is sending the initializationOptions in the initialize request.

Yeap that could work for the LSP side, for vscode you can add some settings thingy to the lsp extension (https://github.com/wader/vscode-jq) but for other editors like neovim i don't know how it usually works?

How does for example gopls settings work with neovim?

[wader]

Ah, I see the rpc parsing is done in jq itself :) Why is that if I may ask? The only options I see at the moment:

The whole project is kind of experiment going to far :) i first did most of it in go but it just go very tedious to write the AST-code and i know jq would probably be a very good fit for doing exactly this so i tried and it work quite well. Now i'm not so sure anymore as it's not typed so making changes is a bit brittle. Maybe eventually worth doing a rewrite in go or even something else if gojq's parser is not suitable anymore, maybe something tree sitter based somehow?

1. is do some pre-parsing of the json rpc calls in go

But I think your main goal here is to keep as much code in jq if I'm correct?

Keep it in jq for now at least. And i think it should be possible, the jq rpc code has a state that gets passed/returned in the serve function, see https://github.com/wader/jq-lsp/blob/master/lsp/lsp.jq#L798-L812

2. Use gojq.WithFunction to create a function that adds a path to the gojq.WithModuleLoader function

Yes if it is complicated to maintain state in jq we could add some global state helpers to track things

[wader]

For ref neovim and gopls config https://github.com/golang/tools/blob/master/gopls/doc/vim.md#neovim-config but is lspconfig settings some generic lsp thing in lspconfig or per lsp? i'm know very little about it

@LeonB btw would you like to have a look at this? also the vscode/neovim part? i will of course help out

[LeonB]

I'm pretty sure the lspconfig settings is a generic lsp thing. I entered some random stuff in the lua lsp settings and checked the requests in the vim lsp log and saw the settings I entered.

• I'm going to debug a jq lsp sessions with custom settings and log the requests
• I'm going to do the same for vscode as soon as I figure out how to do custom settings in it

[LeonB]

neovim lspconfig only uses the didChangeConfiguration call:

["DEBUG",{"request":{"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"search_path":["."]}}}}]
["DEBUG",{"request":{"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"search_path":["."]}}}}]

neovim config:

require('lspconfig').jqls.setup({
    capabilities = capabilities,
    cmd = { '/Users/leon/Workspaces/go/src/github.com/LeonB/jq-lsp/jq-lsp' },
    -- autostart = false,
    root_dir = require('lspconfig').util.find_git_ancestor(),
    settings = {
        search_path = { "." },
    },
    settings_test = {
        test = "howdy"
    }
})

[wader]

neovim lspconfig only uses the didChangeConfiguration call:

["DEBUG",{"request":{"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"search_path":["."]}}}}]
["DEBUG",{"request":{"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"search_path":["."]}}}}]

neovim config:

require('lspconfig').jqls.setup({
    capabilities = capabilities,
    cmd = { '/Users/leon/Workspaces/go/src/github.com/LeonB/jq-lsp/jq-lsp' },
    -- autostart = false,
    root_dir = require('lspconfig').util.find_git_ancestor(),
    settings = {
        search_path = { "." },
    },
    settings_test = {
        test = "howdy"
    }
})

Nice! and you managed to figure how to enable debug 👍 sorry the code is not very dev friendly at the moment so please feel free to ask if something seems strange, it probably is :) and don't hesitate start a PR to have something to discuss about

[LeonB]

vscode took me a while... I think the api changed and the documentation isn't updated. Some examples in the repo made that clear:

["DEBUG",{"request":{"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"languageServerExample":{"maxNumberOfProblems":200,"trace":{"server":"off"}}}}}}]

So vscode also uses params.settings but it looks like it always adds the lsp name in the settings. Which makes the lspconfig examples make sense now. Examples from https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md

require'lspconfig'.lua_ls.setup {
  settings = {
    Lua = {
      runtime = {
        -- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim)
        version = 'LuaJIT',
      },
      diagnostics = {
        -- Get the language server to recognize the `vim` global
        globals = {'vim'},
      },
    },
  },
}

require'lspconfig'.pylsp.setup{
  settings = {
    pylsp = {
      plugins = {
        pycodestyle = {
          ignore = {'W391'},
          maxLineLength = 100
        }
      }
    }
  }
}

require'lspconfig'.rust_analyzer.setup{
  settings = {
    ['rust-analyzer'] = {
      diagnostics = {
        enable = false;
      }
    }
  }
}

So the jqls config should be something like:

require('lspconfig').jqls.setup({
    root_dir = require('lspconfig').util.find_git_ancestor(),
    settings = {
        jqls = {
            search_path = { "." },
        },
    },
})

[wader]

👍 nice digging. For vscode i understood it as there is some kind of config to put in package.json https://github.com/golang/vscode-go/blob/master/package.json#L1112 but haven't look close at it

[LeonB]

In the example client this is what does the sending of the LanguageClientOptions: https://github.com/matarillo/vscode-languageserver-csharp-example/blob/master/client/src/extension.ts#L44

I'm going to look at the state in lsp.jq and see if I can get that working.

[LeonB]

@wader how do you want the _import_env function to be adjusted?

Should I include a search_paths argument?

def _import_env($search_paths):

or maybe add it to the data taken in?

{"include_path":{"start":8,"stop":11,"str":"a", "search_paths": ["."]}}

[wader]

@wader how do you want the _import_env function to be adjusted?

Should I include a search_paths argument?

def _import_env($search_paths):

or maybe add it to the data taken in?

{"include_path":{"start":8,"stop":11,"str":"a", "search_paths": ["."]}}

Ah now i see, i did some ugly thing for the .jq-lsp thing. I wonder if it should be refactored to just take a string as input (and move .include_path.str // .import_path.str to the caller) and then maybe take search paths as an argument? feels jq-ish, but i'm not sure. What do you think?

Let me know if you have any jq issues, happy to help!

[LeonB]

That makes sense. I'll give it a go. But not today anymore :)

[wader]

Sounds good, glad someone wants to help out!

[LeonB]

I made some changes: LeonB@ddf0136

Curious what you think about them.

Only thing I'm having trouble with is feeding the settings.jqlsp.search_paths into _import_env

https://github.com/LeonB/jq-lsp/blob/master/lsp/lsp.jq#L447

@wader any pointers how I could best achieve that? For testing I provided it with a fixed path.