diff options
| -rw-r--r-- | doc/configs.md | 31 | ||||
| -rw-r--r-- | doc/configs.txt | 31 |
2 files changed, 44 insertions, 18 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` diff --git a/doc/configs.txt b/doc/configs.txt index 83743835..5ff0c7d9 100644 --- a/doc/configs.txt +++ b/doc/configs.txt @@ -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` |