Skip to content
This repository has been archived by the owner on Nov 12, 2022. It is now read-only.

Improve documentation on server setup #659

Closed
gerazov opened this issue May 2, 2022 · 2 comments
Closed

Improve documentation on server setup #659

gerazov opened this issue May 2, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@gerazov
Copy link

gerazov commented May 2, 2022

Is your feature request related to a problem? Please describe.

LspInstallInfo lists a lot of server configuration settings, and it's not clear how we can change these.

Describe the solution you'd like

Add a paragraph in the documentation describing an example.

For instance it took me while to figure out how to enable/disable plugins in the pylsp server.
image

One thing I don't find very useful is the McCabe complexity check. Finally I got it working via the lspconfig setup function using:

require('lspconfig').pylsp.setup {
  on_attach = on_attach,
  flags = {
    -- This will be the default in neovim 0.7+
    debounce_text_changes = 150,
  },
  settings = {
    pylsp = {
      plugins = {
        -- pylint = { enabled = true },
        mccabe = { enabled = false }
      }
    }
  }
}

This might be server specific, but it would be nice to have this in the documentation to make it easier for people to find and tweak their server settings.

Other clients which have this feature

No response

Describe potential alternatives you've considered

No response

Additional context

I'm not sure if this is the place to have this information but it would help users of your plugin.

I posted it on the lspconfig GitHub as well neovim/nvim-lspconfig#1880

@gerazov gerazov added the enhancement New feature or request label May 2, 2022
@williamboman
Copy link
Owner

Hello! nvim-lsp-installer is not responsible for setting up servers. What's displayed there is a read-only overview of the server's configuration schema. It's displayed first and foremost to aid discoverability of which settings each server supports.

Would something like this make things clearer:

discalimer

helop

@gerazov
Copy link
Author

gerazov commented May 3, 2022

Makes sense 👍 I raised an issue there as well - for now they're pointing to the LSPs' websites but they're not nvim (lspconfig) related ...

But the listing is really convenient to see everything that can be tweaked 😎

Nice cow btw 😄

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants