aboutsummaryrefslogtreecommitdiffstats
path: root/doc/configs.md
diff options
context:
space:
mode:
authorgithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2025-02-28 12:22:59 +0000
committergithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2025-02-28 12:22:59 +0000
commit62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e (patch)
tree346ffa617e544e36dbc818cb72900bcab9be6243 /doc/configs.md
parentfix(bacon_ls): new configuration #3632 (diff)
downloadnvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar.gz
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar.bz2
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar.lz
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar.xz
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.tar.zst
nvim-lspconfig-62c5fac4c59be9e41b92ef62f3bb0fbdae3e2d9e.zip
docs: update configs.md
skip-checks: true
Diffstat (limited to 'doc/configs.md')
-rw-r--r--doc/configs.md31
1 files changed, 22 insertions, 9 deletions
diff --git a/doc/configs.md b/doc/configs.md
index 83743835..5ff0c7d9 100644
--- a/doc/configs.md
+++ b/doc/configs.md
@@ -1135,21 +1135,34 @@ It offers textDocument/diagnostic and workspace/diagnostic capabilities for Rust
workspaces using the Bacon export locations file.
It requires `bacon` and `bacon-ls` to be installed on the system using
-[mason.nvim](https://github.com/williamboman/mason.nvim) or manually:util
+[mason.nvim](https://github.com/williamboman/mason.nvim) or manually
```sh
$ cargo install --locked bacon bacon-ls
```
-Settings can be changed using the `settings` dictionary:util
+Settings can be changed using the `init_options` dictionary:util
```lua
-settings = {
- -- Bacon export filename, default .bacon-locations
+init_options = {
+ -- Bacon export filename (default: .bacon-locations).
locationsFile = ".bacon-locations",
- -- Maximum time in seconds the LSP server waits for Bacon to update the
- -- export file before loading the new diagnostics
- waitTimeSeconds = 10
+ -- Try to update diagnostics every time the file is saved (default: true).
+ updateOnSave = true,
+ -- How many milliseconds to wait before updating diagnostics after a save (default: 1000).
+ updateOnSaveWaitMillis = 1000,
+ -- Try to update diagnostics every time the file changes (default: true).
+ updateOnChange = true,
+ -- Try to validate that bacon preferences are setup correctly to work with bacon-ls (default: true).
+ validateBaconPreferences = true,
+ -- f no bacon preferences file is found, create a new preferences file with the bacon-ls job definition (default: true).
+ createBaconPreferencesFile = true,
+ -- Run bacon in background for the bacon-ls job (default: true)
+ runBaconInBackground = true,
+ -- Command line arguments to pass to bacon running in background (default "--headless -j bacon-ls")
+ runBaconInBackgroundCommandArguments = "--headless -j bacon-ls",
+ -- How many milliseconds to wait between background diagnostics check to synchronize all open files (default: 2000).
+ synchronizeAllOpenFilesWaitMillis = 2000,
}
```
@@ -1167,11 +1180,11 @@ Default config:
```lua
{ "rust" }
```
-- `root_dir` source (use "gF" to visit): [../lua/lspconfig/configs/bacon_ls.lua:4](../lua/lspconfig/configs/bacon_ls.lua#L4)
-- `settings` :
+- `init_options` :
```lua
{}
```
+- `root_dir` source (use "gF" to visit): [../lua/lspconfig/configs/bacon_ls.lua:4](../lua/lspconfig/configs/bacon_ls.lua#L4)
- `single_file_support` : `true`