aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-04-26 15:59:54 -0700
committerGitHub <noreply@github.com>2025-04-26 15:59:54 -0700
commit3dde1b87963ed93bf1c7e63392fbc5e60520f2ad (patch)
tree2e987572b9a055d6718f2eda6d16e82b72bfc9a5
parentdocs: update configs.md (diff)
downloadnvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar.gz
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar.bz2
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar.lz
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar.xz
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.tar.zst
nvim-lspconfig-3dde1b87963ed93bf1c7e63392fbc5e60520f2ad.zip
docs: cleanup #3791
-rw-r--r--README.md2
-rw-r--r--lsp/angularls.lua4
-rw-r--r--lsp/azure_pipelines_ls.lua2
-rw-r--r--lsp/nelua_lsp.lua2
-rw-r--r--lsp/ntt.lua2
-rw-r--r--lsp/slangd.lua2
-rw-r--r--lsp/stylelint_lsp.lua2
-rw-r--r--lsp/ts_ls.lua2
-rw-r--r--lsp/volar.lua16
-rw-r--r--lsp/yamlls.lua4
10 files changed, 19 insertions, 19 deletions
diff --git a/README.md b/README.md
index ddee2a91..ca4a4d09 100644
--- a/README.md
+++ b/README.md
@@ -152,7 +152,7 @@ Most of the time, the reason for failure is present in the logs.
## Commands
* `: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.
+* `:LspStart <config_name>` Start the requested server name. Will only successfully start if the command detects a root directory matching the current config.
* `: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.
diff --git a/lsp/angularls.lua b/lsp/angularls.lua
index cdf28c9e..ea2fe006 100644
--- a/lsp/angularls.lua
+++ b/lsp/angularls.lua
@@ -9,12 +9,12 @@
--- local project_library_path = "/path/to/project/lib"
--- local cmd = {"ngserver", "--stdio", "--tsProbeLocations", project_library_path , "--ngProbeLocations", project_library_path}
---
---- require'lspconfig'.angularls.setup{
+--- vim.lsp.config('angularls', {
--- cmd = cmd,
--- on_new_config = function(new_config,new_root_dir)
--- new_config.cmd = cmd
--- end,
---- }
+--- })
--- ```
-- Angular requires a node_modules directory to probe for @angular/language-service and typescript
diff --git a/lsp/azure_pipelines_ls.lua b/lsp/azure_pipelines_ls.lua
index 0980cb5d..ade47ebb 100644
--- a/lsp/azure_pipelines_ls.lua
+++ b/lsp/azure_pipelines_ls.lua
@@ -13,7 +13,7 @@
--- By default `azure-pipelines-ls` will only work in files named `azure-pipelines.yml`, this can be changed by providing additional settings like so:
--- ```lua
--- vim.lsp.config('azure_pipelines_ls', {
---- ... -- other configuration for setup {}
+--- ... -- other configuration
--- settings = {
--- yaml = {
--- schemas = {
diff --git a/lsp/nelua_lsp.lua b/lsp/nelua_lsp.lua
index 7ad871fa..7f810348 100644
--- a/lsp/nelua_lsp.lua
+++ b/lsp/nelua_lsp.lua
@@ -19,7 +19,7 @@
--- **By default, nelua-lsp doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary.
---
--- ```lua
---- vim.lsp.config('nelua_lsp.setup, {
+--- vim.lsp.config('nelua_lsp', {
--- cmd = { "nelua", "-L", "/path/to/nelua-lsp/", "--script", "/path/to/nelua-lsp/nelua-lsp.lua" },
--- })
--- ```
diff --git a/lsp/ntt.lua b/lsp/ntt.lua
index 6074a28c..03e0c936 100644
--- a/lsp/ntt.lua
+++ b/lsp/ntt.lua
@@ -2,7 +2,7 @@
---
--- https://github.com/nokia/ntt
--- Installation instructions can be found [here](https://github.com/nokia/ntt#Install).
---- Can be configured by passing a "settings" object to `ntt.setup{}`:
+--- Can be configured by passing a "settings" object to vim.lsp.config('ntt'):
--- ```lua
--- vim.lsp.config('ntt', {
--- settings = {
diff --git a/lsp/slangd.lua b/lsp/slangd.lua
index 1dcf12dd..6df1c87f 100644
--- a/lsp/slangd.lua
+++ b/lsp/slangd.lua
@@ -5,7 +5,7 @@
--- The `slangd` binary can be downloaded as part of [slang releases](https://github.com/shader-slang/slang/releases) or
--- by [building `slang` from source](https://github.com/shader-slang/slang/blob/master/docs/building.md).
---
---- The server can be configured by passing a "settings" object to `slangd.setup{}`:
+--- The server can be configured by passing a "settings" object to vim.lsp.config('slangd'):
---
--- ```lua
--- vim.lsp.config('slangd', {
diff --git a/lsp/stylelint_lsp.lua b/lsp/stylelint_lsp.lua
index 92f7b541..9d11eeca 100644
--- a/lsp/stylelint_lsp.lua
+++ b/lsp/stylelint_lsp.lua
@@ -8,7 +8,7 @@
--- npm i -g stylelint-lsp
--- ```
---
---- Can be configured by passing a `settings.stylelintplus` object to `stylelint_lsp.setup`:
+--- Can be configured by passing a `settings.stylelintplus` object to vim.lsp.config('stylelint_lsp'):
---
--- ```lua
--- vim.lsp.config('stylelint_lsp', {
diff --git a/lsp/ts_ls.lua b/lsp/ts_ls.lua
index c3e8e1b9..877a663c 100644
--- a/lsp/ts_ls.lua
+++ b/lsp/ts_ls.lua
@@ -59,7 +59,7 @@
--- })
---
--- -- You must make sure volar is setup
---- -- e.g. require'lspconfig'.volar.setup{}
+--- -- e.g. vim.lsp.config('volar')
--- -- See volar's section for more information
--- ```
---
diff --git a/lsp/volar.lua b/lsp/volar.lua
index 99682977..80c08e12 100644
--- a/lsp/volar.lua
+++ b/lsp/volar.lua
@@ -24,7 +24,7 @@
--- ```lua
--- local lspconfig = require('lspconfig')
---
---- lspconfig.volar.setup {
+--- vim.lsp.config('volar', {
--- -- add filetypes for typescript, javascript and vue
--- filetypes = { 'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'vue' },
--- init_options = {
@@ -33,9 +33,9 @@
--- hybridMode = false,
--- },
--- },
---- }
---- -- you must remove ts_ls setup
---- -- lspconfig.ts_ls.setup {}
+--- })
+--- -- you must remove "ts_ls" config
+--- -- vim.lsp.config['ts_ls'] = {}
--- ```
---
--- **Overriding the default TypeScript Server used by Volar**
@@ -45,19 +45,19 @@
---
--- - use a global TypeScript Server installation
--- ```lua
---- require'lspconfig'.volar.setup {
+--- vim.lsp.config('volar', {
--- init_options = {
--- typescript = {
--- -- replace with your global TypeScript library path
--- tsdk = '/path/to/node_modules/typescript/lib'
--- }
--- }
---- }
+--- })
--- ```
---
--- - use a local server and fall back to a global TypeScript Server installation
--- ```lua
---- require'lspconfig'.volar.setup {
+--- vim.lsp.config('volar', {
--- init_options = {
--- typescript = {
--- -- replace with your global TypeScript library path
@@ -70,7 +70,7 @@
--- new_config.init_options.typescript.tsdk = lib_path
--- end
--- end
---- }
+--- })
--- ```
local function get_typescript_server_path(root_dir)
diff --git a/lsp/yamlls.lua b/lsp/yamlls.lua
index 7a36f94f..c3687cc0 100644
--- a/lsp/yamlls.lua
+++ b/lsp/yamlls.lua
@@ -24,7 +24,7 @@
---
--- ```lua
--- vim.lsp.config('yamlls', {
---- ... -- other configuration for setup {}
+--- ...
--- settings = {
--- yaml = {
--- ... -- other settings. note this overrides the lspconfig defaults.
@@ -46,7 +46,7 @@
---
--- ```lua
--- vim.lsp.config('yamlls', {
---- ... -- other configuration for setup {}
+--- ...
--- settings = {
--- yaml = {
--- ... -- other settings. note this overrides the lspconfig defaults.