aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-04-21 16:40:05 +0200
committerJustin M. Keyes <justinkz@gmail.com>2025-04-21 16:40:17 +0200
commitae3f0f4a7704455f21ba2d61c394d14561587445 (patch)
treec7a57b0e9e6e626c639e81227716399d6d91172e /README.md
parentdocs: update configs.md (diff)
downloadnvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar.gz
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar.bz2
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar.lz
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar.xz
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.tar.zst
nvim-lspconfig-ae3f0f4a7704455f21ba2d61c394d14561587445.zip
docs: misc
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 6 insertions, 12 deletions
diff --git a/README.md b/README.md
index 6c3edf97..ddee2a91 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
# nvim-lspconfig
nvim-lspconfig is a "data only" repo, providing basic, default [Nvim LSP client](https://neovim.io/doc/user/lsp.html)
-configurations for various LSP servers.
-
-View [all configs](doc/configs.md) or `:help lspconfig-all` from Nvim.
+configurations for various LSP servers. View [all configs](doc/configs.md) or `:help lspconfig-all` from Nvim.
## Important ⚠️
@@ -123,7 +121,7 @@ vim.lsp.config('pyright', {
which extends the configuration under [`lsp/`](./lsp/). For further information see [`:help lsp-config`][lsp-config].
-> [!WARNING]
+> [!WARNING]
> Some servers are [currently missing](https://github.com/neovim/nvim-lspconfig/issues/3705).
## Troubleshooting
@@ -131,10 +129,8 @@ which extends the configuration under [`lsp/`](./lsp/). For further information
The most common reasons a language server does not start or attach are:
1. Language server is not installed. nvim-lspconfig does not install language servers for you. You should be able to run the `cmd` defined in each server's Lua module from the command line and see that the language server starts. If the `cmd` is an executable name instead of an absolute path to the executable, ensure it is on your path.
-2. Missing filetype plugins. Certain languages are not detecting by Vim/Nvim because they have not yet been added to the filetype detection system. Ensure `:set ft?` shows the filetype and not an empty value.
-3. Not triggering root detection. **Some** language servers will only start if it is opened in a directory, or child directory, containing a file which signals the *root* of the project. Most of the time, this is a `.git` folder, but each server defines the root config in the lua file. See [doc/configs.md](doc/configs.md) or the source for the list of root directories.
-4. You must pass `capabilities` for **each** `setup {}` if you want these to take effect.
-5. **Do not call `setup {}` twice for the same server**. The second call to `setup {}` will overwrite the first.
+2. Missing filetype plugins. Certain languages are not detected by Vim/Nvim because they have not yet been added to the filetype detection system. Ensure `:set filetype?` shows the filetype and not an empty value.
+3. Not triggering root detection. **Some** language servers require a "workspace", which is found by looking for an ancestor directory that contains a "root marker". The most common root marker is `.git/`, but each config defines other "root marker" names. Root markers/directories are listed in [doc/configs.md](doc/configs.md).
## Bug reports
@@ -157,10 +153,8 @@ Most of the time, the reason for failure is present in the logs.
* `:LspInfo` (alias to `:checkhealth vim.lsp`) shows the status of active and configured language servers.
* `:LspStart <config_name>` Start the requested server name. Will only successfully start if the command detects a root directory matching the current config. Pass `autostart = false` to your `.setup{}` call for a language server if you would like to launch clients solely with this command. Defaults to all servers matching current buffer filetype.
-* `:LspStop [<client_id_or_name> ...]` Stops the given server(s). Defaults to
-stopping all servers active on the current buffer. To force stop add `++force`
-* `:LspRestart [<client_id_or_name> ...]` Restarts the given client(s), and attempts to reattach to all
-previously attached buffers.
+* `:LspStop [<client_id_or_name> ...]` Stops the given server(s). Defaults to stopping all servers active on the current buffer. To force stop add `++force`
+* `:LspRestart [<client_id_or_name> ...]` Restarts the given client(s), and attempts to reattach to all previously attached buffers.
## Contributions