diff options
| author | glepnir <glephunter@gmail.com> | 2024-10-15 18:05:26 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-15 18:05:26 +0800 |
| commit | 7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e (patch) | |
| tree | 7c6ca33f6e4643630b3ed369243a236223736442 | |
| parent | docs: update configs.md (diff) | |
| download | nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar.gz nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar.bz2 nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar.lz nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar.xz nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.tar.zst nvim-lspconfig-7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e.zip | |
docs: add requirement of a new server (#3368)
* docs: add requirement of a new server
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
| -rw-r--r-- | CONTRIBUTING.md | 8 | ||||
| -rw-r--r-- | doc/lspconfig.txt | 6 |
2 files changed, 11 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b79c9d2..979ff78b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,14 @@ The point of lspconfig is to provide the minimal configuration necessary for a s ## Adding a server to lspconfig +New configs must meet these criteria (to avoid spam/quasi-marketing/vanity projects): + +- GitHub Stars: The server repository should have at least 100 stars, or some other evidence (such as vscode marketplace downloads) that the LSP server is reasonably popular and is not spam/quasi-marketing/vanity projects. +- Provide some reference or evidence that the language targeted by the LSP server has an active user base. + +This helps ensure that we only include actively maintained and widely used servers to provide a better experience for +the community. + To add a new language server, start with a minimal skeleton. See `:help lspconfig-new`. When choosing a config name, convert dashes (`-`) to underscores (`_`). If the name of the server is a unique name (`pyright`, `clangd`) or a commonly used abbreviation (`zls`), prefer this as the server name. If the server instead follows the pattern x-language-server, prefer the convention `x_ls` (`jsonnet_ls`). diff --git a/doc/lspconfig.txt b/doc/lspconfig.txt index 0ba19021..553d7362 100644 --- a/doc/lspconfig.txt +++ b/doc/lspconfig.txt @@ -382,9 +382,9 @@ Launches the requested (configured) client, but only if it successfully resolves a root directory. Note: Defaults to all configured servers matching the current buffer filetype. -:LspStop [client_id] *:LspStop* -Stops the server with the given client id. Defaults to stopping all servers -active on the current buffer. To force stop a language server: > +:LspStop [client_id] or [config_name] *:LspStop* +Stops the server with the given client-id or config name. Defaults to stopping +all servers active on the current buffer. To force stop a language server: > :LspStop <client_id> ++force :LspRestart [client_id] *:LspRestart* |