diff options
| author | Michael Lingelbach <m.j.lbach@gmail.com> | 2021-11-19 20:11:15 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-19 20:11:15 -0500 |
| commit | 17008c63eccbb56aeb3a27f7d26bce3d66e03fa7 (patch) | |
| tree | 5d03750644fd26e2835c8a293aef3ea301c28315 /CONTRIBUTING.md | |
| parent | docs: update server_configurations.md (diff) | |
| download | nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar.gz nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar.bz2 nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar.lz nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar.xz nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.tar.zst nvim-lspconfig-17008c63eccbb56aeb3a27f7d26bce3d66e03fa7.zip | |
docs: clarify server naming conventions (#1456)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ac4f6c8..be2301ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,8 @@ The point of lspconfig is to provide the minimal configuration necessary for a s The general form of adding a new language server is to start with a minimal skeleton. This includes populated the `config` table with a `default_config` and `docs` table. +When choosing a server name, convert all 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`). + `default_config` should include, at minimum the following: * `cmd`: a list which includes the executable name as the first entry, with arguments constituting subsequent list elements (`--stdio` is common) * `filetypes`: a list for filetypes a |