RepoMirrors/nvim-lspconfig
1
0
Fork 0
mirror of https://github.com/neovim/nvim-lspconfig synced 2025-03-11 04:27:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update configs.md
Some checks are pending
docgen / docgen (push) Waiting to run
Details

Browse Source 
skip-checks: true
This commit is contained in:
github-actions[bot] 2025-02-28 12:22:59 +00:00
parent d99a4c4fcf
commit 62c5fac4c5
2 changed files with 44 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/configs.md
View File

@ -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`

31
doc/configs.txt
View File

@ -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`