Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

lsp.servers.codebook

The codebook language server.

Type: submodule

Default: { }

Declared by:

lsp.servers.codebook.enable

Whether to enable codebook.

Type: boolean

Default: false

Example: true

Declared by:

lsp.servers.codebook.package

The codebook package to use.

Alternatively, codebook should be installed on your $PATH.

Type: null or package

Default: pkgs.codebook

Declared by:

lsp.servers.codebook.packageFallback

When enabled, the language server package will be added to the end of the PATH (suffix) instead of the beginning (prefix).

This can be useful if you want local versions of the language server (e.g. from a devshell) to override the nixvim version.

Type: boolean

Default: false

Declared by:

lsp.servers.codebook.activate

Whether to call vim.lsp.enable() for codebook.

Type: boolean

Default: true, unless the server’s name is *

Example: false

Declared by:

lsp.servers.codebook.config

Configurations for codebook.

Type: attribute set of anything

Default: { }

Example:

{
  cmd = [
    "clangd"
    "--background-index"
  ];
  filetypes = [
    "c"
    "cpp"
  ];
  root_markers = [
    "compile_commands.json"
    "compile_flags.txt"
  ];
}

Declared by:

lsp.servers.codebook.name

The name to use for codebook. Supplied to functions like vim.lsp.enable().

Type: string or raw lua code

Default: "codebook"

Declared by: