ccls: remove inaccurate vscode client initialization options from docgen

[cdelledonne]

I'm having trouble figuring out how to specify initialization options for ccls (the only LSP server I've tested so far) using the settings key. Say I want ccls.cache.directory to be /tmp/ccls-cache, using a command switch I can achieve it like the following

local nvim_lsp = require 'nvim_lsp'
nvim_lsp.ccls.setup{
    cmd = {
        'ccls',
        '--init={"cache": {"directory": "/tmp/ccls-cache"}}'
    };
}

That works. I'd like to be able to do the same using the settings key, but I can't. For instance, neither

local nvim_lsp = require 'nvim_lsp'
nvim_lsp.ccls.setup{
    cmd = {
        'ccls'
    };
    settings = {
        ccls = {
            cache = {
                directory = "/tmp/ccls-cache";
            };
        };
    };
}

nor

local nvim_lsp = require 'nvim_lsp'
nvim_lsp.ccls.setup{
    cmd = {
        'ccls'
    };
    settings = {
        cache = {
            directory = "/tmp/ccls-cache";
        };
    };
}

work. Looking into ccls's log, the cache option is not even being sent to the server when initializing it.

Am I doing something wrong?

Environment

• NVIM v0.5.0-233-g76d1e9360

[norcalli]

That would depend on whether it's "initialization options" or "workspace configuration." This is one of my least favorite parts of the LSP protocol, which is that there are many different ways to send initial configurations to the client:

• Initialization options (initializationOptions sent via initialize) correspond to init_options in our system.
• Workspace configuration (workspace/configuration and workspace/didChangeConfiguration) corresponds to settings in our system.

Without looking into it further, I'd double check which one ccls is expecting.

EDIT: Nvm I looked at our README and it does state that ccls.cache.directory should be a valid "setting". I'll look into it later.

[cdelledonne]

Indeed using init_options works. I guess the same holds for other options listed under ccls which have to be sent via initialize.

A side question: there are three options under ccls.misc.<suboption>. Why is misc there? I believe ccls only expects <suboption>, rather than misc.<suboption> (e.g, compilationDatabaseDirectory).

[norcalli]

Those values are scraped directly from the package.json in the vscode extension. I guess that it's impossible to know if they are init_options or settings, but they are things that the ccls-project.ccls extension defines, so they are definitely real. I can't really say more than that.

[cdelledonne]

Got it, thanks. Feel free to close the issue, but I feel the README is a little confusing.

[norcalli]

I'm going to leave it open as a reminder to improve the README :P

[wheelsandmetal]

I also found this confusing

This is what I thought the docs were telling me to do

nvim_lsp.ccls.setup{
  settings = {
    ccls = {
      misc = {     
	compilationDatabaseDirectory = "build"
      }
    }
  }
}

And this is what I actually needed

nvim_lsp.ccls.setup{
  init_options = {
	compilationDatabaseDirectory = "build"
  }
}

[mjlbach]

@cdelledonne Can you look at #528, I tried to make it clear the customization for ccls is all set via on_init. Many servers are inconsistent with whether configuration is done via settings/init options, so I think the best thing we can do is just have good documentation for each one.

[cdelledonne]

@mjlbach the improved documentation with the example is a nice additions, thanks!

However, I can still see the following in CONFIG.md, is that outdated or am I missing something?

nvim-lspconfig/CONFIG.md

Line 164 in 384e512

This server accepts configuration via the `settings` key.

[mjlbach]

Ah, you are correct. Docgen automatically adds that

nvim-lspconfig/scripts/docgen.lua

Line 152 in 384e512

'This server accepts configuration via the `settings` key.';

Not sure the best thing to do about that, it should probably be removed and manually added to each server.

Other than removing that, is there anything you would improve?

[cdelledonne]

I do have one more question: the example shows how to set the compilationDatabaseDirectory

init_options = { 
    compilationDatabaseDirectory = "build";
    ...
}

but the list of options presents it as ccls.misc.compilationDatabaseDirectory. Why isn't the option set as follows?

init_options = { 
    misc = {
        compilationDatabaseDirectory = "build";
    };
    ...
}

Do all misc options fall directly under init_options?

[mjlbach]

Does that work for you? I might just remove the package.json for ccls.

I was going by the entry here which isn't nested under misc:
https://github.com/MaskRay/ccls/wiki/Customization#compilationdatabasedirectory

[mjlbach]

I'm guessing their package.json is just wrong:

https://github.com/MaskRay/ccls/blob/a2d2fd8167c17aec3a9711916d4f5c7a031cd769/src/project.cc#L358

https://github.com/MaskRay/ccls/blob/1dc69f45dc3e0c0f750f5a2e220a6aea54f30d2a/src/messages/initialize.cc#L278

[mjlbach]

Oh, they remap misc.compilationDatabaseDirectory to compilationDatabaseDirectory when it's sent from the client (vscode-ccls) to the server (ccls) here: https://github.com/MaskRay/vscode-ccls/blob/456f21ebf3013abbc553442dd81610f1595310f5/src/serverContext.ts#L148-L155.

The documentation would be accurate if we were using the vscode client (which of course, we aren't), but we're scraping the settings from the vscode client which explains why the remapped settings are showing up in the documentation. I'm just going to remove them, because it seems like a common source of confusion.