aboutsummaryrefslogtreecommitdiffstats
path: root/lua/lspconfig/configs/bacon_ls.lua
blob: 4f332f7c5792dbea8366d77d567aa6fc7b3481f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
local util = require 'lspconfig.util'

return {
  default_config = {
    cmd = { 'bacon-ls' },
    filetypes = { 'rust' },
    root_dir = util.root_pattern('.bacon-locations', 'Cargo.toml'),
    single_file_support = true,
    init_options = {},
  },
  docs = {
    description = [[
https://github.com/crisidev/bacon-ls

A Language Server Protocol wrapper for [bacon](https://dystroy.org/bacon/).
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

```sh
$ cargo install --locked bacon bacon-ls
```

Settings can be changed using the `init_options` dictionary:util

```lua
init_options = {
    -- Bacon export filename (default: .bacon-locations).
    locationsFile = ".bacon-locations",
    -- 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,
}
```
    ]],
  },
}