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.regols

The regols language server.

Type: submodule

Default: { }

Declared by:

lsp.servers.regols.enable

Whether to enable regols.

Type: boolean

Default: false

Example: true

Declared by:

lsp.servers.regols.package

The regols package to use.

Alternatively, regols should be installed on your $PATH.

Type: null or package

Default: pkgs.regols

Declared by:

lsp.servers.regols.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.regols.activate

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

Type: boolean

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

Example: false

Declared by:

lsp.servers.regols.config

Configurations for regols.

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.regols.name

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

Type: string or raw lua code

Default: "regols"

Declared by: