Installation

You must use a nixpkgs version compatible with the nixvim version you choose.

The master branch requires to use a very recent version of nixpkgs unstable. In order to guarantee the compatibility between nixvim & nixpkgs it is recommended to always update both at the same time.

When using a stable version you must use the corresponding nixvim branch, for example nixos-24.05 when using NixOS 24.05.

Failure to use the correct branch, or an old revision of nixpkgs will likely result in errors of the form vimPlugins.<name> attribute not found.

NixVim can be used in four ways:

  • As a NixOS module
  • As a Home-Manager module
  • As a nix-darwin module
  • As a standalone derivation

NixVim is also available for nix flakes, or directly through an import.

Accessing nixvim

For a direct import you can add nixvim to your configuration as follows:

let
    nixvim = import (builtins.fetchGit {
        url = "https://github.com/nix-community/nixvim";
        # When using a different channel you can use `ref = "nixos-<version>"` to set it here
    });
in

When using flakes you can simply add nixvim to the inputs:

{
    inputs.nixvim = {
        url = "github:nix-community/nixvim";
        # If using a stable channel you can use `url = "github:nix-community/nixvim/nixos-<version>"`
        inputs.nixpkgs.follows = "nixpkgs";
    };

    # outputs...
}

Usage

NixVim can be used standalone or as a module for NixOS, home-manager, or nix-darwin.

When used standalone, a custom NixVim derivation is produced that can be used like any other package.

When used as a module, NixVim can be enabled though programs.nixvim.enable.

Usage as a module (NixOS, home-manager, nix-darwin)

When using NixVim as a module you must import the NixVim module into your module system. The three imports are:

  • <nixvim>.homeManagerModules.nixvim
  • <nixvim>.nixosModules.nixvim
  • <nixvim>.nixDarwinModules.nixvim

<nixvim> refers to the way to access nixvim, depending on how you fetched nixvim as described in the previous section.

The imports can be added as a imports = [ <nixvim_import> ] in a configuration file.

You will then be able to enable nixvim through programs.nixvim.enable = true, and configure the options as programs.nixvim.<path>.<to>.<option> = <value>.

When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with hmConfig, nixosConfig, and darwinConfig for home-manager, NixOS, and nix-darwin respectively. This is useful is you use nixvim both as part of an environment and as standalone.

If using the home-manager module, see Home Manager Usage for more information.

Standalone usage

When using nixvim as a standalone derivation you can use the following functions, located in <nixvim>.legacyPackages.${system}:

  • makeNixvim: This function takes an attribute set of options values as arguments
  • makeNixvimWithModule: This function takes an attribute set of the form: {pkgs, extraSpecialArgs, module}. The only required argument is module, being a NixOS module. This gives access to the imports, options, config variables, and using functions like {config, ...}: { ... }.

There are also some helper functions in <nixvim>.lib.${system} like:

  • check.mkTestDerivationFromNixvimModule, taking the same arguments as makeNixvimWithModule and generates a check derivation.
  • check.mkTestDerivationFromNvim, taking an attribute set of the form {name = "<derivation name>"; nvim = <nvim derivation>}. The nvim is the standalone derivation provided by NixVim.

The nixvim derivation can then be used like any other package!

For an example, see the nixvim standalone flake template.

For more information see Standalone Usage.

Helpers

If Nixvim is built using the standalone method, you can access our helpers as a module arg:

{ helpers, ... }:
{
  # Your config
}

If Nixvim is being used as as a home-manager module, a nixos module, or as a dawwin module, helpers can be accessed via the config.nixvim.helpers option:

{ config, ... }:
let
  inherit (config.nixvim) helpers;
in
{
  # Your config
}

A certain number of helpers are defined that can be useful:

  • helpers.emptyTable: An empty lua table {} that will be included in the final lua configuration. This is equivalent to {__empty = {};}. This form can allow to do option.__empty = {}.

  • helpers.mkRaw str: Write the string str as raw lua in the final lua configuration. This is equivalent to {__raw = "lua code";}. This form can allow to do option.__raw = "lua code".

  • helpers.toLuaObject obj: Create a string representation of the Nix object. Useful to define your own plugins.

  • helpers.listToUnkeyedAttrs list: Transforms a list to an "unkeyed" attribute set.

    This allows to define mixed table/list in lua:

      (listToUnkeyedAttrs ["a", "b"]) // {foo = "bar";}

    Resulting in the following lua:

      {"a", "b", [foo] = "bar"}

  • helpers.enableExceptInTests: Evaluates to true, except in mkTestDerivationFromNixvimModule where it evaluates to false. This allows to skip instantiating plugins that can't be run in tests.

  • helpers.toRawKeys attrs: Convert the keys of the given attrs to raw lua.

      toRawKeys {foo = 1; bar = "hi";}

    will translate in lua to:

      {[foo] = 1, [bar] = 2,}

    Otherwise, the keys of a regular attrs will be interpreted as lua string:

      {['foo'] = 1, ['bar'] = 2,}
  -- which is the same as
  {foo = 1, bar = 2,}

Frequently Asked Questions

How do I use a plugin not implemented in nixvim

Using a plugin not supported by nixvim, but packaged in nixpkgs is straightforward:

  • Register the plugin through extraPlugins: extraPlugins = [pkgs.vimPlugins."<plugin name>"].
  • Configure the plugin through extraConfigLua: extraConfigLua = "require('my-plugin').setup({foo = "bar"})";

How do I use a plugin not packaged in nixpkgs

This is straightforward too, you can add the following to extraPlugins for a plugin hosted on GitHub:

extraPlugins = [(pkgs.vimUtils.buildVimPlugin {
    name = "my-plugin";
    src = pkgs.fetchFromGitHub {
        owner = "<owner>";
        repo = "<repo>";
        rev = "<commit hash>";
        hash = "<nix NAR hash>";
    };
})];

The nixpkgs manual has more information on this.

How do I solve <name> missing

When using NixVim it is possible to encounter an error of the type attribute 'name' missing, for example it could look like:

       (stack trace truncated; use '--show-trace' to show the full trace)

       error: attribute 'haskell-scope-highlighting-nvim' missing

       at /nix/store/k897af00nzlz4ylxr5vakzpcvh6m3rnn-source/plugins/languages/haskell-scope-highlighting.nix:12:22:

           11|     originalName = "haskell-scope-highlighting.nvim";
           12|     defaultPackage = pkgs.vimPlugins.haskell-scope-highlighting-nvim;
             |                      ^
           13|

This usually means one of two things:

  • The nixpkgs version is not in line with NixVim (for example nixpkgs nixos-24.05 is used with NixVim master)
  • The nixpkgs unstable version used with NixVim is not recent enough.

How do I create multiple aliases for a single keymap

You could use the builtin map function (or similar) to do something like this:

keymaps =
  (builtins.map (key: {
    inherit key;
    action = "<some-action>";
    options.desc = "My cool keymapping";
  }) ["<key-1>" "<key-2>" "<key-3>"])
  ++ [
    # Other keymaps...
  ];

This maps a list of keys into a list of similar keymaps. It is equivalent to:

keymaps = [
  {
    key = "<key-1>";
    action = "<some-action>";
    options.desc = "My cool keymapping";
  }
  {
    key = "<key-2>";
    action = "<some-action>";
    options.desc = "My cool keymapping";
  }
  {
    key = "<key-3>";
    action = "<some-action>";
    options.desc = "My cool keymapping";
  }
  # Other keymaps...
];

User configurations

Want some help with starting your configuration? Or maybe you're curious how others have done things? Take a look at these configuration examples below.

Note:
Most of those configurations are using a standalone build, however, all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).

ConfigComment
ahwxorg/nixvim-config
alisonjenkins/neovim-nix-flake
elythh/nixvim
GaetanLepage/nix-configHome-manager
gwg313/nvim-nix
hbjydev/hvim
MikaelFangel/nixvim-configAn easy-setup configuration for NixVim, focused on straightforward customization
nicolas-goudry/nixvim-configHeavily inspired by AstroNvim
pete3n/nixvim-flake
redyf/NeveMeticulously crafted custom configuration for Nixvim
siph/nixvim-flake
Tanish2002/neovim-config
traxys/Nixfiles

Share your config !

To add a configuration to this list, either:

Home Manager Usage

All nixvim options are available at programs.nixvim.* when nixvim is used in home-manager. There are a few home-manager specific options that are documented here.

enable

Whether to enable nixvim.

Type: boolean

Default: false

Example: true

defaultEditor

Whether to enable nixvim as the default editor.

Type: boolean

Default: false

Example: true

vimdiffAlias

Alias vimdiff to nvim -d.

Type: boolean

Default: false

Standalone Usage

Options

When used standalone, nixvim's options are available directly, without any prefix/namespace. This is unlike the other modules which typically use a programs.nixvim.* prefix.

There are no standalone-specific options available.

Using in another configuration

Here is an example on how to integrate into a NixOS or Home-manager configuration when using flakes.

The example assumes your standalone config is the default package of a flake, and you've named the input "nixvim-config".

{ inputs, system, ... }:
{
  # NixOS
  environment.systemPackages = [ inputs.nixvim-config.packages.${system}.default ];
  # home-manager
  home.packages = [ inputs.nixvim-config.packages.${system}.default ];
}

Extending an existing configuration

Given a nvim derivation obtained from makeNixvim or makeNivxmiWithModule it is possible to create a new derivation with additional options.

This is done through the nvim.nixvimExtend function. This function takes a NixOS module that is going to be merged with the currently set options.

This attribute is recursive, meaning that it can be applied an arbitrary number of times.

Example

{makeNixvimWithModule}: let
    first = makeNixvimWithModule {
        module = {
            extraConfigLua = "-- first stage";
        };
    };

    second = first.nixvimExtend {extraConfigLua = "-- second stage";};
    
    third = second.nixvimExtend {extraConfigLua = "-- third stage";};
in
    third

This will generate a init.lua that will contain the three comments from each stages.

Accessing options used in an existing configuration

The config used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to nixvimExtend.

This may be useful if you want unrelated parts of your NixOS or home-manager configuration to use the same value as something in your nixvim configuration.

Accessing nixvim options

Given a nixvim derivation it is possible to access the module options using <derivation>.options. This can be useful to configure nixd for example:

plugins.lsp.servers.nixd = {
    enable = true;
    settings = {
        options.nixvim.expr = ''(builtins.getFlake "/path/to/flake").packages.${system}.neovimNixvim.options'';
    };
};

enableMan

Install the man pages for NixVim options.

Type: boolean

Default: true

Declared by:

package

Neovim to use for NixVim.

Type: package

Default: <derivation neovim-unwrapped-0.9.5>

Declared by:

colorscheme

The name of the colorscheme to use

Type: null or string

Default: null

Declared by:

extraConfigLua

Extra contents for the file

Type: strings concatenated with “\n”

Default: ""

Declared by:

extraConfigLuaPost

Extra contents for the file after everything else

Type: strings concatenated with “\n”

Default: ""

Declared by:

extraConfigLuaPre

Extra contents for the file before everything else

Type: strings concatenated with “\n”

Default: ""

Declared by:

extraConfigVim

Extra contents for the file, in vimscript

Type: strings concatenated with “\n”

Default: ""

Declared by:

extraFiles

Extra files to add to the runtime path

Type: attribute set of string

Default: { }

Declared by:

extraLuaPackages

Extra lua packages to include with neovim

Type: function that evaluates to a(n) list of package

Default: <function>

Declared by:

extraPackages

Extra packages to be made available to neovim

Type: list of (null or package)

Default: [ ]

Declared by:

extraPlugins

List of vim plugins to install

Type: list of (package or (submodule))

Default: [ ]

Declared by:

extraPython3Packages

Python packages to add to the PYTHONPATH of neovim.

Type: function that evaluates to a(n) list of package

Default: p: with p; [ ]

Example:

p: [ p.numpy ]

Declared by:

files

Extra files to add to the runtimepath

Type: attribute set of nixvim configuration options

Example:

{
  "ftplugin/nix.lua" = {
    options = {
      expandtab = true;
      shiftwidth = 2;
      tabstop = 2;
    };
  };
}

Declared by:

finalPackage

Wrapped Neovim.

Type: package (read only)

Declared by:

globalOpts

The configuration global options (vim.opt_global.*)

Type: attribute set of anything

Default: { }

Declared by:

globals

Global variables (vim.g.*)

Type: attribute set of anything

Default: { }

Declared by:

localOpts

The configuration local options (vim.opt_local.*)

Type: attribute set of anything

Default: { }

Declared by:

match

Define match groups

Type: attribute set of string

Default: { }

Example:

''
  match = {
    ExtraWhitespace = "\\s\\+$";
  };
''

Declared by:

opts

The configuration options, e.g. line numbers (vim.opt.*)

Type: attribute set of anything

Default: { }

Declared by:

path

Path of the file relative to the config directory

Type: string

Declared by:

type

Whether the generated file is a vim or a lua file

Type: one of “vim”, “lua”

Default: "lua"

Declared by:

viAlias

Symlink vi to nvim binary.

Type: boolean

Default: false

Declared by:

vimAlias

Symlink vim to nvim binary.

Type: boolean

Default: false

Declared by:

withNodeJs

Enable Node provider.

Type: boolean

Default: false

Declared by:

withRuby

Enable Ruby provider.

Type: boolean

Default: true

Declared by:

wrapRc

Should the config be included in the wrapper script.

Type: boolean

Default: false

Declared by:

autoCmd

autocmd definitions

Type: list of (submodule)

Default: [ ]

Example:

''
  autoCmd = [
    {
      event = [ "BufEnter" "BufWinEnter" ];
      pattern = [ "*.c" "*.h" ];
      command = "echo 'Entering a C or C++ file'";
    }
  ];
''

Declared by:

autoCmd.*.buffer

Buffer number for buffer local autocommands |autocmd-buflocal|. Cannot be used with pattern.

Type: null or signed integer

Default: null

Declared by:

autoCmd.*.callback

A function or a string.

  • if a string, the name of a Vimscript function to call when this autocommand is triggered.

  • Otherwise, a Lua function which is called when this autocommand is triggered. Cannot be used with command. Lua callbacks can return true to delete the autocommand; in addition, they accept a single table argument with the following keys:

    • id: (number) the autocommand id
    • event: (string) the name of the event that triggered the autocommand |autocmd-events|
    • group: (number|nil) the autocommand group id, if it exists
    • match: (string) the expanded value of |<amatch>|
    • buf: (number) the expanded value of |<abuf>|
    • file: (string) the expanded value of |<afile>|
    • data: (any) arbitrary data passed to |nvim_exec_autocmds()|

Example using callback: autoCmd = [ { event = [ “BufEnter” “BufWinEnter” ]; pattern = [ “.c" ".h” ]; callback = { __raw = “function() print(‘This buffer enters’) end”; }; }

Type: null or string or raw lua code

Default: null

Declared by:

autoCmd.*.command

Vim command to execute on event. Cannot be used with callback.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

autoCmd.*.desc

A textual description of this autocommand.

Type: null or string

Default: null

Declared by:

autoCmd.*.description

DEPRECATED, please use desc.

Type: null or string

Default: null

Declared by:

autoCmd.*.event

The event or events to register this autocommand.

Type: null or string or list of string

Default: null

Declared by:

autoCmd.*.group

The autocommand group name or id to match against.

Type: null or string or signed integer

Default: null

Declared by:

autoCmd.*.nested

Run nested autocommands.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

autoCmd.*.once

Run the autocommand only once.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

autoCmd.*.pattern

Pattern or patterns to match literally against.

Type: null or string or list of string

Default: null

Declared by:

autoGroups

augroup definitions

Type: attribute set of (submodule)

Default: { }

Example:

''
  autoGroups = {
    my_augroup = {
      clear = true;
    }
  };
''

Declared by:

autoGroups.<name>.clear

Clear existing commands if the group already exists.

Type: boolean

Default: true

Declared by:

editorconfig.enable

editorconfig plugin for neovim

Type: boolean

Default: true

Declared by:

editorconfig.properties

The table key is a property name and the value is a callback function which accepts the number of the buffer to be modified, the value of the property in the .editorconfig file, and (optionally) a table containing all of the other properties and their values (useful for properties which depend on other properties). The value is always a string and must be coerced if necessary.

Type: attribute set of string

Default: { }

Example:

{
  foo = ''
    function(bufnr, val, opts)
      if opts.charset and opts.charset ~= "utf-8" then
        error("foo can only be set when charset is utf-8", 0)
      end
      vim.b[bufnr].foo = val
    end
  '';
}

Declared by:

filetype

Define additional filetypes. The values can either be a literal filetype or a function taking the filepath and the buffer number.

For more information check :h vim.filetype.add()

Type: null or (submodule)

Default: null

Declared by:

filetype.extension

set filetypes matching the file extension

Type: null or (attribute set of (string or raw lua code or list of (string or (submodule))))

Default: null

Declared by:

filetype.filename

set filetypes matching the file name (or path)

Type: null or (attribute set of (string or raw lua code or list of (string or (submodule))))

Default: null

Declared by:

filetype.pattern

set filetypes matching the specified pattern

Type: null or (attribute set of (string or raw lua code or list of (string or (submodule))))

Default: null

Declared by:

highlight

Define new highlight groups

Type: attribute set of (attribute set)

Default: { }

Example:

''
  highlight = {
    MacchiatoRed.fg = "#ed8796";
  };
''

Declared by:

highlight.<name>.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

highlight.<name>.bold

Type: null or boolean

Default: null

Declared by:

highlight.<name>.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

highlight.<name>.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

highlight.<name>.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.nocombine

Type: null or boolean

Default: null

Declared by:

highlight.<name>.reverse

Type: null or boolean

Default: null

Declared by:

highlight.<name>.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlight.<name>.standout

Type: null or boolean

Default: null

Declared by:

highlight.<name>.strikethrough

Type: null or boolean

Default: null

Declared by:

highlight.<name>.undercurl

Type: null or boolean

Default: null

Declared by:

highlight.<name>.underdashed

Type: null or boolean

Default: null

Declared by:

highlight.<name>.underdotted

Type: null or boolean

Default: null

Declared by:

highlight.<name>.underdouble

Type: null or boolean

Default: null

Declared by:

highlight.<name>.underline

Type: null or boolean

Default: null

Declared by:

highlightOverride

Define highlight groups to override existing highlight

Type: attribute set of (attribute set)

Default: { }

Example:

''
  highlight = {
    Comment.fg = "#ff0000";
  };
''

Declared by:

highlightOverride.<name>.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

highlightOverride.<name>.bold

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

highlightOverride.<name>.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.nocombine

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.reverse

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

highlightOverride.<name>.standout

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.strikethrough

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.undercurl

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.underdashed

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.underdotted

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.underdouble

Type: null or boolean

Default: null

Declared by:

highlightOverride.<name>.underline

Type: null or boolean

Default: null

Declared by:

luaLoader.enable

Whether to enable/disable the experimental lua loader:

If true: Enables the experimental Lua module loader:

  • overrides loadfile
  • adds the lua loader using the byte-compilation cache
  • adds the libs loader
  • removes the default Neovim loader

If false: Disables the experimental Lua module loader:

  • removes the loaders
  • adds the default Neovim loader

Type: boolean

Default: false

Declared by:

userCommands

A list of user commands to add to the configuration.

Type: attribute set of (submodule)

Default: { }

Declared by:

userCommands.<name>.addr

Whether special characters relate to other things, see :h command-addr.

Type: null or string

Default: null

Declared by:

userCommands.<name>.bang

Whether this command can take a bang (!).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.bar

Whether this command can be followed by a “|” and another command.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.command

The command to run.

Type: string or raw lua code

Declared by:

userCommands.<name>.complete

Tab-completion behaviour, see :h command-complete.

Type: null or string or raw lua code

Default: null

Declared by:

userCommands.<name>.count

Whether the command accepts a count, see :h command-range.

Type: null or boolean or signed integer

Default: null

Declared by:

userCommands.<name>.desc

A description of the command.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

userCommands.<name>.force

Overwrite an existing user command.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.keepscript

Do not use the location of where the user command was defined for verbose messages, use the location of where the command was invoked.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.nargs

The number of arguments to expect, see :h command-nargs.

Type: null or one of 0, 1, “*”, “?”, “+”

Default: null

Declared by:

userCommands.<name>.range

Whether the command accepts a range, see :h command-range.

Type: null or boolean or signed integer or value “%” (singular enum)

Default: null

Declared by:

userCommands.<name>.register

The first argument to the command can be an optional register.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

clipboard.register

Sets the register to use for the clipboard. Learn more in :h 'clipboard'.

Type: null or string or list of string

Default: null

Example: "unnamedplus"

Declared by:

clipboard.providers

Package(s) to use as the clipboard provider. Learn more at :h clipboard.

Type: submodule

Default: { }

Declared by:

clipboard.providers.wl-copy.enable

Whether to enable wl-copy.

Type: boolean

Default: false

Example: true

Declared by:

clipboard.providers.wl-copy.package

The wl-clipboard package to use.

Type: package

Default: pkgs.wl-clipboard

Declared by:

clipboard.providers.xclip.enable

Whether to enable xclip.

Type: boolean

Default: false

Example: true

Declared by:

clipboard.providers.xclip.package

The xclip package to use.

Type: package

Default: pkgs.xclip

Declared by:

clipboard.providers.xsel.enable

Whether to enable xsel.

Type: boolean

Default: false

Example: true

Declared by:

clipboard.providers.xsel.package

The xsel package to use.

Type: package

Default: pkgs.xsel

Declared by:

ayu

Url: https://github.com/Shatur/neovim-ayu/

Maintainers: Gaetan Lepage

colorschemes.ayu.enable

Whether to enable neovim-ayu.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.ayu.package

Which package to use for the neovim-ayu plugin.

Type: package

Default: <derivation vimplugin-neovim-ayu-2024-04-05>

Declared by:

colorschemes.ayu.settings

Options provided to the require('ayu').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

colorschemes.ayu.settings.mirage

Set to true to use mirage variant instead of dark for dark background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.ayu.settings.overrides

A dictionary of group names, each associated with a dictionary of parameters (bg, fg, sp and style) and colors in hex.

Alternatively, overrides can be a function that returns a dictionary of the same format. You can use the function to override based on a dynamic condition, such as the value of background.

Plugin default: {}

Type: null or lua code string or attribute set of (attribute set)

Default: null

Declared by:

base16

Url: https://github.com/RRethy/base16-nvim/

Maintainers: Gaetan Lepage

colorschemes.base16.enable

Whether to enable base16.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.base16.package

Which package to use for the base16 plugin.

Type: package

Default: <derivation vimplugin-base16-nvim-2024-04-18>

Declared by:

colorschemes.base16.colorscheme

The base16 colorscheme to use. It can either be the name of a builtin colorscheme or an attrs specifying each color explicitly.

Example for the latter:

  {
    base00 = "#16161D";
    base01 = "#2c313c";
    base02 = "#3e4451";
    base03 = "#6c7891";
    base04 = "#565c64";
    base05 = "#abb2bf";
    base06 = "#9a9bb3";
    base07 = "#c5c8e6";
    base08 = "#e06c75";
    base09 = "#d19a66";
    base0A = "#e5c07b";
    base0B = "#98c379";
    base0C = "#56b6c2";
    base0D = "#0184bc";
    base0E = "#c678dd";
    base0F = "#a06949";
  }

Type: one of “3024”, “apathy”, “apprentice”, “ashes”, “atelier-cave”, “atelier-cave-light”, “atelier-dune”, “atelier-dune-light”, “atelier-estuary”, “atelier-estuary-light”, “atelier-forest”, “atelier-forest-light”, “atelier-heath”, “atelier-heath-light”, “atelier-lakeside”, “atelier-lakeside-light”, “atelier-plateau”, “atelier-plateau-light”, “atelier-savanna”, “atelier-savanna-light”, “atelier-seaside”, “atelier-seaside-light”, “atelier-sulphurpool”, “atelier-sulphurpool-light”, “atlas”, “ayu-dark”, “ayu-light”, “ayu-mirage”, “bespin”, “black-metal”, “black-metal-bathory”, “black-metal-burzum”, “black-metal-dark-funeral”, “black-metal-gorgoroth”, “black-metal-immortal”, “black-metal-khold”, “black-metal-marduk”, “black-metal-mayhem”, “black-metal-nile”, “black-metal-venom”, “blueforest”, “blueish”, “brewer”, “bright”, “brogrammer”, “brushtrees”, “brushtrees-dark”, “catppuccin”, “catppuccin-frappe”, “catppuccin-latte”, “catppuccin-macchiato”, “catppuccin-mocha”, “chalk”, “circus”, “classic-dark”, “classic-light”, “codeschool”, “colors”, “cupcake”, “cupertino”, “da-one-black”, “da-one-gray”, “da-one-ocean”, “da-one-paper”, “da-one-sea”, “da-one-white”, “danqing”, “darcula”, “darkmoss”, “darktooth”, “darkviolet”, “decaf”, “default-dark”, “default-light”, “dirtysea”, “dracula”, “edge-dark”, “edge-light”, “eighties”, “embers”, “emil”, “equilibrium-dark”, “equilibrium-gray-dark”, “equilibrium-gray-light”, “equilibrium-light”, “espresso”, “eva”, “eva-dim”, “evenok-dark”, “everforest”, “flat”, “framer”, “fruit-soda”, “gigavolt”, “github”, “google-dark”, “google-light”, “gotham”, “grayscale-dark”, “grayscale-light”, “greenscreen”, “gruber”, “gruvbox-dark-hard”, “gruvbox-dark-medium”, “gruvbox-dark-pale”, “gruvbox-dark-soft”, “gruvbox-light-hard”, “gruvbox-light-medium”, “gruvbox-light-soft”, “gruvbox-material-dark-hard”, “gruvbox-material-dark-medium”, “gruvbox-material-dark-soft”, “gruvbox-material-light-hard”, “gruvbox-material-light-medium”, “gruvbox-material-light-soft”, “hardcore”, “harmonic-dark”, “harmonic-light”, “heetch”, “heetch-light”, “helios”, “hopscotch”, “horizon-dark”, “horizon-light”, “horizon-terminal-dark”, “horizon-terminal-light”, “humanoid-dark”, “humanoid-light”, “ia-dark”, “ia-light”, “icy”, “irblack”, “isotope”, “kanagawa”, “katy”, “kimber”, “lime”, “macintosh”, “marrakesh”, “materia”, “material”, “material-darker”, “material-lighter”, “material-palenight”, “material-vivid”, “mellow-purple”, “mexico-light”, “mocha”, “monokai”, “mountain”, “nebula”, “nord”, “nova”, “ocean”, “oceanicnext”, “one-light”, “onedark”, “outrun-dark”, “pandora”, “papercolor-dark”, “papercolor-light”, “paraiso”, “pasque”, “phd”, “pico”, “pinky”, “pop”, “porple”, “primer-dark”, “primer-dark-dimmed”, “primer-light”, “purpledream”, “qualia”, “railscasts”, “rebecca”, “rose-pine”, “rose-pine-dawn”, “rose-pine-moon”, “sagelight”, “sakura”, “sandcastle”, “seti”, “shades-of-purple”, “shadesmear-dark”, “shadesmear-light”, “shapeshifter”, “silk-dark”, “silk-light”, “snazzy”, “solarflare”, “solarflare-light”, “solarized-dark”, “solarized-light”, “spaceduck”, “spacemacs”, “standardized-dark”, “standardized-light”, “stella”, “still-alive”, “summercamp”, “summerfruit-dark”, “summerfruit-light”, “synth-midnight-dark”, “synth-midnight-light”, “tango”, “tender”, “tokyo-city-dark”, “tokyo-city-light”, “tokyo-city-terminal-dark”, “tokyo-city-terminal-light”, “tokyo-night-dark”, “tokyo-night-light”, “tokyo-night-storm”, “tokyo-night-terminal-dark”, “tokyo-night-terminal-light”, “tokyo-night-terminal-storm”, “tokyodark”, “tokyodark-terminal”, “tomorrow”, “tomorrow-night”, “tomorrow-night-eighties”, “tube”, “twilight”, “unikitty-dark”, “unikitty-light”, “unikitty-reversible”, “uwunicorn”, “vice”, “vulcan”, “windows-10”, “windows-10-light”, “windows-95”, “windows-95-light”, “windows-highcontrast”, “windows-highcontrast-light”, “windows-nt”, “windows-nt-light”, “woodland”, “xcode-dusk”, “zenburn” or (submodule)

Example: "edge-light"

Declared by:

colorschemes.base16.setUpBar

Whether to set your status bar theme to ‘base16’.

Type: boolean

Default: true

Declared by:

catppuccin

Url: https://github.com/catppuccin/nvim/

Maintainers: Gaetan Lepage

colorschemes.catppuccin.enable

Whether to enable catppuccin.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.catppuccin.package

Which package to use for the catppuccin plugin.

Type: package

Default: <derivation vimplugin-catppuccin-nvim-2024-05-08>

Declared by:

colorschemes.catppuccin.settings

Options provided to the require('catppuccin').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  color_overrides = {
    mocha = {
      base = "#1e1e2f";
    };
  };
  disable_underline = true;
  flavour = "mocha";
  integrations = {
    cmp = true;
    gitsigns = true;
    mini = {
      enabled = true;
      indentscope_color = "";
    };
    notify = false;
    nvimtree = true;
    treesitter = true;
  };
  styles = {
    booleans = [
      "bold"
      "italic"
    ];
    conditionals = [
      "bold"
    ];
  };
  term_colors = true;
}

Declared by:

colorschemes.catppuccin.settings.compile_path

Set the compile cache directory.

Plugin default: "{__raw = \"vim.fn.stdpath 'cache' .. '/catppuccin'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.custom_highlights

Override specific highlight groups to use other groups or a hex color. You can provide either a lua function or directly an attrs.

Example:

  function(colors)
    return {
      Comment = { fg = colors.flamingo },
      ["@constant.builtin"] = { fg = colors.peach, style = {} },
      ["@comment"] = { fg = colors.surface2, style = { "italic" } },
    }
  end

Default: {}

Type: null or lua function string or attribute set of anything

Default: null

Declared by:

colorschemes.catppuccin.settings.default_integrations

Some integrations are enabled by default, you can control this behaviour with this option.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.flavour

Theme flavour.

Type: null or one of “latte”, “mocha”, “frappe”, “macchiato”, “auto”

Default: null

Declared by:

colorschemes.catppuccin.settings.integrations

Catppuccin provides theme support for other plugins in the Neovim ecosystem and extended Neovim functionality through integrations.

To enable/disable an integration you just need to set it to true/false.

Example:

  {
    cmp = true;
    gitsigns = true;
    nvimtree = true;
    treesitter = true;
    notify = false;
    mini = {
      enabled = true;
      indentscope_color = "";
    };
  }

Default: see plugin source.

Type: null or (attribute set of anything)

Default: null

Declared by:

colorschemes.catppuccin.settings.no_bold

Force no bold.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.no_italic

Force no italic.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.no_underline

Force no underline.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.show_end_of_buffer

Show the ‘~’ characters after the end of buffers.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.term_colors

Configure the colors used when opening a :terminal in Neovim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.transparent_background

Enable Transparent background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.background.dark

Background for dark background.

Plugin default: "latte"

Type: null or one of “latte”, “mocha”, “frappe”, “macchiato” or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.background.light

Background for light background.

Plugin default: "latte"

Type: null or one of “latte”, “mocha”, “frappe”, “macchiato” or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.color_overrides.all

Override colors for all the flavours.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.color_overrides.frappe

Override colors for the frappe flavour.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.color_overrides.latte

Override colors for the latte flavour.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.color_overrides.macchiato

Override colors for the macchiato flavour.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.color_overrides.mocha

Override colors for the mocha flavour.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.dim_inactive.enabled

If true, dims the background color of inactive window or buffer or split.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.dim_inactive.percentage

percentage of the shade to apply to the inactive window, split or buffer.

Plugin default: 0.15

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

colorschemes.catppuccin.settings.dim_inactive.shade

Sets the shade to apply to the inactive split or window or buffer.

Plugin default: "dark"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.booleans

Define booleans highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.comments

Define comments highlight properties.

Plugin default: ["italic"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.conditionals

Define conditionals highlight properties.

Plugin default: ["italic"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.functions

Define functions highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.keywords

Define keywords highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.loops

Define loops highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.numbers

Define numbers highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.operators

Define operators highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.properties

Define properties highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.strings

Define strings highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.types

Define types highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.catppuccin.settings.styles.variables

Define variables highlight properties.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

cyberdream

Url: https://github.com/scottmckendry/cyberdream.nvim/

Maintainers: Andres Bermeo Marinelli

colorschemes.cyberdream.enable

Whether to enable cyberdream.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.cyberdream.package

Which package to use for the cyberdream.nvim plugin.

Type: package

Default: <derivation vimplugin-cyberdream.nvim-2024-05-15>

Declared by:

colorschemes.cyberdream.settings

Options provided to the require('cyberdream').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  borderless_telescope = true;
  hide_fillchars = true;
  italic_comments = true;
  terminal_colors = true;
  theme = {
    colors = {
      bg = "#000000";
      green = "#00ff00";
      magenta = "#ff00ff";
    };
    highlights = {
      Comment = {
        bg = "NONE";
        fg = "#696969";
        italic = true;
      };
    };
  };
  transparent = true;
}

Declared by:

colorschemes.cyberdream.settings.borderless_telescope

Modern borderless telescope theme.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.cyberdream.settings.hide_fillchars

Replace all fillchars with ’ ’ for the ultimate clean look.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.cyberdream.settings.italic_comments

Enable italics comments.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.cyberdream.settings.terminal_colors

Set terminal colors used in :terminal.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.cyberdream.settings.transparent

Enable transparent background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.cyberdream.settings.theme.colors

Override the default colors used.

For a full list of colors, see upstream documentation.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.cyberdream.settings.theme.highlights

Highlight groups to override, adding new groups is also possible. See :h highlight-groups for a list of highlight groups.

Example:

{
  Comment = {
    fg = "#696969";
    bg = "NONE";
    italic = true;
  };
}

Complete list can be found in lua/cyberdream/theme.lua in upstream repository.

Plugin default: {}

Type: null or (attribute set of ((attribute set) or raw lua code))

Default: null

Declared by:

colorschemes.dracula.enable

Whether to enable dracula.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.dracula.package

Which package to use for the dracula plugin.

Type: package

Default: <derivation vimplugin-dracula-vim-2024-04-14>

Declared by:

colorschemes.dracula.bold

Include bold attributes in highlighting

Type: boolean

Default: true

Declared by:

colorschemes.dracula.colorterm

Include background fill colors

Type: boolean

Default: true

Declared by:

colorschemes.dracula.fullSpecialAttrsSupport

Explicitly declare full support for special attributes. On terminal emulators, set to 1 to allow underline/undercurl highlights without changing the foreground color

Type: boolean

Default: false

Declared by:

colorschemes.dracula.highContrastDiff

Use high-contrast color when in diff mode

Type: boolean

Default: false

Declared by:

colorschemes.dracula.inverse

Include inverse attributes in highlighting

Type: boolean

Default: true

Declared by:

colorschemes.dracula.italic

Include italic attributes in highlighting

Type: boolean

Default: true

Declared by:

colorschemes.dracula.undercurl

Include undercurl attributes in highlighting (only if underline enabled)

Type: boolean

Default: true

Declared by:

colorschemes.dracula.underline

Include underline attributes in highlighting

Type: boolean

Default: true

Declared by:

gruvbox

Url: https://github.com/ellisonleao/gruvbox.nvim/

Maintainers: Gaetan Lepage

colorschemes.gruvbox.enable

Whether to enable gruvbox.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.gruvbox.package

Which package to use for the gruvbox.nvim plugin.

Type: package

Default: <derivation vimplugin-gruvbox.nvim-2024-05-07>

Declared by:

colorschemes.gruvbox.settings

Options provided to the require('gruvbox').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  palette_overrides = {
    bright_blue = "#5476b2";
    bright_purple = "#fb4934";
    dark1 = "#323232";
    dark2 = "#383330";
    dark3 = "#323232";
  };
  terminal_colors = true;
}

Declared by:

kanagawa

You can select the theme in two ways:

  • Set colorschemes.kanagawa.settings.theme AND explicitly unset vim.o.background (i.e. options.background = "").
  • Set colorschemes.kanagawa.settings.background (the active theme will depend on the value of vim.o.background).

Url: https://github.com/rebelot/kanagawa.nvim/

Maintainers: Gaetan Lepage

colorschemes.kanagawa.enable

Whether to enable kanagawa.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.kanagawa.package

Which package to use for the kanagawa.nvim plugin.

Type: package

Default: <derivation vimplugin-kanagawa.nvim-2024-04-29>

Declared by:

colorschemes.kanagawa.settings

Options provided to the require('kanagawa').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  colors = {
    palette = {
      fujiWhite = "#FFFFFF";
      sumiInk0 = "#000000";
    };
    theme = {
      all = {
        ui = {
          bg_gutter = "none";
        };
      };
      dragon = {
        syn = {
          parameter = "yellow";
        };
      };
      wave = {
        ui = {
          float = {
            bg = "none";
          };
        };
      };
    };
  };
  commentStyle = {
    italic = true;
  };
  compile = false;
  dimInactive = false;
  functionStyle = { };
  overrides = "function(colors) return {} end";
  terminalColors = true;
  theme = "wave";
  transparent = false;
  undercurl = true;
}

Declared by:

colorschemes.kanagawa.settings.commentStyle

Highlight options for comments.

Plugin default: {italic = true;}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.compile

Enable compiling the colorscheme.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.dimInactive

Whether dim inactive window :h hl-NormalNC.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.functionStyle

Highlight options for functions.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.keywordStyle

Highlight options for keywords.

Plugin default: {italic = true;}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.overrides

The body of a function that add/modify hihlights. It takes as input a colors argument which is a table of this form:

  colors = {
    palette = {
      foo = "#RRGGBB",
      bar = "#RRGGBB"
    },
    theme = {
      foo = "#RRGGBB",
      bar = "#RRGGBB"
    }
  }

It should return a table of highlights.

  function(colors)
    CONTENT_OF_OVERRIDE_OPTION
  end

Plugin default:

function(colors)
  return {}
end

Type: null or lua function string

Default: null

Declared by:

colorschemes.kanagawa.settings.statementStyle

Highlight options for statements.

Plugin default: {bold = true;}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.terminalColors

If true, defines vim.g.terminal_color_{0,17}.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.theme

The theme to load when background is not set.

Plugin default: "wave"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.transparent

Whether to set a background color.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.typeStyle

Highlight options for types.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.undercurl

Enable undercurls.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.background.dark

The theme to use when vim.o.background = "dark".

Plugin default: "wave"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.background.light

The theme to use when vim.o.background = "light".

Plugin default: "lotus"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.kanagawa.settings.colors.palette

Change all usages of these colors.

Example:

  {
    sumiInk0 = "#000000";
    fujiWhite = "#FFFFFF";
  }

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.kanagawa.settings.colors.theme

Change specific usages for a certain theme, or for all of them

Example:

  {
    wave = {
      ui = {
          float = {
              bg = "none";
          };
      };
    };
    dragon = {
        syn = {
            parameter = "yellow";
        };
    };
    all = {
        ui = {
            bg_gutter = "none";
        };
    };
  }

Plugin default:

{
  wave = {};
  lotus = {};
  dragon = {};
  all = {};
}

Type: null or (attribute set of ((attribute set) or raw lua code))

Default: null

Declared by:

melange

Url: https://github.com/savq/melange-nvim/

Maintainers: Gaetan Lepage

colorschemes.melange.enable

Whether to enable melange-nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.melange.package

Which package to use for the melange plugin.

Type: package

Default: <derivation vimplugin-melange-nvim-2024-03-30>

Declared by:

modus

Url: https://github.com/miikanissi/modus-themes.nvim/

Maintainers: Nate Smith

colorschemes.modus.enable

Whether to enable modus-themes.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.modus.package

Which package to use for the modus-themes.nvim plugin.

Type: package

Default: <derivation vimplugin-modus-themes.nvim-2024-05-14>

Declared by:

colorschemes.modus.settings

Options provided to the require('modus').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  dim_inactive = false;
  on_colors = "function(colors) end";
  on_highlights = "function(highlights, colors) end";
  style = "auto";
  styles = {
    comments = {
      italic = true;
    };
    functions = { };
    keywords = {
      italic = true;
    };
    variables = { };
  };
  transparent = false;
  variant = "default";
}

Declared by:

colorschemes.modus.settings.dim_inactive

Dims inactive windows.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.on_colors

Override specific color groups to use other groups or a hex color. Function will be called with a ColorScheme table.

@param colors ColorScheme

Plugin default: function(colors) end

Type: null or lua function string

Default: null

Declared by:

colorschemes.modus.settings.on_highlights

Override specific highlights to use other groups or a hex color. Function will be called with a Highlights and ColorScheme table.

@param highlights Highlights
@param colors ColorScheme

Plugin default: function(highlights, colors) end

Type: null or lua function string

Default: null

Declared by:

colorschemes.modus.settings.style

The theme comes in a light modus_operandi style and a dark modus_vivendi style.

Plugin default: "modus_operandi"

Type: null or one of “modus_operandi”, “modus_vivendi” or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.transparent

Disable setting the background color.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.variant

Styles come in four variants:

  • default is the plugin’s main style designed to cover a broad range of needs.
  • tinted tones down intensity and provides more color variety.
  • deuteranopia is optimized for users with red-green color deficiency.
  • tritanopia is optimized for users with blue-yellow color deficiency.

Plugin default: "default"

Type: null or one of “default”, “tinted”, “deuteranopia”, “tritanopia” or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments

Define comments highlight properties.

Plugin default: {italic = true;}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.comments.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions

Define functions highlight properties.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.functions.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords

Define keywords highlight properties.

Plugin default: {italic = true;}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.keywords.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables

Define variables highlight properties.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.modus.settings.styles.variables.underline

Type: null or boolean

Default: null

Declared by:

nightfox

Url: https://github.com/EdenEast/nightfox.nvim/

Maintainers: Gaetan Lepage

colorschemes.nightfox.enable

Whether to enable nightfox.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.nightfox.package

Which package to use for the nightfox.nvim plugin.

Type: package

Default: <derivation vimplugin-nightfox.nvim-2024-04-28>

Declared by:

colorschemes.nightfox.flavor

Which palette/flavor to use as the colorscheme.

Type: one of “carbonfox”, “dawnfox”, “dayfox”, “duskfox”, “nightfox”, “nordfox”, “terafox”

Default: "nightfox"

Example: "dayfox"

Declared by:

colorschemes.nightfox.settings

Options provided to the require('nightfox').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  groups = {
    all = {
      NormalNC = {
        bg = "inactive";
        fg = "fg1";
      };
    };
  };
  options = {
    colorblind = {
      enable = true;
      severity = {
        deutan = 0.6;
        protan = 0.3;
      };
    };
    inverse = {
      match_paren = false;
      search = true;
      visual = false;
    };
    modules = {
      coc = {
        background = false;
      };
      diagnostic = {
        background = false;
        enable = true;
      };
    };
    styles = {
      comments = "italic";
      functions = "italic,bold";
    };
    terminal_colors = true;
    transparent = true;
  };
  palettes = {
    duskfox = {
      bg0 = "#1d1d2b";
      bg1 = "#000000";
      bg3 = "#121820";
      sel0 = "#131b24";
    };
  };
  specs = {
    all = {
      inactive = "bg0";
    };
    duskfox = {
      inactive = "#090909";
    };
  };
}

Declared by:

colorschemes.nightfox.settings.groups

Groups are the highlight group definitions. The keys of this table are the name of the highlight groups that will be overridden. The value is a table with the following values:

  • fg, bg, style, sp, link,

Just like spec groups support templates. This time the template is based on a spec object.

Example:

  {
    all = {
      Whitespace.link = "Comment";
      IncSearch.bg = "palette.cyan";
    },
    nightfox.PmenuSel = {
      bg = "#73daca";
      fg = "bg0";
    };
  }

Type: null or (attribute set of attribute set of attribute set of string)

Default: null

Declared by:

colorschemes.nightfox.settings.palettes

A palette is the base color definitions of a style. Each style defines its own palette to be used by the other components. A palette defines base colors, as well as foreground and background shades. Along with the foreground and background colors a palette also defines other colors such as selection and comment colors.

The base colors are |nightfox-shade| objects that define a base, bright, and dim color. These base colors are: black, red, green, yellow, blue, magenta, cyan, white, orange, pink.

Example:

  {
    all = {
      red = "#ff0000";
    };
    nightfox = {
      red = "#c94f6d";
    };
    dayfox = {
      blue = {
        base = "#4d688e";
        bright = "#4e75aa";
        dim = "#485e7d";
      };
    };
    nordfox = {
      bg1 = "#2e3440";
      sel0 = "#3e4a5b";
      sel1 = "#4f6074";
      comment = "#60728a";
    };
  }

Type: null or (attribute set of attribute set of (string or attribute set of string))

Default: null

Declared by:

colorschemes.nightfox.settings.specs

Spec’s (specifications) are a mapping of palettes to logical groups that will be used by the groups. Some examples of the groups that specs map would be:

  • syntax groups (functions, types, keywords, …)
  • diagnostic groups (error, warning, info, hints)
  • git groups (add, removed, changed)

You can override these just like palettes.

Example:

  {
    all = {
      syntax = {
        keyword = "magenta";
        conditional = "magenta.bright";
        number = "orange.dim";
      };
      git = {
        changed = "#f4a261";
      };
    };
    nightfox = {
      syntax = {
        operator = "orange";
      };
    };
  }

Type: null or (attribute set of attribute set of (string or attribute set of string))

Default: null

Declared by:

colorschemes.nightfox.settings.options.compile_file_suffix

The string appended to the compiled file. Each style outputs to its own file. These files will append the suffix to the end of the file.

Plugin default: "_compiled"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.compile_path

The output directory path where the compiled results will be written to.

Plugin default: "{__raw = \"vim.fn.stdpath('cache') .. '/nightfox'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.dim_inactive

A boolean value that if set will set the background of Non current windows to be darker. See :h hl-NormalNC.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.inverse

A table that contains a list of highlight types. If a highlight type is enabled it will inverse the foreground and background colors instead of applying the normal highlight group. Thees highlight types are: match_paren, visual, search.

For an example if search is enabled instead of highlighting a search term with the default search color it will inverse the foureground and background colors.

Plugin default:

{
  match_paren = false;
  visual = false;
  search = false;
}

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

colorschemes.nightfox.settings.options.module_default

The default value of a module that has not been overridden in the modules table.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.modules

modules store configuration information for various plugins and other neovim modules. A module can either be a boolean or a table that contains additional configuration for that module. If the value is a table it also has a field called enable that will tell nightfox to load it. See |nightfox-modules| for more information.

By default modules will be enabled. To change this behaviour change options.module_default to false.

Plugin default:

{
  coc = {
    background = true;
  };
  diagnostic = {
    enable = true;
    background = true;
  };
  native_lsp = {
    enable = true;
    background = true;
  };
  treesitter = true;
  lsp_semantic_tokens = true;
  leap = {
    background = true;
  };
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

colorschemes.nightfox.settings.options.styles

A table that contains a list of syntax components and their corresponding style. These styles can be any combination of |highlight-args|. The list of syntax components are:

  • comments
  • conditionals
  • constants
  • functions
  • keywords
  • numbers
  • operators
  • preprocs
  • strings
  • types
  • variables

Example:

  {
    comments = "italic";
    functions = "italic,bold";
  }

Plugin default:

{
  comments = "NONE";
  conditionals = "NONE";
  constants = "NONE";
  functions = "NONE";
  keywords = "NONE";
  numbers = "NONE";
  operators = "NONE";
  preprocs = "NONE";
  strings = "NONE";
  types = "NONE";
  variables = "NONE";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.nightfox.settings.options.terminal_colors

A boolean value that if set will define the terminal colors for the builtin terminal (vim.g.terminal_color_*).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.transparent

A boolean value that if set will disable setting the background of Normal, NormalNC and other highlight groups. This lets you use the colors of the colorscheme but use the background of your terminal.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.colorblind.enable

Whether to enable nightfox’s color vision deficiency (cdv) mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.colorblind.simulate_only

Only show simulated colorblind colors and not diff shifted.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nightfox.settings.options.colorblind.severity.deutan

Severity [0, 1] for deutan (green).

Plugin default: 0

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

colorschemes.nightfox.settings.options.colorblind.severity.protan

Severity [0, 1] for protan (red).

Plugin default: 0

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

colorschemes.nightfox.settings.options.colorblind.severity.tritan

Severity [0, 1] for tritan (blue).

Plugin default: 0

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

nord

Url: https://github.com/shaunsingh/nord.nvim/

Maintainers: Gaetan Lepage

colorschemes.nord.enable

Whether to enable nord.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.nord.package

Which package to use for the nord plugin.

Type: package

Default: <derivation vimplugin-nord.nvim-2023-12-20>

Declared by:

colorschemes.nord.settings

The configuration options for nord without the nord_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal nord_foo_bar=1
  • hello = "world" -> :setglobal nord_hello="world"
  • some_toggle = true -> :setglobal nord_some_toggle
  • other_toggle = false -> :setglobal nonord_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  borders = true;
  disable_background = true;
  italic = false;
}

Declared by:

colorschemes.nord.settings.enable_sidebar_background

Re-enables the background of the sidebar if you disabled the background of everything.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.borders

Enable the border between vertically split windows.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.contrast

Make sidebars and popup menus like nvim-tree and telescope have a different background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.cursorline_transparent

Set the cursorline transparent/visible.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.disable_background

Disable the setting of background color so that NeoVim can use your terminal background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.italic

Enables/disables italics.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.nord.settings.uniform_diff_background

Enables/disables colorful backgrounds when used in diff mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

one

Url: https://github.com/rakr/vim-one/

Maintainers: Gaetan Lepage

colorschemes.one.enable

Whether to enable vim-one.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.one.package

Which package to use for the one plugin.

Type: package

Default: <derivation vimplugin-vim-one-2020-12-14>

Declared by:

colorschemes.one.settings

The configuration options for one without the one_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal one_foo_bar=1
  • hello = "world" -> :setglobal one_hello="world"
  • some_toggle = true -> :setglobal one_some_toggle
  • other_toggle = false -> :setglobal noone_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  allow_italics = true;
}

Declared by:

colorschemes.one.settings.allow_italics

Whether to enable italic (as long as your terminal supports it).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

onedark

Url: https://github.com/navarasu/onedark.nvim/

Maintainers: Gaetan Lepage

colorschemes.onedark.enable

Whether to enable onedark.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.onedark.package

Which package to use for the onedark.nvim plugin.

Type: package

Default: <derivation vimplugin-onedark.nvim-2024-05-11>

Declared by:

colorschemes.onedark.settings

Options provided to the require('onedark').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  colors = {
    bright_orange = "#ff8800";
    green = "#00ffaa";
  };
  highlights = {
    "@function" = {
      fg = "#0000ff";
      fmt = "underline,italic";
      sp = "$cyan";
    };
    "@function.builtin" = {
      fg = "#0059ff";
    };
    "@keyword" = {
      fg = "$green";
    };
    "@string" = {
      bg = "#00ff00";
      fg = "$bright_orange";
      fmt = "bold";
    };
  };
}

Declared by:

oxocarbon

Url: https://github.com/nyoom-engineering/oxocarbon.nvim/

Maintainers: Gaetan Lepage

colorschemes.oxocarbon.enable

Whether to enable oxocarbon.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.oxocarbon.package

Which package to use for the oxocarbon plugin.

Type: package

Default: <derivation vimplugin-oxocarbon.nvim-2023-11-27>

Declared by:

palette

Url: https://github.com/roobert/palette.nvim/

Maintainers: Gaetan Lepage

colorschemes.palette.enable

Whether to enable palette.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.palette.package

Which package to use for the palette.nvim plugin.

Type: package

Default: <derivation vimplugin-palette.nvim-2023-10-02>

Declared by:

colorschemes.palette.settings

Options provided to the require('palette').setup function.

Type: attribute set of anything

Default: { }

Example: { }

Declared by:

colorschemes.palette.settings.cache_dir

Cache directory.

Plugin default: "{__raw = \"vim.fn.stdpath('cache') .. '/palette'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.caching

Whether to enable caching.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.italics

Whether to use italics.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.transparent_background

Whether to use transparent background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.customPalettes.accent

Custom palettes for accent colors.

Plugin default: {}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

colorschemes.palette.settings.customPalettes.main

Custom palettes for main colors.

Plugin default: {}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

colorschemes.palette.settings.customPalettes.state

Custom palettes for state colors.

Plugin default: {}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

colorschemes.palette.settings.palettes.accent

Palette for the accent colors.

Plugin default: "pastel"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.palettes.main

Palette for the main colors.

Plugin default: "dark"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.palette.settings.palettes.state

Palette for the state colors.

Plugin default: "pastel"

Type: null or string or raw lua code

Default: null

Declared by:

poimandres

Url: https://github.com/olivercederborg/poimandres.nvim/

Maintainers: Gaetan Lepage

colorschemes.poimandres.enable

Whether to enable poimandres.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.poimandres.package

Which package to use for the poimandres.nvim plugin.

Type: package

Default: <derivation vimplugin-poimandres.nvim-2023-08-16>

Declared by:

colorschemes.poimandres.settings

Options provided to the require('poimandres').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  bold_vert_split = false;
  dim_nc_background = true;
  disable_background = false;
  disable_float_background = false;
  disable_italics = true;
}

Declared by:

colorschemes.poimandres.settings.bold_vert_split

Use bold vertical separators.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.dark_variant

Dark variant.

Plugin default: "main"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.dim_nc_background

Dim ‘non-current’ window backgrounds.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.disable_background

Whether to disable the background.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.disable_float_background

Whether to disable the background for floats.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.disable_italics

Whether to disable italics.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.poimandres.settings.groups

Which color to use for each group.

default: see source

Type: null or (attribute set of (string or attribute set of string))

Default: null

Declared by:

colorschemes.poimandres.settings.highlight_groups

Highlight groups.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

rose-pine

Url: https://github.com/rose-pine/neovim/

Maintainers: Gaetan Lepage

colorschemes.rose-pine.enable

Whether to enable rose-pine.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.rose-pine.package

Which package to use for the rose-pine plugin.

Type: package

Default: <derivation vimplugin-rose-pine-2024-05-14>

Declared by:

colorschemes.rose-pine.settings

Options provided to the require('rose-pine').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  before_highlight = "function(group, highlight, palette) end";
  dark_variant = "moon";
  dim_inactive_windows = true;
  enable = {
    legacy_highlights = false;
    migrations = true;
    terminal = false;
  };
  extend_background_behind_borders = true;
  groups = {
    border = "muted";
    link = "iris";
    panel = "surface";
  };
  highlight_groups = { };
  styles = {
    bold = false;
    italic = true;
    transparency = true;
  };
  variant = "auto";
}

Declared by:

colorschemes.rose-pine.settings.before_highlight

Called before each highlight group, before setting the highlight.

function(group, highlight, palette)

  @param group string
  @param highlight Highlight
  @param palette Palette

Plugin default: function(group, highlight, palette) end

Type: null or lua function string

Default: null

Declared by:

colorschemes.rose-pine.settings.dark_variant

Set the desired dark variant when settings.variant is set to “auto”.

Plugin default: "main"

Type: null or one of “main”, “moon”, “dawn” or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.dim_inactive_windows

Differentiate between active and inactive windows and panels.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.extend_background_behind_borders

Extend background behind borders. Appearance differs based on which border characters you are using.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.groups

Highlight groups.

default: see source

Type: null or (attribute set of (string or attribute set of string))

Default: null

Declared by:

colorschemes.rose-pine.settings.highlight_groups

Custom highlight groups.

Plugin default: {}

Type: null or (attribute set of ((attribute set) or raw lua code))

Default: null

Declared by:

colorschemes.rose-pine.settings.variant

Set the desired variant: “auto” will follow the vim background, defaulting to dark_variant or “main” for dark and “dawn” for light.

Type: null or one of “auto”, “main”, “moon”, “dawn”

Default: null

Declared by:

colorschemes.rose-pine.settings.enable.legacy_highlights

Enable legacy highlights.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.enable.migrations

Enable migrations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.enable.terminal

Enable terminal.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.styles.bold

Enable bold.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.styles.italic

Enable italic.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.rose-pine.settings.styles.transparency

Enable transparency.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

tokyonight

Url: https://github.com/folke/tokyonight.nvim/

Maintainers: Gaetan Lepage

colorschemes.tokyonight.enable

Whether to enable tokyonight.nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.tokyonight.package

Which package to use for the tokyonight.nvim plugin.

Type: package

Default: <derivation vimplugin-tokyonight.nvim-2024-05-16>

Declared by:

colorschemes.tokyonight.settings

Options provided to the require('tokyonight').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  day_brightness = 0.3;
  dim_inactive = false;
  hide_inactive_statusline = false;
  light_style = "day";
  lualine_bold = false;
  on_colors = "function(colors) end";
  on_highlights = "function(highlights, colors) end";
  sidebars = [
    "qf"
    "vista_kind"
    "terminal"
    "packer"
  ];
  style = "storm";
  styles = {
    comments = {
      italic = true;
    };
    floats = "dark";
    functions = { };
    keywords = {
      italic = true;
    };
    sidebars = "dark";
    variables = { };
  };
  terminal_colors = true;
  transparent = false;
}

Declared by:

colorschemes.tokyonight.settings.day_brightness

Adjusts the brightness of the colors of the Day style. Number between 0 and 1, from dull to vibrant colors.

Plugin default: 0.3

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

colorschemes.tokyonight.settings.dim_inactive

Dims inactive windows.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.hide_inactive_statusline

Enabling this option will hide inactive statuslines and replace them with a thin border instead. Should work with the standard StatusLine and LuaLine.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.light_style

The theme to use when the background is set to light.

Plugin default: "day"

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.lualine_bold

When true, section headers in the lualine theme will be bold.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.on_colors

Override specific color groups to use other groups or a hex color. Function will be called with a ColorScheme table. @param colors ColorScheme

Plugin default: function(colors) end

Type: null or lua function string

Default: null

Declared by:

colorschemes.tokyonight.settings.on_highlights

Override specific highlights to use other groups or a hex color. Function will be called with a Highlights and ColorScheme table. @param highlights Highlights @param colors ColorScheme

Plugin default: function(highlights, colors) end

Type: null or lua function string

Default: null

Declared by:

colorschemes.tokyonight.settings.sidebars

Set a darker background on sidebar-like windows.

Plugin default: ["qf" "help"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

colorschemes.tokyonight.settings.style

The theme comes in three styles, storm, a darker variant night and day.

Plugin default: "storm"

Type: null or one of “storm”, “night”, “day” or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.terminal_colors

Configure the colors used when opening a :terminal in Neovim

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.transparent

Disable setting the background color.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.floats

Background style for floats

Plugin default: "dark"

Type: null or one of “dark”, “transparent”, “normal” or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.sidebars

Background style for sidebars

Plugin default: "dark"

Type: null or one of “dark”, “transparent”, “normal” or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments

Define comments highlight properties.

Plugin default: {italic = true;}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.comments.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions

Define functions highlight properties.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.functions.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords

Define keywords highlight properties.

Plugin default: {italic = true;}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.keywords.underline

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables

Define variables highlight properties.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.bold

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.nocombine

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.reverse

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.standout

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.strikethrough

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.undercurl

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.underdashed

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.underdotted

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.underdouble

Type: null or boolean

Default: null

Declared by:

colorschemes.tokyonight.settings.styles.variables.underline

Type: null or boolean

Default: null

Declared by:

vscode

Url: https://github.com/Mofiqul/vscode.nvim/

Maintainers: Loïc Reynier

colorschemes.vscode.enable

Whether to enable vscode-nvim.

Type: boolean

Default: false

Example: true

Declared by:

colorschemes.vscode.package

Which package to use for the vscode-nvim plugin.

Type: package

Default: <derivation vimplugin-vscode.nvim-2024-05-09>

Declared by:

colorschemes.vscode.settings

Options provided to the require('vscode').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

colorschemes.vscode.settings.color_overrides

A dictionary of color overrides. See https://github.com/Mofiqul/vscode.nvim/blob/main/lua/vscode/colors.lua for color names.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

colorschemes.vscode.settings.disable_nvimtree_bg

Whether to disable nvim-tree background

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.vscode.settings.group_overrides

A dictionary of group names, each associated with a dictionary of parameters (bg, fg, sp and style) and colors in hex.

Plugin default: {}

Type: null or (attribute set of ((attribute set) or raw lua code))

Default: null

Declared by:

colorschemes.vscode.settings.italic_comments

Whether to enable italic comments

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

colorschemes.vscode.settings.transparent

Whether to enable transparent background

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

Whether to underline links

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps

This option has no description.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "<cmd>make<CR>";
    key = "<C-m>";
    options = {
      silent = true;
    };
  }
]

Declared by:

keymaps.*.action

The action to execute.

Type: string or raw lua code

Declared by:

keymaps.*.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

keymaps.*.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: ""

Example:

[
  "n"
  "v"
]

Declared by:

keymaps.*.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

keymaps.*.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymaps.*.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents

Register keymaps on an event instead of when nvim opens. Keys are the events to register on, and values are lists of keymaps to register on each event.

Type: attribute set of list of (submodule)

Default: { }

Example:

{
  InsertEnter = [
    {
      action = {
        __raw = "require(\"cmp\").mapping.confirm()";
      };
      key = "<C-y>";
    }
    {
      action = {
        __raw = "require(\"cmp\").mapping.select_next_item()";
      };
      key = "<C-n>";
    }
  ];
}

Declared by:

keymapsOnEvents.<name>.*.action

The action to execute.

Type: string or raw lua code

Declared by:

keymapsOnEvents.<name>.*.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

keymapsOnEvents.<name>.*.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: ""

Example:

[
  "n"
  "v"
]

Declared by:

keymapsOnEvents.<name>.*.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

keymapsOnEvents.<name>.*.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

airline

Url: https://github.com/vim-airline/vim-airline/

Maintainers: Gaetan Lepage

plugins.airline.enable

Whether to enable vim-airline.

Type: boolean

Default: false

Example: true

Declared by:

plugins.airline.package

Which package to use for the airline plugin.

Type: package

Default: <derivation vimplugin-vim-airline-2024-04-24>

Declared by:

plugins.airline.settings

The configuration options for airline without the airline_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal airline_foo_bar=1
  • hello = "world" -> :setglobal airline_hello="world"
  • some_toggle = true -> :setglobal airline_some_toggle
  • other_toggle = false -> :setglobal noairline_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  powerline_fonts = true;
  skip_empty_sections = true;
  theme = "base16";
}

Declared by:

plugins.airline.settings.detect_crypt

Enable crypt detection.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.detect_iminsert

Enable iminsert detection.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.detect_modified

Enable modified detection.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.detect_paste

Enable paste detection.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.detect_spell

Enable spell detection.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.detect_spelllang

Display spelling language when spell detection is enabled (if enough space is available).

Set to ‘flag’ to get a unicode icon of the relevant country flag instead of the ‘spelllang’ itself.

Plugin default: true

Type: null or raw lua code or boolean or value “flag” (singular enum)

Default: null

Declared by:

plugins.airline.settings.disable_statusline

Disable the Airline statusline customization globally.

This setting disables setting the ‘statusline’ option. This allows to use e.g. the tabline extension (|airline-tabline|) but keep the ‘statusline’ option totally configurable by a custom configuration.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.exclude_filenames

Define the set of filename match queries which excludes a window from having its statusline modified.

Default: see source for current list

Type: null or (list of string) or raw lua code

Default: null

Declared by:

plugins.airline.settings.exclude_filetypes

Define the set of filetypes which are excluded from having its window statusline modified.

Default: see source for current list

Type: null or (list of string) or raw lua code

Default: null

Declared by:

plugins.airline.settings.exclude_preview

Defines whether the preview window should be excluded from having its window statusline modified (may help with plugins which use the preview window heavily).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.experimental

Enable experimental features. Currently: Enable Vim9 Script implementation.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.filetype_overrides

Define the set of names to be displayed instead of a specific filetypes.

Example:

  {
    coc-explorer =  ["CoC Explorer" ""];
    defx = ["defx" "%{b:defx.paths[0]}"];
    fugitive = ["fugitive" "%{airline#util#wrap(airline#extensions#branch#get_head(),80)}"];
    gundo = ["Gundo" "" ];
    help = ["Help" "%f"];
    minibufexpl = ["MiniBufExplorer" ""];
    startify = ["startify" ""];
    vim-plug = ["Plugins" ""];
    vimfiler = ["vimfiler" "%{vimfiler#get_status_string()}"];
    vimshell = ["vimshell" "%{vimshell#get_status_string()}"];
    vaffle = ["Vaffle" "%{b:vaffle.dir}"];
  }

Type: null or (attribute set of list of string) or raw lua code

Default: null

Declared by:

plugins.airline.settings.focuslost_inactive

Disable airline on FocusLost autocommand (e.g. when Vim loses focus).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.highlighting_cache

Caches the changes to the highlighting groups, should therefore be faster. Set this to one, if you experience a sluggish Vim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.inactive_alt_sep

Use alternative separators for the statusline of inactive windows.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.inactive_collapse

Determine whether inactive windows should have the left section collapsed to only the filename of that buffer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.left_sep

The separator used on the left side.

Plugin default: ">"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.airline.settings.mode_map

Define the set of text to display for each mode.

Default: see source

Type: null or (attribute set of string) or raw lua code

Default: null

Declared by:

plugins.airline.settings.powerline_fonts

By default, airline will use unicode symbols if your encoding matches utf-8. If you want the powerline symbols set this variable to true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.right_sep

The separator used on the right side.

Plugin default: "<"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.airline.settings.section_a

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.section_b

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.section_c

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.section_c_only_filename

Display a only file name in statusline.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.section_x

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.section_y

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.section_z

Configuration for this section.

Type: null or raw lua code or string or list of string or attribute set of anything

Default: null

Declared by:

plugins.airline.settings.skip_empty_sections

Do not draw separators for empty sections (only for the active window).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.statusline_ontop

Display the statusline in the tabline (first top line).

Setting this option, allows to use the statusline option to be used by a custom function or another plugin, since airline won’t change it.

Note: This setting is experimental and works on a best effort approach. Updating the statusline might not always happen as fast as needed, but that is a limitation, that comes from Vim. airline tries to force an update if needed, but it might not always work as expected. To force updating the tabline on mode changes, call airline#check_mode() in your custom statusline setting: :set stl=%!airline#check_mode(winnr()) will correctly update the tabline on mode changes.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.stl_path_style

Display a short path in statusline.

Plugin default: "short"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.airline.settings.symbols

Customize airline symbols.

Example:

  {
    branch = "";
    colnr = " ℅:";
    readonly = "";
    linenr = " :";
    maxlinenr = "☰ ";
    dirty= "⚡";
  }

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.airline.settings.symbols_ascii

By default, airline will use unicode symbols if your encoding matches utf-8. If you want to use plain ascii symbols, set this variable: >

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.airline.settings.theme

Themes are automatically selected based on the matching colorscheme. This can be overridden by defining a value.

Note: Only the dark theme is distributed with vim-airline. For more themes, checkout the vim-airline-themes repository (https://github.com/vim-airline/vim-airline-themes)

Plugin default: "dark"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.airline.settings.theme_patch_func

If you want to patch the airline theme before it gets applied, you can supply the name of a function where you can modify the palette.

Example: “AirlineThemePatch”

Then, define this function using extraConfigVim:

  extraConfigVim = \'\'
    function! AirlineThemePatch(palette)
      if g:airline_theme == 'badwolf'
        for colors in values(a:palette.inactive)
          let colors[3] = 245
        endfor
      endif
    endfunction
  \'\';

Type: null or string or raw lua code

Default: null

Declared by:

plugins.alpha.enable

Whether to enable alpha-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.alpha.package

Which package to use for the alpha-nvim plugin.

Type: package

Default: <derivation vimplugin-alpha-nvim-2024-02-25>

Declared by:

plugins.alpha.iconsEnabled

Toggle icon support. Installs nvim-web-devicons.

Type: boolean

Default: true

Declared by:

plugins.alpha.opts

Optional global options.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.alpha.theme

You can directly use a pre-defined theme.

Type: null or string or raw lua code

Default: null

Example: "dashboard"

Declared by:

plugins.alpha.layout

List of sections to layout for the dashboard

Type: list of (attribute set of anything)

Default: [ ]

Example:

[
  {
    type = "padding";
    val = 2;
  }
  {
    opts = {
      hl = "Type";
      position = "center";
    };
    type = "text";
    val = [
      "███╗   ██╗██╗██╗  ██╗██╗   ██╗██╗███╗   ███╗"
      "████╗  ██║██║╚██╗██╔╝██║   ██║██║████╗ ████║"
      "██╔██╗ ██║██║ ╚███╔╝ ██║   ██║██║██╔████╔██║"
      "██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║"
      "██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║"
      "╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝  ╚═══╝  ╚═╝╚═╝     ╚═╝"
    ];
  }
  {
    type = "padding";
    val = 2;
  }
  {
    type = "group";
    val = [
      {
        on_press = {
          __raw = "function() vim.cmd[[ene]] end";
        };
        opts = {
          shortcut = "n";
        };
        type = "button";
        val = "  New file";
      }
      {
        on_press = {
          __raw = "function() vim.cmd[[qa]] end";
        };
        opts = {
          shortcut = "q";
        };
        type = "button";
        val = " Quit Neovim";
      }
    ];
  }
  {
    type = "padding";
    val = 2;
  }
  {
    opts = {
      hl = "Keyword";
      position = "center";
    };
    type = "text";
    val = "Inspiring quote here.";
  }
]

Declared by:

plugins.alpha.layout.*.opts

Additional options for the section

Type: attribute set of anything

Default: { }

Declared by:

plugins.alpha.layout.*.type

Type of section

Type: one of “button”, “group”, “padding”, “text”, “terminal”

Declared by:

plugins.alpha.layout.*.val

Value for section

Type: null or null or string or signed integer or list of (string or attribute set of anything)

Default: null

Declared by:

arrow

Url: https://github.com/otavioschwanck/arrow.nvim/

Maintainers: Haseeb Majid

plugins.arrow.enable

Whether to enable arrow.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.arrow.package

Which package to use for the arrow.nvim plugin.

Type: package

Default: <derivation vimplugin-arrow.nvim-2024-05-07>

Declared by:

plugins.arrow.settings

Options provided to the require('arrow').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  always_show_path = false;
  custom_actions = {
    open = "function(target_file_name, current_file_name) end";
    split_horizontal = "function(target_file_name, current_file_name) end";
    split_vertical = "function(target_file_name, current_file_name) end";
  };
  full_path_list = [
    "update_stuff"
  ];
  global_bookmarks = false;
  hide_handbook = false;
  index_keys = "123456789zxcbnmZXVBNM,afghjklAFGHJKLwrtyuiopWRTYUIOP";
  leader_key = ";";
  mappings = {
    clear_all_items = "C";
    delete_mode = "d";
    edit = "e";
    next_item = "]";
    open_horizontal = "-";
    open_vertical = "v";
    prev_item = "[";
    quit = "q";
    remove = "x";
    toggle = "s";
  };
  per_buffer_config = {
    lines = 4;
    satellite = {
      enable = false;
      overlap = true;
      priority = 1000;
    };
    sort_automatically = true;
    zindex = 10;
  };
  save_key = "cwd";
  save_path = ''
    function()
        return vim.fn.stdpath("cache") .. "/arrow"
    end
  '';
  separate_by_branch = false;
  separate_save_and_remove = false;
  show_icons = true;
  window = {
    border = "double";
    col = "auto";
    height = "auto";
    row = "auto";
    width = "auto";
  };
}

Declared by:

plugins.arrow.settings.always_show_path

If true will show path.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.full_path_list

Filenames on this list will ALWAYS show the file path too

Plugin default: [ "update_stuff" ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.arrow.settings.global_bookmarks

If true arrow will save files globally (ignores separate_by_branch).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.hide_handbook

If true to hide the shortcuts on menu.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.index_keys

Keys mapped to bookmark index.

Plugin default: "123456789zxcbnmZXVBNM,afghjklAFGHJKLwrtyuiopWRTYUIOP"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.leader_key

The leader key to use for arrow. Will precede all mappings. Recommended to be a single character.

Plugin default: ";"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.save_key

What will be used as root to save the bookmarks. Can be also git_root.

Plugin default: "cwd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.save_path

Function used to determine where to save arrow data.

Plugin default:

function()
  return vim.fn.stdpath("cache") .. "/arrow"
end

Type: null or lua function string

Default: null

Declared by:

plugins.arrow.settings.separate_by_branch

If true will split bookmarks by git branch.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.separate_save_and_remove

If true will remove the toggle and create the save/remove keymaps.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.show_icons

If true will show icons.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.window

Controls the appearance and position of an arrow window. See :h nvim_open_win() for all options.

Plugin default:

{
  relative = "editor";
  width = "auto";
  height = "auto";
  row = "auto";
  col = "auto";
  style = "minimal";
  border = "single";
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.arrow.settings.custom_actions.open

  • target_file_name: file selected to be open
  • current_file_name: filename from where this was called

Plugin default:

function(target_file_name, current_file_name) end

Type: null or lua function string

Default: null

Declared by:

plugins.arrow.settings.custom_actions.split_horizontal

Plugin default:

function(target_file_name, current_file_name) end

Type: null or lua function string

Default: null

Declared by:

plugins.arrow.settings.custom_actions.split_vertical

Plugin default:

function(target_file_name, current_file_name) end

Type: null or lua function string

Default: null

Declared by:

plugins.arrow.settings.mapping.clear_all_items

Mapping to clear all bookmarks.

Plugin default: "C"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.delete_mode

Mapping to go to delete mode, where you can remove bookmarks.

Plugin default: "d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.edit

Mapping to edit bookmarks.

Plugin default: "e"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.next_item

Mapping to go to next bookmark.

Plugin default: "]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.open_horizontal

Mapping to open bookmarks in horizontal split.

Plugin default: "-"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.open_vertical

Mapping to open bookmarks in vertical split.

Plugin default: "v"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.prev_item

Mapping to go to previous bookmark.

Plugin default: "["

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.quit

Mapping to quit arrow.

Plugin default: "q"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.remove

Mapping to remove bookmarks. Only used if separate_save_and_remove is true.

Plugin default: "x"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.mapping.toggle

Mapping to save if separate_save_and_remove is true.

Plugin default: "s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.lines

Number of lines on preview.

Plugin default: 4

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.sort_automatically

If true will sort buffer marks automatically.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.zindex

Z index of the buffer.

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.satellite.enable

If true will display arrow index in scrollbar at every update.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.satellite.overlap

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.arrow.settings.per_buffer_config.satellite.priority

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.auto-save.enable

Whether to enable auto-save.

Type: boolean

Default: false

Example: true

Declared by:

plugins.auto-save.enableAutoSave

Whether to start auto-save when the plugin is loaded.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-save.package

Which package to use for the auto-save plugin.

Type: package

Default: <derivation vimplugin-auto-save.nvim-2024-04-25>

Declared by:

plugins.auto-save.condition

Function that determines whether to save the current buffer or not.

  • return true: if buffer is ok to be saved
  • return false: if it’s not ok to be saved

Plugin default:

function(buf)
  local fn = vim.fn
  local utils = require("auto-save.utils.data")

  if
    fn.getbufvar(buf, "&modifiable") == 1 and utils.not_in(fn.getbufvar(buf, "&filetype"), {}) then
    return true -- met condition(s), can save
  end
  return false -- can't save
end

Type: null or lua function string

Default: null

Declared by:

plugins.auto-save.debounceDelay

Saves the file at most every debounce_delay milliseconds.

Plugin default: 135

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.auto-save.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.auto-save.triggerEvents

Vim events that trigger auto-save. See :h events.

Plugin default: ["InsertLeave" "TextChanged"]

Type: null or (list of string)

Default: null

Declared by:

plugins.auto-save.writeAllBuffers

Write all buffers when the current one meets condition.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-save.callbacks.afterSaving

The code of the function that runs after doing the actual save.

Type: null or lua code string

Default: null

Declared by:

plugins.auto-save.callbacks.beforeAssertingSave

The code of the function that runs before checking condition.

Type: null or lua code string

Default: null

Declared by:

plugins.auto-save.callbacks.beforeSaving

The code of the function that runs before doing the actual save.

Type: null or lua code string

Default: null

Declared by:

plugins.auto-save.callbacks.disabling

The code of the function that runs when disabling auto-save.

Type: null or lua code string

Default: null

Declared by:

plugins.auto-save.callbacks.enabling

The code of the function that runs when enabling auto-save.

Type: null or lua code string

Default: null

Declared by:

plugins.auto-save.executionMessage.cleaningInterval

Time (in milliseconds) to wait before automatically cleaning MsgArea after displaying message. See :h MsgArea.

Plugin default: 1250

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.auto-save.executionMessage.dim

Dim the color of message.

Plugin default: 0.18

Type: null or integer or floating point number between 0 and 1 (both inclusive)

Default: null

Declared by:

plugins.auto-save.executionMessage.message

The message to print en save. This can be a lua function that returns a string.

Plugin default:

{
  __raw = \'\'
    function()
      return ("AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"))
    end
  \'\';
}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.auto-save.keymaps.silent

Whether auto-save keymaps should be silent.

Type: boolean

Default: false

Declared by:

plugins.auto-save.keymaps.toggle

Keymap for running auto-save.

Type: null or string

Default: null

Declared by:

plugins.auto-session.enable

Whether to enable auto-session.

Type: boolean

Default: false

Example: true

Declared by:

plugins.auto-session.package

Which package to use for the auto-session plugin.

Type: package

Default: <derivation vimplugin-auto-session-2024-04-14>

Declared by:

plugins.auto-session.bypassSessionSaveFileTypes

List of file types to bypass auto save when the only buffer open is one of the file types listed.

Type: null or (list of string)

Default: null

Declared by:

plugins.auto-session.cwdChangeHandling

Config for handling the DirChangePre and DirChanged autocmds. Set to false to disable the feature.

Plugin default: false

Type: null or value false (singular enum) or (submodule)

Default: null

Declared by:

plugins.auto-session.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.auto-session.logLevel

Sets the log level of the plugin.

Plugin default: "error"

Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code

Default: null

Declared by:

plugins.auto-session.autoRestore.enabled

Whether to enable auto restoring session.

Plugin default: null

Type: null or boolean

Default: null

Declared by:

plugins.auto-session.autoSave.enabled

Whether to enable auto saving session.

Plugin default: null

Type: null or boolean

Default: null

Declared by:

plugins.auto-session.autoSession.enableLastSession

Whether to enable the “last session” feature.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-session.autoSession.enabled

Enables/disables auto creating, saving and restoring.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-session.autoSession.allowedDirs

Allow session create/restore if in one of the list of dirs.

Type: null or (list of string)

Default: null

Declared by:

plugins.auto-session.autoSession.createEnabled

Whether to enable auto creating new sessions

Type: null or boolean

Default: null

Declared by:

plugins.auto-session.autoSession.rootDir

Root directory for session files. Can be either a string or lua code (using {__raw = 'foo';}).

Plugin default: {__raw = "vim.fn.stdpath 'data' .. '/sessions/'";}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.auto-session.autoSession.suppressDirs

Suppress session create/restore if in one of the list of dirs.

Type: null or (list of string)

Default: null

Declared by:

plugins.auto-session.autoSession.useGitBranch

Include git branch name in session name to differentiate between sessions for different git branches.

Type: null or boolean

Default: null

Declared by:

plugins.auto-session.sessionLens.loadOnSetup

If loadOnSetup is set to false, one needs to eventually call require("auto-session").setup_session_lens() if they want to use session-lens.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-session.sessionLens.previewer

Use default previewer config by setting the value to null if some sets previewer to true in the custom config. Passing in the boolean value errors out in the telescope code with the picker trying to index a boolean instead of a table. This fixes it but also allows for someone to pass in a table with the actual preview configs if they want to.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.auto-session.sessionLens.themeConf

Theme configuration.

Plugin default: {winblend = 10; border = true;}

Type: null or (attribute set)

Default: null

Declared by:

plugins.auto-session.sessionLens.sessionControl.controlDir

Auto session control dir, for control files, like alternating between two sessions with session-lens.

Plugin default: "vim.fn.stdpath 'data' .. '/auto_session/'"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.auto-session.sessionLens.sessionControl.controlFilename

File name of the session control file.

Plugin default: "session_control.json"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.autoclose.enable

Whether to enable autoclose.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.autoclose.package

Which package to use for the autoclose.nvim plugin.

Type: package

Default: <derivation vimplugin-autoclose.nvim-2024-02-23>

Declared by:

plugins.autoclose.keys

Configures various options, such as shortcuts for pairs, what pair of characters to use in the shortcut, etc.

See the plugin’s README for more info.";

Example:

  {
    "(" = { escape = false; close = true; pair = "()"; };
    "[" = { escape = false; close = true; pair = "[]"; };
    "{" = { escape = false; close = true; pair = "{}"; };
  }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.autoclose.options.autoIndent

Enable auto-indent feature.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.autoclose.options.disableCommandMode

Disable autoclose for command mode globally.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.autoclose.options.disableWhenTouch

Set this to true will disable the auto-close function when the cursor touches character that matches touch_regex.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.autoclose.options.disabledFiletypes

The plugin will be disabled under the filetypes in this table.

Plugin default: ["text"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.autoclose.options.pairSpaces

Pair the spaces when cursor is inside a pair of keys. See README

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.autoclose.options.touchRegex

See README.

Plugin default: "[%w(%[{]"

Type: null or string or raw lua code

Default: null

Declared by:

bacon

Url: https://github.com/Canop/nvim-bacon/

Maintainers: Alison Jenkins

plugins.bacon.enable

Whether to enable bacon.

Type: boolean

Default: false

Example: true

Declared by:

plugins.bacon.package

Which package to use for the bacon plugin.

Type: package

Default: <derivation vimplugin-nvim-bacon-2024-05-09>

Declared by:

plugins.bacon.settings

Options provided to the require('bacon').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  quickfix = {
    enabled = false;
    event_trigger = true;
  };
}

Declared by:

plugins.bacon.settings.quickfix.enabled

Whether to populate the quickfix list with bacon errors and warnings.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bacon.settings.quickfix.event_trigger

Triggers the QuickFixCmdPost event after populating the quickfix list.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

baleia

Url: https://github.com/m00qek/baleia.nvim/

Maintainers: Alison Jenkins

plugins.baleia.enable

Whether to enable baleia.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.baleia.package

Which package to use for the baleia.nvim plugin.

Type: package

Default: <derivation vimplugin-baleia.nvim-2024-01-06>

Declared by:

plugins.baleia.settings

Options provided to the require('baleia').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  async = true;
  colors = "NR_8";
  line_starts_at = 1;
  log = "INFO";
  name = "BaleiaColors";
  strip_ansi_codes = true;
}

Declared by:

plugins.baleia.settings.async

Highlight asynchronously.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.baleia.settings.colors

Table mapping 256 color codes to vim colors.

Plugin default: "NR_8"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.baleia.settings.line_starts_at

At which column start colorizing.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.baleia.settings.log

Log level, possible values are ERROR, WARN, INFO or DEBUG.

Plugin default: "INFO"

Type: null or one of “ERROR”, “WARN”, “INFO”, “DEBUG” or raw lua code

Default: null

Declared by:

plugins.baleia.settings.name

Prefix used to name highlight groups.

Plugin default: "BaleiaColors"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.baleia.settings.strip_ansi_codes

Remove ANSI color codes from text.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

barbar

Url: https://github.com/romgrk/barbar.nvim/

Maintainers: Gaetan Lepage

plugins.barbar.enable

Whether to enable barbar.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.barbar.package

Which package to use for the barbar.nvim plugin.

Type: package

Default: <derivation vimplugin-barbar.nvim-2024-05-15>

Declared by:

plugins.barbar.keymaps.close

Keymap for function BufferClose

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.close.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferClose<CR>"

Declared by:

plugins.barbar.keymaps.close.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.close.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.close.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.close.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.close.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent

Keymap for function BufferCloseAllButCurrent

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseAllButCurrent<CR>"

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrent.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned

Keymap for function BufferCloseAllButCurrentOrPinned

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseAllButCurrentOrPinned<CR>"

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButCurrentOrPinned.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned

Keymap for function BufferCloseAllButPinned

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseAllButPinned<CR>"

Declared by:

plugins.barbar.keymaps.closeAllButPinned.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeAllButPinned.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButPinned.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible

Keymap for function BufferCloseAllButVisible

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseAllButVisible<CR>"

Declared by:

plugins.barbar.keymaps.closeAllButVisible.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeAllButVisible.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeAllButVisible.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft

Keymap for function BufferCloseBuffersLeft

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseBuffersLeft<CR>"

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersLeft.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight

Keymap for function BufferCloseBuffersRight

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferCloseBuffersRight<CR>"

Declared by:

plugins.barbar.keymaps.closeBuffersRight.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.closeBuffersRight.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.closeBuffersRight.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first

Keymap for function BufferFirst

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.first.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferFirst<CR>"

Declared by:

plugins.barbar.keymaps.first.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.first.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.first.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.first.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.first.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1

Keymap for function BufferGoto 1

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 1<CR>"

Declared by:

plugins.barbar.keymaps.goTo1.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo1.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo1.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo1.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2

Keymap for function BufferGoto 2

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 2<CR>"

Declared by:

plugins.barbar.keymaps.goTo2.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo2.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo2.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo2.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3

Keymap for function BufferGoto 3

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 3<CR>"

Declared by:

plugins.barbar.keymaps.goTo3.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo3.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo3.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo3.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4

Keymap for function BufferGoto 4

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 4<CR>"

Declared by:

plugins.barbar.keymaps.goTo4.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo4.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo4.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo4.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5

Keymap for function BufferGoto 5

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 5<CR>"

Declared by:

plugins.barbar.keymaps.goTo5.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo5.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo5.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo5.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6

Keymap for function BufferGoto 6

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 6<CR>"

Declared by:

plugins.barbar.keymaps.goTo6.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo6.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo6.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo6.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7

Keymap for function BufferGoto 7

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 7<CR>"

Declared by:

plugins.barbar.keymaps.goTo7.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo7.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo7.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo7.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8

Keymap for function BufferGoto 8

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 8<CR>"

Declared by:

plugins.barbar.keymaps.goTo8.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo8.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo8.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo8.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9

Keymap for function BufferGoto 9

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferGoto 9<CR>"

Declared by:

plugins.barbar.keymaps.goTo9.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.goTo9.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.goTo9.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.goTo9.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last

Keymap for function BufferLast

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.last.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferLast<CR>"

Declared by:

plugins.barbar.keymaps.last.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.last.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.last.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.last.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.last.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext

Keymap for function BufferMoveNext

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferMoveNext<CR>"

Declared by:

plugins.barbar.keymaps.moveNext.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.moveNext.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.moveNext.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveNext.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious

Keymap for function BufferMovePrevious

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferMovePrevious<CR>"

Declared by:

plugins.barbar.keymaps.movePrevious.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.movePrevious.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.movePrevious.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.movePrevious.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart

Keymap for function BufferMoveStart

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferMoveStart<CR>"

Declared by:

plugins.barbar.keymaps.moveStart.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.moveStart.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.moveStart.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.moveStart.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next

Keymap for function BufferNext

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.next.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferNext<CR>"

Declared by:

plugins.barbar.keymaps.next.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.next.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.next.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.next.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.next.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber

Keymap for function BufferOrderByBufferNumber

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferOrderByBufferNumber<CR>"

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByBufferNumber.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory

Keymap for function BufferOrderByDirectory

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferOrderByDirectory<CR>"

Declared by:

plugins.barbar.keymaps.orderByDirectory.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.orderByDirectory.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByDirectory.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage

Keymap for function BufferOrderByLanguage

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferOrderByLanguage<CR>"

Declared by:

plugins.barbar.keymaps.orderByLanguage.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.orderByLanguage.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByLanguage.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName

Keymap for function BufferOrderByName

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferOrderByName<CR>"

Declared by:

plugins.barbar.keymaps.orderByName.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.orderByName.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.orderByName.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByName.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber

Keymap for function BufferOrderByWindowNumber

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferOrderByWindowNumber<CR>"

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.orderByWindowNumber.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick

Keymap for function BufferPick

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.pick.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferPick<CR>"

Declared by:

plugins.barbar.keymaps.pick.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.pick.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.pick.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pick.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete

Keymap for function BufferPickDelete

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferPickDelete<CR>"

Declared by:

plugins.barbar.keymaps.pickDelete.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.pickDelete.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.pickDelete.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pickDelete.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin

Keymap for function BufferPin

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.pin.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferPin<CR>"

Declared by:

plugins.barbar.keymaps.pin.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.pin.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.pin.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.pin.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous

Keymap for function BufferPrevious

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.previous.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferPrevious<CR>"

Declared by:

plugins.barbar.keymaps.previous.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.previous.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.previous.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.previous.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore

Keymap for function BufferRestore

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.restore.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferRestore<CR>"

Declared by:

plugins.barbar.keymaps.restore.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.restore.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.restore.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.restore.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft

Keymap for function BufferScrollLeft

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferScrollLeft<CR>"

Declared by:

plugins.barbar.keymaps.scrollLeft.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.scrollLeft.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.scrollLeft.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollLeft.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight

Keymap for function BufferScrollRight

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferScrollRight<CR>"

Declared by:

plugins.barbar.keymaps.scrollRight.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.scrollRight.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.scrollRight.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.scrollRight.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout

Keymap for function BufferWipeout

Type: null or (submodule)

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.action

The action to execute.

Type: string or raw lua code

Default: "<Cmd>BufferWipeout<CR>"

Declared by:

plugins.barbar.keymaps.wipeout.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.barbar.keymaps.wipeout.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: "n"

Example:

[
  "n"
  "v"
]

Declared by:

plugins.barbar.keymaps.wipeout.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.keymaps.wipeout.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings

Options provided to the require('barbar').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  animation = false;
  exclude_ft = [
    "oil"
    "qf"
    "fugitive"
  ];
  exclude_name = [
    "UnicodeTable.txt"
  ];
  highlight_alternate = true;
  icons = {
    button = false;
    separator_at_end = false;
  };
}

Declared by:

plugins.barbar.settings.animation

Enable/disable animations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.auto_hide

Automatically hide the ‘tabline’ when there are this many buffers left. Set to any value less than 0 to disable.

For example: auto_hide = 0 hides the ‘tabline’ when there would be zero buffers shown, auto_hide = 1 hides the ‘tabline’ when there would only be one, etc.

Plugin default: -1

Type: null or signed integer or value false (singular enum) or raw lua code

Default: null

Declared by:

plugins.barbar.settings.clickable

If set, you can left-click on a tab to switch to that buffer, and middle-click to delete it.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.exclude_ft

Excludes filetypes from appearing in the tabs.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.exclude_name

Excludes buffers matching name from appearing in the tabs.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.focus_on_close

The algorithm to use for getting the next buffer after closing the current one:

  • 'left': focus the buffer to the left of the current buffer.
  • 'previous': focus the previous buffer.
  • 'right': focus the buffer to the right of the current buffer.

Plugin default: "left"

Type: null or one of “left”, “previous”, “right” or raw lua code

Default: null

Declared by:

plugins.barbar.settings.highlight_alternate

Enables highlighting of alternate buffers.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.highlight_inactive_file_icons

Enables highlighting the file icons of inactive buffers.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.highlight_visible

Enables highlighting of visible buffers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.insert_at_end

If true, new buffers appear at the end of the list. Default is to open after the current buffer.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.insert_at_start

If true, new buffers appear at the start of the list. Default is to open after the current buffer.

Has priority over insert_at_end.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.letters

New buffer letters are assigned in this order. This order is optimal for the QWERTY keyboard layout but might need adjustment for other layouts.

Plugin default: "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.maximum_length

Sets the maximum buffer name length.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.barbar.settings.maximum_padding

Sets the maximum padding width with which to surround each tab.

Plugin default: 4

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.barbar.settings.minimum_length

Sets the minimum buffer name length.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.barbar.settings.minimum_padding

Sets the minimum padding width with which to surround each tab.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.barbar.settings.no_name_title

Sets the name of unnamed buffers.

By default format is '[Buffer X]' where X is the buffer number. However, only a static string is accepted here.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.semantic_letters

If true, the letters for each buffer in buffer-pick mode will be assigned based on their name.

Otherwise (or in case all letters are already assigned), the behavior is to assign letters in the order of provided to letters.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.sidebar_filetypes

Control which filetypes will cause barbar to add an offset.

Plugin default: { }

Type: null or (attribute set of (value true (singular enum) or (attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.tabpages

Enable/disable current/total tabpages indicator (top right corner).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.hide.alternate

Controls the visibility of the |alternate-file|. highlight_alternate must be true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.hide.current

Controls the visibility of the current buffer.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.hide.extensions

Controls the visibility of file extensions.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.hide.inactive

Controls visibility of |hidden-buffer|s and |inactive-buffer|s.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.hide.visible

Controls visibility of |active-buffer|s. highlight_visible must be true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.alternate

The icons which should be used for the |alternate-file|. Supports all the base options (e.g. buffer_index, filetype.enabled, etc) as well as modified and pinned.

Type: null or (attribute set of anything) or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.buffer_index

If true, show the index of the buffer with respect to the ordering of the buffers in the tabline.

Plugin default: false

Type: null or boolean or one of “superscript”, “subscript” or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.buffer_number

If true, show the bufnr for the associated buffer.

Plugin default: false

Type: null or boolean or one of “superscript”, “subscript” or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.button

The button which is clicked to close / save a buffer, or indicate that it is pinned. Use false to disable it.

Plugin default:

Type: null or string or value false (singular enum) or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.current

The icons which should be used for current buffer. Supports all the base options (e.g. buffer_index, filetype.enabled, etc) as well as modified and pinned.

Type: null or (attribute set of anything) or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.filename

If true, show the name of the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.gitsigns

Gitsigns icons.

Plugin default:

{
  added = {
    enabled = true;
    icon = "+";
  };
  changed = {
    enabled = true;
    icon = "~";
  };
  deleted = {
    enabled = true;
    icon = "-";
  };
}

Type: null or (attribute set of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.icons.inactive

The icons which should be used for |hidden-buffer|s and |inactive-buffer|s. Supports all the base options (e.g. buffer_index, filetype.enabled, etc) as well as modified and pinned.

Plugin default:

{
  separator = {
    left = "▎";
    right = "";
  };
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.icons.modified

The icons which should be used for a ‘modified’ buffer. Supports all the base options (e.g. buffer_index, filetype.enabled, etc).

Plugin default:

{
  button = "●";
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.icons.pinned

The icons which should be used for a pinned buffer. Supports all the base options (e.g. buffer_index, filetype.enabled, etc).

Plugin default:

{
  button = false;
  filename = false;
  separator = {
    right = " ";
  };
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.barbar.settings.icons.preset

Base all |barbar-setup.icons| configuration off of this set of defaults.

  • 'default': the classic |barbar.nvim| look.
  • 'powerline': like (https://github.com/powerline/powerline)
  • 'slanted': like old Google Chrome tabs

Plugin default: "default"

Type: null or one of “default”, “powerline”, “slanted” or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.visible

The icons which should be used for |active-buffer|s. Supports all the base options (e.g. buffer_index, filetype.enabled, etc) as well as modified and pinned.

Type: null or (attribute set of anything) or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics

Set the icon for each diagnostic level.

The keys will be automatically translated to raw lua:

  {
    "vim.diagnostic.severity.INFO".enabled = true;
    "vim.diagnostic.severity.WARN".enabled = true;
  }

will result in the following lua:

  {
    -- Note the table keys are not string literals:
    [vim.diagnostic.severity.INFO] = { ['enabled'] = true },
    [vim.diagnostic.severity.WARN] = { ['enabled'] = true },
  }

Plugin default:

{
  "vim.diagnostic.severity.ERROR" = {
    enabled = false;
    icon = " ";
  };
  "vim.diagnostic.severity.HINT" = {
    enabled = false;
    icon = "󰌶 ";
  };
  "vim.diagnostic.severity.INFO" = {
    enabled = false;
    icon = " ";
  };
  "vim.diagnostic.severity.WARN" = {
    enabled = false;
    icon = " ";
  };
}

Type: attribute set of anything

Default: { }

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.ERROR".enabled

Enable showing diagnostics of this |diagnostic-severity| in the ‘tabline’.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.ERROR".icon

The icon which accompanies the number of diagnostics.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.HINT".enabled

Enable showing diagnostics of this |diagnostic-severity| in the ‘tabline’.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.HINT".icon

The icon which accompanies the number of diagnostics.

Plugin default: "󰌶 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.INFO".enabled

Enable showing diagnostics of this |diagnostic-severity| in the ‘tabline’.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.INFO".icon

The icon which accompanies the number of diagnostics.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.WARN".enabled

Enable showing diagnostics of this |diagnostic-severity| in the ‘tabline’.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.diagnostics."vim.diagnostic.severity.WARN".icon

The icon which accompanies the number of diagnostics.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.filetype.enabled

Filetype true, show the devicons for the associated buffer’s filetype.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.filetype.custom_colors

If true, the Buffer<status>Icon color will be used for icon colors.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.separator.left

The left separator between buffers in the tabline.

Plugin default: "▎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.separator.right

The right separator between buffers in the tabline.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbar.settings.icons.separator.separator_at_end

If true, add an additional separator at the end of the buffer list. Can be used to create a visual separation when the inactive buffer background color is the same as the fill region background color.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.enable

Whether to enable barbecue-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.barbecue.package

Which package to use for the barbecue-nvim plugin.

Type: package

Default: <derivation vimplugin-barbecue.nvim-2023-09-13>

Declared by:

plugins.barbecue.attachNavic

Whether to attach navic to language servers automatically.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.contextFollowIconColor

Whether context text should follow its icon’s color.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.createAutocmd

Whether to create winbar updater autocmd.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.customSection

Get custom section contents. NOTE: This function shouldn’t do any expensive actions as it is run on each render.

Plugin default:

function()
  return " "
end

Type: null or lua function string

Default: null

Declared by:

plugins.barbecue.excludeFiletypes

Filetypes not to enable winbar in.

Plugin default: ["netrw" "toggleterm"]

Type: null or (list of string)

Default: null

Declared by:

plugins.barbecue.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.barbecue.includeBuftypes

Buftypes to enable winbar in.

Plugin default: [""]

Type: null or (list of string)

Default: null

Declared by:

plugins.barbecue.leadCustomSection

Get leading custom section contents. NOTE: This function shouldn’t do any expensive actions as it is run on each render.

Plugin default:

function()
  return " "
end

Type: null or lua function string

Default: null

Declared by:

plugins.barbecue.modified

Get modified status of file. NOTE: This can be used to get file modified status from SCM (e.g. git)

Plugin default:

function(bufnr)
	return vim.bo[bufnr].modified
end

Type: null or lua function string

Default: null

Declared by:

plugins.barbecue.showBasename

Whether to display file name.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.showDirname

Whether to display path to file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.showModified

Whether to replace file icon with the modified symbol when buffer is modified.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.showNavic

Whether to show/use navic in the winbar.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.barbecue.theme

Theme to be used for generating highlight groups dynamically.

Plugin default: "auto"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Array

icon for Array.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Boolean

icon for Boolean.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Class

icon for Class.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Constant

icon for Constant.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Constructor

icon for Constructor.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Enum

icon for Enum.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.EnumMember

icon for EnumMember.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Event

icon for Event.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Field

icon for Field.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.File

icon for File.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Function

icon for Function.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Interface

icon for Interface.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Key

icon for Key.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Method

icon for Method.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Module

icon for Module.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Namespace

icon for Namespace.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Null

icon for Null.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Number

icon for Number.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Object

icon for Object.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Operator

icon for Operator.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Package

icon for Package.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Property

icon for Property.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.String

icon for String.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Struct

icon for Struct.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.TypeParameter

icon for TypeParameter.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.kinds.Variable

icon for Variable.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.modifiers.basename

Filename modifiers applied to basename.

See: :help filename-modifiers

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.modifiers.dirname

Filename modifiers applied to dirname.

See: :help filename-modifiers

Plugin default: ":~:."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.symbols.ellipsis

Truncation indicator.

Plugin default: "…"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.symbols.modified

Modification indicator.

Plugin default: "●"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.barbecue.symbols.separator

Entry separator.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.better-escape.enable

Whether to enable better-escape.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.better-escape.package

Which package to use for the better-escape.nvim plugin.

Type: package

Default: <derivation vimplugin-better-escape.nvim-2024-01-21>

Declared by:

plugins.better-escape.clearEmptyLines

Clear line after escaping if there is only whitespace.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.better-escape.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.better-escape.keys

Keys used for escaping, if it is a function will use the result everytime.

Example (recommended):

keys.__raw = '' function() return vim.api.nvim_win_get_cursor(0)[2] > 1 and ‘<esc>l’ or ‘<esc>’ end '';

Plugin default: <ESC>

Type: null or string or raw lua code

Default: null

Declared by:

plugins.better-escape.mapping

List of mappings to use to enter escape mode.

Type: null or (list of string)

Default: null

Declared by:

plugins.better-escape.timeout

The time in which the keys must be hit in ms. Uses the value of vim.o.timeoutlen (options.timeoutlen in nixvim) by default.

Plugin default: vim.o.timeoutlen

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.bufferline.enable

Whether to enable bufferline.

Type: boolean

Default: false

Example: true

Declared by:

plugins.bufferline.package

Which package to use for the bufferline plugin.

Type: package

Default: <derivation vimplugin-bufferline.nvim-2024-04-22>

Declared by:

plugins.bufferline.alwaysShowBufferline

Whether to always show the bufferline.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.bufferCloseIcon

The close icon for each buffer.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.closeCommand

Command or function run when closing a buffer.

Plugin default: "bdelete! %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.closeIcon

The close icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.colorIcons

Enable color icons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.customFilter

fun(buf: number, bufnums: number[]): boolean

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.diagnostics

diagnostics

Plugin default: false

Type: null or boolean or one of “nvim_lsp”, “coc”

Default: null

Declared by:

plugins.bufferline.diagnosticsIndicator

Either null or a function that returns the diagnostics indicator.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.diagnosticsUpdateInInsert

Whether diagnostics should update in insert mode

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.enforceRegularTabs

Whether to enforce regular tabs.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.bufferline.getElementIcon

Lua function returning an element icon.

fun(opts: IconFetcherOpts): string?, string?

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.leftMouseCommand

Command or function run when clicking on a buffer.

Plugin default: "buffer %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.leftTruncMarker

left trunc marker

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.maxNameLength

Max length of a buffer name.

Plugin default: 18

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.bufferline.maxPrefixLength

Maximum prefix length

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.bufferline.middleMouseCommand

Command or function run when middle clicking on a buffer.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.mode

mode

Plugin default: "buffers"

Type: null or one of “buffers”, “tabs” or raw lua code

Default: null

Declared by:

plugins.bufferline.modifiedIcon

The icon indicating a buffer was modified.

Plugin default: "●"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.nameFormatter

A lua function that can be used to modify the buffer’s label. The argument ‘buf’ containing a name, path and bufnr is supplied.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.numbers

Customize the styling of numbers.

Either one of “none” “ordinal” “buffer_id” “both” or a lua function:

function({ ordinal, id, lower, raise }): string

Plugin default: none

Type: null or one of “none”, “ordinal”, “buffer_id”, “both” or raw lua code

Default: null

Declared by:

plugins.bufferline.offsets

offsets

Plugin default: null

Type: null or (list of (attribute set))

Default: null

Declared by:

plugins.bufferline.persistBufferSort

Whether to make the buffer sort persistent.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.rightMouseCommand

Command or function run when right clicking on a buffer.

Plugin default: "bdelete! %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.rightTruncMarker

right trunc marker

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.separatorStyle

Separator style

Plugin default: "thin"

Type: null or one of “slant”, “padded_slant”, “slope”, “padded_slope”, “thick”, “thin” or raw lua code

Default: null

Declared by:

plugins.bufferline.showBufferCloseIcons

Show buffer close icons

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showBufferIcons

Show buffer icons

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showCloseIcon

Whether to show the close icon.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showDuplicatePrefix

Whether to show the prefix of duplicated files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showTabIndicators

Whether to show the tab indicators.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.sortBy

sort by

Plugin default: "id"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.tabSize

Size of the tabs

Plugin default: 18

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.bufferline.themable

Whether or not bufferline highlights can be overridden externally

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.truncateNames

Whether to truncate names.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.debug.logging

Whether to enable logging

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.groups.items

List of groups.

Plugin default: []

Type: null or (list of (attribute set))

Default: null

Declared by:

plugins.bufferline.groups.options.toggleHiddenOnEnter

Re-open hidden groups on bufenter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background

Highlight group definition for background.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.background.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.background.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.background.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.background.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.background.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected

Highlight group definition for bufferSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible

Highlight group definition for bufferVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.bufferVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton

Highlight group definition for closeButton.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButton.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected

Highlight group definition for closeButtonSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible

Highlight group definition for closeButtonVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.closeButtonVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic

Highlight group definition for diagnostic.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnostic.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected

Highlight group definition for diagnosticSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible

Highlight group definition for diagnosticVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.diagnosticVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate

Highlight group definition for duplicate.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicate.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected

Highlight group definition for duplicateSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible

Highlight group definition for duplicateVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.duplicateVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error

Highlight group definition for error.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.error.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.error.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.error.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.error.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.error.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic

Highlight group definition for errorDiagnostic.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnostic.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected

Highlight group definition for errorDiagnosticSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible

Highlight group definition for errorDiagnosticVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorDiagnosticVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected

Highlight group definition for errorSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible

Highlight group definition for errorVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.errorVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill

Highlight group definition for fill.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.fill.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.fill.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.fill.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.fill.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.fill.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint

Highlight group definition for hint.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hint.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hint.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hint.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hint.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hint.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic

Highlight group definition for hintDiagnostic.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnostic.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected

Highlight group definition for hintDiagnosticSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible

Highlight group definition for hintDiagnosticVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintDiagnosticVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected

Highlight group definition for hintSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible

Highlight group definition for hintVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.hintVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected

Highlight group definition for indicatorSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible

Highlight group definition for indicatorVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.indicatorVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info

Highlight group definition for info.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.info.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.info.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.info.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.info.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.info.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic

Highlight group definition for infoDiagnostic.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnostic.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected

Highlight group definition for infoDiagnosticSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible

Highlight group definition for infoDiagnosticVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoDiagnosticVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected

Highlight group definition for infoSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible

Highlight group definition for infoVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.infoVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified

Highlight group definition for modified.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modified.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.modified.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modified.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modified.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modified.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected

Highlight group definition for modifiedSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible

Highlight group definition for modifiedVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.modifiedVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers

Highlight group definition for numbers.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbers.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.numbers.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbers.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbers.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbers.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected

Highlight group definition for numbersSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible

Highlight group definition for numbersVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.numbersVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator

Highlight group definition for offsetSeparator.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.offsetSeparator.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick

Highlight group definition for pick.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pick.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.pick.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pick.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pick.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pick.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected

Highlight group definition for pickSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible

Highlight group definition for pickVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.pickVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator

Highlight group definition for separator.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separator.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.separator.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separator.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separator.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separator.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected

Highlight group definition for separatorSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible

Highlight group definition for separatorVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.separatorVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab

Highlight group definition for tab.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tab.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.tab.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tab.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tab.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tab.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose

Highlight group definition for tabClose.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabClose.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected

Highlight group definition for tabSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator

Highlight group definition for tabSeparator.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparator.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected

Highlight group definition for tabSeparatorSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.tabSeparatorSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker

Highlight group definition for trunkMarker.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.trunkMarker.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning

Highlight group definition for warning.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warning.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warning.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warning.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warning.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warning.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic

Highlight group definition for warningDiagnostic.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnostic.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected

Highlight group definition for warningDiagnosticSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible

Highlight group definition for warningDiagnosticVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningDiagnosticVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected

Highlight group definition for warningSelected.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningSelected.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible

Highlight group definition for warningVisible.

Type: null or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.bold

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.reverse

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.standout

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.highlights.warningVisible.underline

Type: null or boolean

Default: null

Declared by:

plugins.bufferline.hover.enabled

Whether to enable hover.

Type: boolean

Default: false

Example: true

Declared by:

plugins.bufferline.hover.delay

delay

Plugin default: 200

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.bufferline.hover.reveal

reveal

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.bufferline.indicator.icon

icon

Plugin default: "▎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.indicator.style

style

Plugin default: "icon"

Type: null or one of “icon”, “underline” or raw lua code

Default: null

Declared by:

ccc

Url: https://github.com/uga-rosa/ccc.nvim/

Maintainers: Jan Kremer

plugins.ccc.enable

Whether to enable ccc.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ccc.package

Which package to use for the ccc.nvim plugin.

Type: package

Default: <derivation vimplugin-ccc.nvim-2024-04-28>

Declared by:

plugins.ccc.settings

Options provided to the require('ccc').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  default_color = "#FFFFFF";
  highlight_mode = "fg";
  highlighter = {
    auto_enable = true;
    excludes = [
      "markdown"
    ];
    lsp = false;
    update_insert = false;
  };
  inputs = [
    "ccc.input.oklab"
    "ccc.input.oklch"
  ];
  lsp = false;
  outputs = [
    "ccc.output.css_oklab"
    "ccc.output.css_oklch"
  ];
  pickers = [
    "ccc.picker.css_oklch"
    "ccc.picker.css_name"
    "ccc.picker.hex"
  ];
}

Declared by:

plugins.ccc.settings.convert

Specify the correspondence between picker and output. The default setting converts the color to css_rgb if it is in hex format, to css_hsl if it is in css_rgb format, and to hex if it is in css_hsl format.

Plugin default:

  [
    ["ccc.picker.hex" "ccc.output.css_rgb"]
    ["ccc.picker.css_rgb" "ccc.output.css_hsl"]
    ["ccc.picker.css_hsl" "ccc.output.hex"]
  ]

Type: null or (list of list of lua code string) or raw lua code

Default: [ ]

Example:

[
  [
    "ccc.picker.hex"
    "ccc.output.css_oklch"
  ]
  [
    "ccc.picker.css_oklch"
    "ccc.output.hex"
  ]
]

Declared by:

plugins.ccc.settings.default_color

The default color used when a color cannot be picked. It must be HEX format.

Plugin default: "#000000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ccc.settings.highlight_mode

Option to highlight text foreground or background. It is used to output_line and highlighter.

Plugin default: "bg"

Type: null or one of “bg”, “fg”, “background”, “foreground” or raw lua code

Default: null

Declared by:

plugins.ccc.settings.inputs

List of color system to be activated. ccc-action-toggle_input_mode toggles in this order. The first one is the default used at the first startup. Once activated, it will keep the previous input mode.

Plugin default:

  [
    "ccc.input.rgb"
    "ccc.input.hsl"
    "ccc.input.cmyk"
  ]

Type: list of lua code string

Default: [ ]

Example:

[
  "ccc.input.rgb"
  "ccc.input.hsl"
  "ccc.input.hwb"
  "ccc.input.lab"
  "ccc.input.lch"
  "ccc.input.oklab"
  "ccc.input.oklch"
  "ccc.input.cmyk"
  "ccc.input.hsluv"
  "ccc.input.okhsl"
  "ccc.input.hsv"
  "ccc.input.okhsv"
  "ccc.input.xyz"
]

Declared by:

plugins.ccc.settings.lsp

Whether to enable LSP support. The color information is updated in the background and the result is used by :CccPick and highlighter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ccc.settings.outputs

List of output format to be activated. ccc-action-toggle_ouotput_mode toggles in this order. The first one is the default used at the first startup. Once activated, it will keep the previous output mode.

Plugin default:

  [
    "ccc.output.hex"
    "ccc.output.hex_short"
    "ccc.output.css_rgb"
    "ccc.output.css_hsl"
  ]

Type: list of lua code string

Default: [ ]

Example:

[
  "ccc.output.hex"
  "ccc.output.hex_short"
  "ccc.output.css_rgb"
  "ccc.output.css_hsl"
  "ccc.output.css_hwb"
  "ccc.output.css_lab"
  "ccc.output.css_lch"
  "ccc.output.css_oklab"
  "ccc.output.css_oklch"
  "ccc.output.float"
  "ccc.output.hex.setup({ uppercase = true })"
  "ccc.output.hex_short.setup({ uppercase = true })"
]

Declared by:

plugins.ccc.settings.pickers

List of formats that can be detected by :CccPick to be activated.

Plugin default:

  [
    "ccc.picker.hex"
    "ccc.picker.css_rgb"
    "ccc.picker.css_hsl"
    "ccc.picker.css_hwb"
    "ccc.picker.css_lab"
    "ccc.picker.css_lch"
    "ccc.picker.css_oklab"
    "ccc.picker.css_oklch"
  ]

Type: list of lua code string

Default: [ ]

Example:

[
  "ccc.picker.hex"
  "ccc.picker.css_rgb"
  "ccc.picker.css_hsl"
  "ccc.picker.css_hwb"
  "ccc.picker.css_lab"
  "ccc.picker.css_lch"
  "ccc.picker.css_oklab"
  "ccc.picker.css_oklch"
  "ccc.picker.css_name"
]

Declared by:

plugins.ccc.settings.highlighter.auto_enable

Whether to enable automatically on BufEnter.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ccc.settings.highlighter.excludes

Used only when ccc-option-highlighter-filetypes is empty table. You can specify file types to be excludes.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.ccc.settings.highlighter.filetypes

File types for which highlighting is enabled. It is only used for automatic highlighting by ccc-option-highlighter-auto-enable, and is ignored for manual activation. An empty table means all file types.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.ccc.settings.highlighter.lsp

If true, highlight using LSP. If language server with the color provider is not attached to a buffer, it falls back to highlight with pickers. See also :help ccc-option-lsp.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ccc.settings.highlighter.update_insert

If true, highlights will be updated during insert mode. If false, highlights will not be updated during editing in insert mode, but will be updated on InsertLeave.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.chadtree.enable

Whether to enable chadtree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.chadtree.package

Which package to use for the chadtree plugin.

Type: package

Default: <derivation vimplugin-chadtree-2024-05-10>

Declared by:

plugins.chadtree.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.chadtree.keymap.bookmarks.bookmarkGoto

Goto bookmark A-Z.

Plugin default: ["m"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.copyBasename

Copy names of files under cursor or visual block.

Plugin default: ["Y"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.copyName

Copy paths of files under cursor or visual block.

Plugin default: ["y"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.copyRelname

Copy relative paths of files under cursor or visual block.

Plugin default: ["<c-y>"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.jumpToCurrent

Position cursor in CHADTree at currently open buffer, if the buffer points to a location visible under CHADTree.

Plugin default: ["J"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.refocus

Put cursor at the root of CHADTree.

Plugin default: ["~"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.cursor.stat

Print ls --long stat for file under cursor.

Plugin default: ["K"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.copy

Copy the selected files to location under cursor.

Plugin default: ["p"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.cut

Move the selected files to location under cursor.

Plugin default: ["x"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.delete

Delete the selected files. Items deleted cannot be recovered.

Plugin default: ["d"]

Type: null or (list of string)

Default: null

Declared by:

Create links at location under cursor from selection.

Links are always relative.

Intermediary folders are created automatically.

Plugin default: ["A"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.new

Create new file at location under cursor. Files ending with platform specific path separator will be folders.

Intermediary folders are created automatically.

ie. uwu/owo/ under unix will create uwu/ then owo/ under it. Both are folders.

Plugin default: ["a"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.rename

Rename file under cursor.

Plugin default: ["r"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.toggleExec

Toggle all the +x bits of the selected / highlighted files.

Except for directories, where -x will prevent reading.

Plugin default: ["X"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.fileOperations.trash

Trash the selected files using platform specific trash command, if they are available. Items trashed may be recovered.

Plugin default: [t]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.filtering.clearFilter

Clear filter.

Plugin default: ["F"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.filtering.filter

Set a glob pattern to narrow down visible files.

Plugin default: ["f"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.collapse

Collapse all subdirectories for directory at cursor.

Plugin default: ["o"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.hSplit

Open file at cursor in horizontal split.

Plugin default: ["W"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.openSys

Open file with GUI tools using open or xdg open. This will open third party tools such as Finder or KDE Dolphin or GNOME nautilus, etc. Depends on platform and user setup.

Plugin default: ["o"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.primary

Open file at cursor.

Plugin default: ["<enter>"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.secondary

Open file at cursor, keep cursor in CHADTree’s window.

Plugin default: ["<tab> <2-leftmouse>"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.tertiary

Open file at cursor in a new tab.

Plugin default: ["<m-enter>" <middlemouse>]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.openFileFolder.vSplit

Open file at cursor in vertical split.

Plugin default: ["w"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.rerooting.changeDir

Change vim’s working directory.

Plugin default: ["b"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.rerooting.changeFocus

Set CHADTree’s root to folder at cursor. Does not change working directory.

Plugin default: ["c"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.rerooting.changeFocusUp

Set CHADTree’s root one level up.

Plugin default: ["C"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.selecting.clearSelection

Clear selection.

Plugin default: ["S"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.selecting.select

Select files under cursor or visual block.

Plugin default: ["s"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.toggles.toggleFollow

Toggle follow on and off. See chadtree.follow for details.

Plugin default: ["u"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.toggles.toggleHidden

Toggle show_hidden on and off. See chadtree.showHidden for details.

Plugin default: ["."]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.toggles.toggleVersionControl

Toggle version control integration on and off.

Plugin default: ["i"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.windowManagement.bigger

Resize CHADTree window bigger.

Plugin default: ["+" "="]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.windowManagement.quit

Close CHADTree window, quit if it is the last window.

Plugin default: ["q"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.windowManagement.refresh

Refresh CHADTree.

Plugin default: ["<c-r>"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.keymap.windowManagement.smaller

Resize CHADTree window smaller.

Plugin default: ["-" "_"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.options.follow

CHADTree will highlight currently open file, and open all its parents.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.chadtree.options.lang

CHADTree will guess your locale from unix environmental variables. Set to c to disable emojis.

Type: null or string

Default: null

Declared by:

plugins.chadtree.options.pageIncrement

Change how many lines { and } scroll.

Plugin default: 5

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.chadtree.options.pollingRate

CHADTree’s background refresh rate.

Plugin default: 2.0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.chadtree.options.session

Save & restore currently open folders.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.chadtree.options.showHidden

Hide some files and folders by default. By default this can be toggled using the . key. see chadtree_settings.ignore for more details.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.chadtree.options.versionControl

Enable version control. This can also be toggled. But unlike show_hidden, does not have a default keybind.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.chadtree.options.ignore.nameExact

Files whose name match these exactly will be ignored.

Plugin default: [".DS_Store" ".directory" "thumbs.db" ".git"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.options.ignore.nameGlob

Files whose name match these glob patterns will be ignored. ie. *.py will match all python files

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.options.ignore.pathGlob

Files whose full path match these glob patterns will be ignored.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.options.mimetypes.allowExts

Skip warning for these extensions.

Plugin default: [".ts"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.options.mimetypes.warn

Show a warning before opening these datatypes.

Plugin default: ["audio" "font" "image" "video"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.theme.iconColourSet

Right now you all the file icons are coloured according to Github colours.

You may also disable colouring if you wish.

Plugin default: "github"

Type: null or one of “github”, “none” or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.iconGlyphSet

Icon glyph set to use.

Plugin default: "devicons"

Type: null or one of “devicons”, “emoji”, “ascii”, “ascii_hollow” or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.textColourSet

On unix, the command ls can produce coloured results based on the LS_COLORS environmental variable.

CHADTree can pretend it’s ls by setting chadtree.theme.textColourSet to env.

If you are not happy with that, you can choose one of the many others.

Plugin default: "env"

Type: null or one of “env”, “solarized_dark_256”, “solarized_dark”, “solarized_light”, “solarized_universal”, “nord”, “trapdoor”, “nerdtree_syntax_light”, “nerdtree_syntax_dark” or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.highlights.bookmarks

These are used to show bookmarks.

Plugin default: "Title"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.highlights.ignored

These are used for files that are ignored by user supplied pattern in chadtree.ignore and by version control.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.highlights.quickfix

These are used to notify the number of times a file / folder appears in the quickfix list.

Plugin default: "Label"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.chadtree.theme.highlights.versionControl

These are used to put a version control status beside each file.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.chadtree.view.openDirection

Which way does CHADTree open?

Plugin default: "left"

Type: null or one of “left”, “right” or raw lua code

Default: null

Declared by:

plugins.chadtree.view.sortBy

CHADTree can sort by the following criterion. Reorder them if you want a different sorting order. legal keys: some of ["is_folder" "ext" "file_name"]

Plugin default: ["is_folder" "ext" "file_name"]

Type: null or (list of string)

Default: null

Declared by:

plugins.chadtree.view.width

How big is CHADTree when initially opened?

Plugin default: 40

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.chadtree.view.windowOptions

Set of window local options to for CHADTree windows.

Plugin default:

{
    cursorline = true;
    number = false;
    relativenumber = false;
    signcolumn = "no";
    winfixwidth = true;
    wrap = false;
}

Type: null or (attribute set)

Default: null

Declared by:

plugins.clangd-extensions.enable

Whether to enable clangd_extensions, plugins implementing clangd LSP extensions.

Type: boolean

Default: false

Example: true

Declared by:

plugins.clangd-extensions.enableOffsetEncodingWorkaround

Whether to enable utf-16 offset encoding. This is used to work around the warning: “multiple different client offset_encodings detected for buffer, this is not supported yet” .

Type: boolean

Default: false

Example: true

Declared by:

plugins.clangd-extensions.package

Which package to use for the clangd_extensions.nvim plugin.

Type: package

Default: <derivation vimplugin-clangd_extensions.nvim-2024-05-04>

Declared by:

plugins.clangd-extensions.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.clangd-extensions.ast.highlights.detail

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.compound

Plugin default: "🄲"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.packExpansion

Plugin default: "🄿"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.recovery

Plugin default: "🅁"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.templateParamObject

Plugin default: "🅃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.templateTemplateParm

Plugin default: "🅃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.templateTypeParm

Plugin default: "🅃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.kindIcons.translationUnit

Plugin default: "🅄"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.declaration

Plugin default: "🄓"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.expression

Plugin default: "🄔"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.specifier

Plugin default: "🄢"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.statement

Plugin default: ";"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.templateArgument

Plugin default: "🆃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.ast.roleIcons.type

Plugin default: "🄣"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.highlight

The color of the hints.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.inline

Show hints inline.

Plugin default: vim.fn.has("nvim-0.10") == 1

Type: null or lua code string

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.maxLenAlign

Whether to align to the length of the longest line in the file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.maxLenAlignPadding

Padding from the left if max_len_align is true.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.onlyCurrentLine

Only show inlay hints for the current line

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.onlyCurrentLineAutocmd

Event which triggers a refersh of the inlay hints. You can make this “CursorMoved” or “CursorMoved,CursorMovedI” but not that this may cause higher CPU usage. This option is only respected when onlyCurrentLine is true.

Plugin default: "CursorHold"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.otherHintsPrefix

Prefix for all the other hints (type, chaining).

Plugin default: "=> "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.parameterHintsPrefix

Prefix for parameter hints.

Plugin default: "<- "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.priority

The highlight group priority for extmark.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.rightAlign

Whether to align to the extreme right or not.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.rightAlignPadding

Padding from the right if right_align is true.

Plugin default: 7

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.inlayHints.showParameterHints

Whether to show parameter hints with the inlay hints or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.memoryUsage.border

Defines the border to use for clangd-extensions. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: none

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.clangd-extensions.symbolInfo.border

Defines the border to use for clangd-extensions. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: none

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.enable

Whether to enable clipboard-image.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.clipboard-image.package

Which package to use for the clipboard-image.nvim plugin.

Type: package

Default: <derivation vimplugin-clipboard-image.nvim-2022-11-10>

Declared by:

plugins.clipboard-image.clipboardPackage

Which clipboard provider to use.

Recommended:

  • X11: pkgs.xclip
  • Wayland: pkgs.wl-clipboard
  • MacOS: pkgs.pngpaste

Type: null or package

Example: <derivation wl-clipboard-2.2.1>

Declared by:

plugins.clipboard-image.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.clipboard-image.default.affix

String that sandwiched the image’s path.

Default:

  • default: "{img_path}"
  • markdown: "![]({img_path})"

Note: Affix can be multi lines, like this:

# You can use line break escape sequence
affix = "<\n  %s\n>";

# Or lua's double square brackets
affix.__raw = \'\'
  [[<
    %s
  >]]
\'\'

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.default.imgDir

Dir name where the image will be pasted to.

Note: If you want to create nested dir, it is better to use table since windows and unix have different path separator.

Plugin default: img

Type: null or string or list of string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.default.imgDirTxt

Dir that will be inserted into text/buffer.

Plugin default: img

Type: null or string or list of string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.default.imgHandler

Function that will handle image after pasted.

Note: img is a table that contain pasted image’s {name} and {path}.

Plugin default: function(img) end

Type: null or lua function string

Default: null

Declared by:

plugins.clipboard-image.default.imgName

Image’s name.

Plugin default: "{__raw = \"function() return os.date('%Y-%m-%d-%H-%M-%S') end\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.filetypes

Override certain options for specific filetypes.

Type: attribute set of (submodule)

Default: { }

Example:

{
  markdown = {
    imgDir = [
      "src"
      "assets"
      "img"
    ];
    imgDirTxt = "/assets/img";
    imgHandler = ''
      function(img)
        local script = string.format('./image_compressor.sh "%s"', img.path)
        os.execute(script)
      end
    '';
  };
}

Declared by:

plugins.clipboard-image.filetypes.<name>.affix

String that sandwiched the image’s path.

Default:

  • default: "{img_path}"
  • markdown: "![]({img_path})"

Note: Affix can be multi lines, like this:

# You can use line break escape sequence
affix = "<\n  %s\n>";

# Or lua's double square brackets
affix.__raw = \'\'
  [[<
    %s
  >]]
\'\'

Type: null or string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.filetypes.<name>.imgDir

Dir name where the image will be pasted to.

Note: If you want to create nested dir, it is better to use table since windows and unix have different path separator.

Plugin default: img

Type: null or string or list of string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.filetypes.<name>.imgDirTxt

Dir that will be inserted into text/buffer.

Plugin default: img

Type: null or string or list of string or raw lua code

Default: null

Declared by:

plugins.clipboard-image.filetypes.<name>.imgHandler

Function that will handle image after pasted.

Note: img is a table that contain pasted image’s {name} and {path}.

Plugin default: function(img) end

Type: null or lua function string

Default: null

Declared by:

plugins.clipboard-image.filetypes.<name>.imgName

Image’s name.

Plugin default: "{__raw = \"function() return os.date('%Y-%m-%d-%H-%M-%S') end\";}"

Type: null or string or raw lua code

Default: null

Declared by:

cloak

Url: https://github.com/laytan/cloak.nvim/

Maintainers: Gaetan Lepage

plugins.cloak.enable

Whether to enable cloak.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cloak.package

Which package to use for the cloak.nvim plugin.

Type: package

Default: <derivation vimplugin-cloak.nvim-2024-03-23>

Declared by:

plugins.cloak.settings

Options provided to the require('cloak').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  cloak_character = "*";
  enabled = true;
  highlight_group = "Comment";
  patterns = [
    {
      cloak_pattern = "=.+";
      file_pattern = [
        ".env*"
        "wrangler.toml"
        ".dev.vars"
      ];
    }
  ];
}

Declared by:

plugins.cloak.settings.enabled

Whether to enable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cloak.settings.cloak_character

Define the cloak character.

Plugin default: "*"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cloak.settings.cloak_length

Provide a number if you want to hide the true length of the value. Applies the length of the replacement characters for all matched patterns, defaults to the length of the matched pattern.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cloak.settings.cloak_telescope

Set to true to cloak Telescope preview buffers. (Required feature not in 0.1.x)

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cloak.settings.highlight_group

The applied highlight group (colors) on the cloaking, see :h highlight.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cloak.settings.patterns

List of pattern configurations.

Plugin default:

[
  {

    file_pattern = ".env*";
    cloak_pattern = "=.+";
    replace = null;
  }
]

Type: null or (list of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.cloak.settings.try_all_patterns

Whether it should try every pattern to find the best fit or stop after the first.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

cmp

Url: https://github.com/hrsh7th/nvim-cmp/

Maintainers: Gaetan Lepage

plugins.cmp.enable

Whether to enable nvim-cmp.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cmp.package

Which package to use for the nvim-cmp plugin.

Type: package

Default: <derivation vimplugin-lua5.1-nvim-cmp-scm-1-unstable-2024-05-12>

Declared by:

plugins.cmp.autoEnableSources

Scans the sources array and installs the plugins if they are known to nixvim.

Type: boolean

Default: true

Declared by:

plugins.cmp.cmdline

Options for cmp.cmdline().

Type: attribute set of (attribute set of anything)

Default: { }

Example:

{
  "/" = {
    mapping = {
      __raw = "cmp.mapping.preset.cmdline()";
    };
    sources = [
      {
        name = "buffer";
      }
    ];
  };
  ":" = {
    mapping = {
      __raw = "cmp.mapping.preset.cmdline()";
    };
    sources = [
      {
        name = "path";
      }
      {
        name = "cmdline";
        option = {
          ignore_cmds = [
            "Man"
            "!"
          ];
        };
      }
    ];
  };
}

Declared by:

plugins.cmp.cmdline.<name>.experimental

Experimental features.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.cmp.cmdline.<name>.mapping

This option has no description.

Type: (attribute set of lua code string) or raw lua code

Default: { }

Example:

{
  "<C-Space>" = "cmp.mapping.complete()";
  "<C-d>" = "cmp.mapping.scroll_docs(-4)";
  "<C-e>" = "cmp.mapping.close()";
  "<C-f>" = "cmp.mapping.scroll_docs(4)";
  "<CR>" = "cmp.mapping.confirm({ select = true })";
  "<S-Tab>" = "cmp.mapping(cmp.mapping.select_prev_item(), {'i', 's'})";
  "<Tab>" = "cmp.mapping(cmp.mapping.select_next_item(), {'i', 's'})";
}

Declared by:

plugins.cmp.cmdline.<name>.preselect

  • “cmp.PreselectMode.Item”: nvim-cmp will preselect the item that the source specified.
  • “cmp.PreselectMode.None”: nvim-cmp will not preselect any items.

Plugin default: cmp.PreselectMode.Item

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.cmdline.<name>.sources

The sources to use. Can either be a list of sourceConfigs which will be made directly to a Lua object. Or it can be a raw lua string which might be necessary for more advanced use cases.

WARNING: If plugins.cmp.autoEnableSources Nixivm will automatically enable the corresponding source plugins. This will work only when this option is set to a list. If you use a raw lua string, you will need to explicitly enable the relevant source plugins in your nixvim configuration.

Default: []

Type: (list of (attribute set of anything)) or raw lua code

Default: [ ]

Example:

[
  {
    name = "nvim_lsp";
  }
  {
    name = "luasnip";
  }
  {
    name = "path";
  }
  {
    name = "buffer";
  }
]

Declared by:

plugins.cmp.cmdline.<name>.completion.autocomplete

The event to trigger autocompletion. If set to false, then completion is only invoked manually (e.g. by calling cmp.complete).

Plugin default: ["require('cmp.types').cmp.TriggerEvent.TextChanged"]

Type: null or value false (singular enum) or list of lua code string

Default: null

Declared by:

plugins.cmp.cmdline.<name>.completion.completeopt

Like vim’s completeopt setting. In general, you don’t need to change this.

Plugin default: "menu,menuone,noselect"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.completion.keyword_length

The number of characters needed to trigger auto-completion.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.completion.keyword_pattern

The default keyword pattern.

Plugin default: [[\%(-\?\d\+\%(\.\d\+\)\?\|\h\w*\%(-\w*\)*\)]]

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.cmdline.<name>.confirmation.get_commit_characters

You can append or exclude commitCharacters via this configuration option function. The commitCharacters are defined by the LSP spec.

Plugin default:

function(commit_characters)
  return commit_characters
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.cmdline.<name>.formatting.expandable_indicator

Boolean to show the ~ expandable indicator in cmp’s floating window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.formatting.fields

An array of completion fields to specify their order.

Plugin default: ["abbr" "kind" "menu"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp.cmdline.<name>.formatting.format

fun(entry: cmp.Entry, vim_item: vim.CompletedItem): vim.CompletedItem

The function used to customize the appearance of the completion menu. See |complete-items|. This value can also be used to modify the dup property.

NOTE: The vim.CompletedItem can contain the special properties abbr_hl_group, kind_hl_group and menu_hl_group.

Plugin default:

function(_, vim_item)
  return vim_item
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.cmdline.<name>.matching.disallow_fullfuzzy_matching

Whether to allow full-fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.matching.disallow_fuzzy_matching

Whether to allow fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.matching.disallow_partial_fuzzy_matching

Whether to allow fuzzy matching without prefix matching.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.matching.disallow_partial_matching

Whether to allow partial matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.matching.disallow_prefix_unmatching

Whether to allow prefix unmatching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.async_budget

Maximum time (in ms) an async function is allowed to run during one step of the event loop.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.confirm_resolve_timeout

Sets the timeout for resolving item before confirmation.

Plugin default: 80

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.debounce

Sets debounce time. This is the interval used to group up completions from different sources for filtering and displaying.

Plugin default: 60

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.fetching_timeout

Sets the timeout of candidate fetching process. The nvim-cmp will wait to display the most prioritized source.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.max_view_entries

Maximum number of items to show in the entries list.

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.performance.throttle

Sets throttle time. This is used to delay filtering and displaying completions.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.snippet.expand

The snippet expansion function. That’s how nvim-cmp interacts with a particular snippet engine.

Common engines:

  function(args)
    # vsnip
    vim.fn["vsnip#anonymous"](args.body)

    # luasnip
    require('luasnip').lsp_expand(args.body)

    # snippy
    require('snippy').expand_snippet(args.body)

    # ultisnips
    vim.fn["UltiSnips#Anon"](args.body)
  end

You can also provide a custom function:

  function(args)
    vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
    -- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
    -- require('snippy').expand_snippet(args.body) -- For `snippy` users.
    -- vim.fn["UltiSnips#Anon"](args.body) -- For `ultisnips` users.
  end

Type: null or lua function string

Default: null

Example:

''
  function(args)
    require('luasnip').lsp_expand(args.body)
  end
''

Declared by:

plugins.cmp.cmdline.<name>.sorting.comparators

The function to customize the sorting behavior. You can use built-in comparators via cmp.config.compare.*.

Signature: (fun(entry1: cmp.Entry, entry2: cmp.Entry): boolean | nil)[]

Default:

[
  "require('cmp.config.compare').offset"
  "require('cmp.config.compare').exact"
  "require('cmp.config.compare').score"
  "require('cmp.config.compare').recently_used"
  "require('cmp.config.compare').locality"
  "require('cmp.config.compare').kind"
  "require('cmp.config.compare').length"
  "require('cmp.config.compare').order"
]

Type: null or (list of lua function string)

Default: null

Declared by:

plugins.cmp.cmdline.<name>.sorting.priority_weight

Each item’s original priority (given by its corresponding source) will be increased by #sources - (source_index - 1) and multiplied by priority_weight.

That is, the final priority is calculated by the following formula: final_score = orig_score + ((#sources - (source_index - 1)) * sorting.priority_weight)

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.view.entries

The view class used to customize nvim-cmp’s appearance.

Plugin default:

{
  name = "custom";
  selection_order = "top_down";
}

Type: null or string or attribute set of anything

Default: null

Declared by:

plugins.cmp.cmdline.<name>.view.docs.auto_open

Specify whether to show the docs_view when selecting an item.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.border

Defines the border to use for nvim-cmp completion popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" "" "" "" "" "" ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.col_offset

Offsets the completion window relative to the cursor.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.scrollbar

Whether the scrollbar should be enabled if there are more items that fit.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.scrolloff

Specify the window’s scrolloff option. See |‘scrolloff’|.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.side_padding

The amount of padding to add on the completion window’s sides.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "Normal:Pmenu,FloatBorder:Pmenu,CursorLine:PmenuSel,Search:None"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.completion.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.documentation.border

Defines the border to use for nvim-cmp documentation popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" " " "" "" "" " " ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.documentation.max_height

The documentation window’s max height.

Default: “math.floor(40 * (40 / vim.o.lines))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.documentation.max_width

The documentation window’s max width.

Default: “math.floor((40 * 2) * (vim.o.columns / (40 * 2 * 16 / 9)))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.documentation.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "FloatBorder:NormalFloat"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.cmdline.<name>.window.documentation.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.filetype

Options for cmp.filetype().

Type: attribute set of (attribute set of anything)

Default: { }

Example:

{
  python = {
    sources = [
      {
        name = "nvim_lsp";
      }
    ];
  };
}

Declared by:

plugins.cmp.filetype.<name>.experimental

Experimental features.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.cmp.filetype.<name>.mapping

This option has no description.

Type: (attribute set of lua code string) or raw lua code

Default: { }

Example:

{
  "<C-Space>" = "cmp.mapping.complete()";
  "<C-d>" = "cmp.mapping.scroll_docs(-4)";
  "<C-e>" = "cmp.mapping.close()";
  "<C-f>" = "cmp.mapping.scroll_docs(4)";
  "<CR>" = "cmp.mapping.confirm({ select = true })";
  "<S-Tab>" = "cmp.mapping(cmp.mapping.select_prev_item(), {'i', 's'})";
  "<Tab>" = "cmp.mapping(cmp.mapping.select_next_item(), {'i', 's'})";
}

Declared by:

plugins.cmp.filetype.<name>.preselect

  • “cmp.PreselectMode.Item”: nvim-cmp will preselect the item that the source specified.
  • “cmp.PreselectMode.None”: nvim-cmp will not preselect any items.

Plugin default: cmp.PreselectMode.Item

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.filetype.<name>.sources

The sources to use. Can either be a list of sourceConfigs which will be made directly to a Lua object. Or it can be a raw lua string which might be necessary for more advanced use cases.

WARNING: If plugins.cmp.autoEnableSources Nixivm will automatically enable the corresponding source plugins. This will work only when this option is set to a list. If you use a raw lua string, you will need to explicitly enable the relevant source plugins in your nixvim configuration.

Default: []

Type: (list of (attribute set of anything)) or raw lua code

Default: [ ]

Example:

[
  {
    name = "nvim_lsp";
  }
  {
    name = "luasnip";
  }
  {
    name = "path";
  }
  {
    name = "buffer";
  }
]

Declared by:

plugins.cmp.filetype.<name>.completion.autocomplete

The event to trigger autocompletion. If set to false, then completion is only invoked manually (e.g. by calling cmp.complete).

Plugin default: ["require('cmp.types').cmp.TriggerEvent.TextChanged"]

Type: null or value false (singular enum) or list of lua code string

Default: null

Declared by:

plugins.cmp.filetype.<name>.completion.completeopt

Like vim’s completeopt setting. In general, you don’t need to change this.

Plugin default: "menu,menuone,noselect"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.completion.keyword_length

The number of characters needed to trigger auto-completion.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.completion.keyword_pattern

The default keyword pattern.

Plugin default: [[\%(-\?\d\+\%(\.\d\+\)\?\|\h\w*\%(-\w*\)*\)]]

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.filetype.<name>.confirmation.get_commit_characters

You can append or exclude commitCharacters via this configuration option function. The commitCharacters are defined by the LSP spec.

Plugin default:

function(commit_characters)
  return commit_characters
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.filetype.<name>.formatting.expandable_indicator

Boolean to show the ~ expandable indicator in cmp’s floating window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.formatting.fields

An array of completion fields to specify their order.

Plugin default: ["abbr" "kind" "menu"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp.filetype.<name>.formatting.format

fun(entry: cmp.Entry, vim_item: vim.CompletedItem): vim.CompletedItem

The function used to customize the appearance of the completion menu. See |complete-items|. This value can also be used to modify the dup property.

NOTE: The vim.CompletedItem can contain the special properties abbr_hl_group, kind_hl_group and menu_hl_group.

Plugin default:

function(_, vim_item)
  return vim_item
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.filetype.<name>.matching.disallow_fullfuzzy_matching

Whether to allow full-fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.matching.disallow_fuzzy_matching

Whether to allow fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.matching.disallow_partial_fuzzy_matching

Whether to allow fuzzy matching without prefix matching.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.matching.disallow_partial_matching

Whether to allow partial matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.matching.disallow_prefix_unmatching

Whether to allow prefix unmatching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.async_budget

Maximum time (in ms) an async function is allowed to run during one step of the event loop.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.confirm_resolve_timeout

Sets the timeout for resolving item before confirmation.

Plugin default: 80

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.debounce

Sets debounce time. This is the interval used to group up completions from different sources for filtering and displaying.

Plugin default: 60

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.fetching_timeout

Sets the timeout of candidate fetching process. The nvim-cmp will wait to display the most prioritized source.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.max_view_entries

Maximum number of items to show in the entries list.

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.performance.throttle

Sets throttle time. This is used to delay filtering and displaying completions.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.snippet.expand

The snippet expansion function. That’s how nvim-cmp interacts with a particular snippet engine.

Common engines:

  function(args)
    # vsnip
    vim.fn["vsnip#anonymous"](args.body)

    # luasnip
    require('luasnip').lsp_expand(args.body)

    # snippy
    require('snippy').expand_snippet(args.body)

    # ultisnips
    vim.fn["UltiSnips#Anon"](args.body)
  end

You can also provide a custom function:

  function(args)
    vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
    -- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
    -- require('snippy').expand_snippet(args.body) -- For `snippy` users.
    -- vim.fn["UltiSnips#Anon"](args.body) -- For `ultisnips` users.
  end

Type: null or lua function string

Default: null

Example:

''
  function(args)
    require('luasnip').lsp_expand(args.body)
  end
''

Declared by:

plugins.cmp.filetype.<name>.sorting.comparators

The function to customize the sorting behavior. You can use built-in comparators via cmp.config.compare.*.

Signature: (fun(entry1: cmp.Entry, entry2: cmp.Entry): boolean | nil)[]

Default:

[
  "require('cmp.config.compare').offset"
  "require('cmp.config.compare').exact"
  "require('cmp.config.compare').score"
  "require('cmp.config.compare').recently_used"
  "require('cmp.config.compare').locality"
  "require('cmp.config.compare').kind"
  "require('cmp.config.compare').length"
  "require('cmp.config.compare').order"
]

Type: null or (list of lua function string)

Default: null

Declared by:

plugins.cmp.filetype.<name>.sorting.priority_weight

Each item’s original priority (given by its corresponding source) will be increased by #sources - (source_index - 1) and multiplied by priority_weight.

That is, the final priority is calculated by the following formula: final_score = orig_score + ((#sources - (source_index - 1)) * sorting.priority_weight)

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.view.entries

The view class used to customize nvim-cmp’s appearance.

Plugin default:

{
  name = "custom";
  selection_order = "top_down";
}

Type: null or string or attribute set of anything

Default: null

Declared by:

plugins.cmp.filetype.<name>.view.docs.auto_open

Specify whether to show the docs_view when selecting an item.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.border

Defines the border to use for nvim-cmp completion popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" "" "" "" "" "" ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.col_offset

Offsets the completion window relative to the cursor.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.scrollbar

Whether the scrollbar should be enabled if there are more items that fit.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.scrolloff

Specify the window’s scrolloff option. See |‘scrolloff’|.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.side_padding

The amount of padding to add on the completion window’s sides.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "Normal:Pmenu,FloatBorder:Pmenu,CursorLine:PmenuSel,Search:None"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.completion.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.documentation.border

Defines the border to use for nvim-cmp documentation popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" " " "" "" "" " " ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.documentation.max_height

The documentation window’s max height.

Default: “math.floor(40 * (40 / vim.o.lines))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.documentation.max_width

The documentation window’s max width.

Default: “math.floor((40 * 2) * (vim.o.columns / (40 * 2 * 16 / 9)))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.documentation.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "FloatBorder:NormalFloat"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.filetype.<name>.window.documentation.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.settings

Options provided to the require('cmp').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  mapping = {
    __raw = ''
      cmp.mapping.preset.insert({
        ['<C-b>'] = cmp.mapping.scroll_docs(-4),
        ['<C-f>'] = cmp.mapping.scroll_docs(4),
        ['<C-Space>'] = cmp.mapping.complete(),
        ['<C-e>'] = cmp.mapping.abort(),
        ['<CR>'] = cmp.mapping.confirm({ select = true }),
      })
    '';
  };
  snippet = {
    expand = "function(args) require('luasnip').lsp_expand(args.body) end";
  };
  sources = {
    __raw = ''
      cmp.config.sources({
        { name = 'nvim_lsp' },
        { name = 'vsnip' },
        -- { name = 'luasnip' },
        -- { name = 'ultisnips' },
        -- { name = 'snippy' },
      }, {
        { name = 'buffer' },
      })
    '';
  };
}

Declared by:

plugins.cmp.settings.experimental

Experimental features.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.cmp.settings.mapping

This option has no description.

Type: (attribute set of lua code string) or raw lua code

Default: { }

Example:

{
  "<C-Space>" = "cmp.mapping.complete()";
  "<C-d>" = "cmp.mapping.scroll_docs(-4)";
  "<C-e>" = "cmp.mapping.close()";
  "<C-f>" = "cmp.mapping.scroll_docs(4)";
  "<CR>" = "cmp.mapping.confirm({ select = true })";
  "<S-Tab>" = "cmp.mapping(cmp.mapping.select_prev_item(), {'i', 's'})";
  "<Tab>" = "cmp.mapping(cmp.mapping.select_next_item(), {'i', 's'})";
}

Declared by:

plugins.cmp.settings.preselect

  • “cmp.PreselectMode.Item”: nvim-cmp will preselect the item that the source specified.
  • “cmp.PreselectMode.None”: nvim-cmp will not preselect any items.

Plugin default: cmp.PreselectMode.Item

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.settings.sources

The sources to use. Can either be a list of sourceConfigs which will be made directly to a Lua object. Or it can be a raw lua string which might be necessary for more advanced use cases.

WARNING: If plugins.cmp.autoEnableSources Nixivm will automatically enable the corresponding source plugins. This will work only when this option is set to a list. If you use a raw lua string, you will need to explicitly enable the relevant source plugins in your nixvim configuration.

Default: []

Type: (list of (attribute set of anything)) or raw lua code

Default: [ ]

Example:

[
  {
    name = "nvim_lsp";
  }
  {
    name = "luasnip";
  }
  {
    name = "path";
  }
  {
    name = "buffer";
  }
]

Declared by:

plugins.cmp.settings.completion.autocomplete

The event to trigger autocompletion. If set to false, then completion is only invoked manually (e.g. by calling cmp.complete).

Plugin default: ["require('cmp.types').cmp.TriggerEvent.TextChanged"]

Type: null or value false (singular enum) or list of lua code string

Default: null

Declared by:

plugins.cmp.settings.completion.completeopt

Like vim’s completeopt setting. In general, you don’t need to change this.

Plugin default: "menu,menuone,noselect"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.settings.completion.keyword_length

The number of characters needed to trigger auto-completion.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.completion.keyword_pattern

The default keyword pattern.

Plugin default: [[\%(-\?\d\+\%(\.\d\+\)\?\|\h\w*\%(-\w*\)*\)]]

Type: null or lua code string

Default: null

Declared by:

plugins.cmp.settings.confirmation.get_commit_characters

You can append or exclude commitCharacters via this configuration option function. The commitCharacters are defined by the LSP spec.

Plugin default:

function(commit_characters)
  return commit_characters
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.settings.formatting.expandable_indicator

Boolean to show the ~ expandable indicator in cmp’s floating window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.formatting.fields

An array of completion fields to specify their order.

Plugin default: ["abbr" "kind" "menu"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp.settings.formatting.format

fun(entry: cmp.Entry, vim_item: vim.CompletedItem): vim.CompletedItem

The function used to customize the appearance of the completion menu. See |complete-items|. This value can also be used to modify the dup property.

NOTE: The vim.CompletedItem can contain the special properties abbr_hl_group, kind_hl_group and menu_hl_group.

Plugin default:

function(_, vim_item)
  return vim_item
end

Type: null or lua function string

Default: null

Declared by:

plugins.cmp.settings.matching.disallow_fullfuzzy_matching

Whether to allow full-fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.matching.disallow_fuzzy_matching

Whether to allow fuzzy matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.matching.disallow_partial_fuzzy_matching

Whether to allow fuzzy matching without prefix matching.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.matching.disallow_partial_matching

Whether to allow partial matching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.matching.disallow_prefix_unmatching

Whether to allow prefix unmatching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.async_budget

Maximum time (in ms) an async function is allowed to run during one step of the event loop.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.confirm_resolve_timeout

Sets the timeout for resolving item before confirmation.

Plugin default: 80

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.debounce

Sets debounce time. This is the interval used to group up completions from different sources for filtering and displaying.

Plugin default: 60

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.fetching_timeout

Sets the timeout of candidate fetching process. The nvim-cmp will wait to display the most prioritized source.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.max_view_entries

Maximum number of items to show in the entries list.

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.performance.throttle

Sets throttle time. This is used to delay filtering and displaying completions.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.snippet.expand

The snippet expansion function. That’s how nvim-cmp interacts with a particular snippet engine.

Common engines:

  function(args)
    # vsnip
    vim.fn["vsnip#anonymous"](args.body)

    # luasnip
    require('luasnip').lsp_expand(args.body)

    # snippy
    require('snippy').expand_snippet(args.body)

    # ultisnips
    vim.fn["UltiSnips#Anon"](args.body)
  end

You can also provide a custom function:

  function(args)
    vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
    -- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
    -- require('snippy').expand_snippet(args.body) -- For `snippy` users.
    -- vim.fn["UltiSnips#Anon"](args.body) -- For `ultisnips` users.
  end

Type: null or lua function string

Default: null

Example:

''
  function(args)
    require('luasnip').lsp_expand(args.body)
  end
''

Declared by:

plugins.cmp.settings.sorting.comparators

The function to customize the sorting behavior. You can use built-in comparators via cmp.config.compare.*.

Signature: (fun(entry1: cmp.Entry, entry2: cmp.Entry): boolean | nil)[]

Default:

[
  "require('cmp.config.compare').offset"
  "require('cmp.config.compare').exact"
  "require('cmp.config.compare').score"
  "require('cmp.config.compare').recently_used"
  "require('cmp.config.compare').locality"
  "require('cmp.config.compare').kind"
  "require('cmp.config.compare').length"
  "require('cmp.config.compare').order"
]

Type: null or (list of lua function string)

Default: null

Declared by:

plugins.cmp.settings.sorting.priority_weight

Each item’s original priority (given by its corresponding source) will be increased by #sources - (source_index - 1) and multiplied by priority_weight.

That is, the final priority is calculated by the following formula: final_score = orig_score + ((#sources - (source_index - 1)) * sorting.priority_weight)

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.view.entries

The view class used to customize nvim-cmp’s appearance.

Plugin default:

{
  name = "custom";
  selection_order = "top_down";
}

Type: null or string or attribute set of anything

Default: null

Declared by:

plugins.cmp.settings.view.docs.auto_open

Specify whether to show the docs_view when selecting an item.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.border

Defines the border to use for nvim-cmp completion popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" "" "" "" "" "" ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.col_offset

Offsets the completion window relative to the cursor.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.scrollbar

Whether the scrollbar should be enabled if there are more items that fit.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.scrolloff

Specify the window’s scrolloff option. See |‘scrolloff’|.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.side_padding

The amount of padding to add on the completion window’s sides.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "Normal:Pmenu,FloatBorder:Pmenu,CursorLine:PmenuSel,Search:None"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.completion.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.settings.window.documentation.border

Defines the border to use for nvim-cmp documentation popup menu. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: [ "" "" "" " " "" "" "" " " ]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.documentation.max_height

The documentation window’s max height.

Default: “math.floor(40 * (40 / vim.o.lines))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.settings.window.documentation.max_width

The documentation window’s max width.

Default: “math.floor((40 * 2) * (vim.o.columns / (40 * 2 * 16 / 9)))”

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.cmp.settings.window.documentation.winhighlight

Specify the window’s winhighlight option. See |nvim_open_win|.

Plugin default: "FloatBorder:NormalFloat"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp.settings.window.documentation.zindex

The window’s zindex. See |nvim_open_win|.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

cmp-async-path

Maintainers: Gaetan Lepage

plugins.cmp-async-path.enable

Whether to enable cmp-async-path.

Type: boolean

Default: false

Example: true

Declared by:

cmp-buffer

Maintainers: Gaetan Lepage

plugins.cmp-buffer.enable

Whether to enable cmp-buffer.

Type: boolean

Default: false

Example: true

Declared by:

cmp-calc

Maintainers: Gaetan Lepage

plugins.cmp-calc.enable

Whether to enable cmp-calc.

Type: boolean

Default: false

Example: true

Declared by:

cmp-clippy

Maintainers: Gaetan Lepage

plugins.cmp-clippy.enable

Whether to enable cmp-clippy.

Type: boolean

Default: false

Example: true

Declared by:

cmp-cmdline

Maintainers: Gaetan Lepage

plugins.cmp-cmdline.enable

Whether to enable cmp-cmdline.

Type: boolean

Default: false

Example: true

Declared by:

cmp-cmdline-history

Maintainers: Gaetan Lepage

plugins.cmp-cmdline-history.enable

Whether to enable cmp-cmdline-history.

Type: boolean

Default: false

Example: true

Declared by:

cmp-conventionalcommits

Maintainers: Gaetan Lepage

plugins.cmp-conventionalcommits.enable

Whether to enable cmp-conventionalcommits.

Type: boolean

Default: false

Example: true

Declared by:

cmp-dap

Maintainers: Gaetan Lepage

plugins.cmp-dap.enable

Whether to enable cmp-dap.

Type: boolean

Default: false

Example: true

Declared by:

cmp-dictionary

Maintainers: Gaetan Lepage

plugins.cmp-dictionary.enable

Whether to enable cmp-dictionary.

Type: boolean

Default: false

Example: true

Declared by:

cmp-digraphs

Maintainers: Gaetan Lepage

plugins.cmp-digraphs.enable

Whether to enable cmp-digraphs.

Type: boolean

Default: false

Example: true

Declared by:

cmp-emoji

Maintainers: Gaetan Lepage

plugins.cmp-emoji.enable

Whether to enable cmp-emoji.

Type: boolean

Default: false

Example: true

Declared by:

cmp-fish

Maintainers: Gaetan Lepage

plugins.cmp-fish.enable

Whether to enable cmp-fish.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cmp-fish.fishPackage

Which package to use for fish. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation fish-3.7.1>

Declared by:

cmp-fuzzy-buffer

Maintainers: Gaetan Lepage

plugins.cmp-fuzzy-buffer.enable

Whether to enable cmp-fuzzy-buffer.

Type: boolean

Default: false

Example: true

Declared by:

cmp-fuzzy-path

Maintainers: Gaetan Lepage

plugins.cmp-fuzzy-path.enable

Whether to enable cmp-fuzzy-path.

Type: boolean

Default: false

Example: true

Declared by:

cmp-git

Maintainers: Gaetan Lepage

plugins.cmp-git.enable

Whether to enable cmp-git.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cmp-git.settings

Options provided to the require('cmp_git').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  github = {
    issues = {
      filter = "all";
      filter_fn = {
        __raw = ''
          function(trigger_char, issue)
            return string.format('%s %s %s', trigger_char, issue.number, issue.title)
          end
        '';
      };
      format = {
        label = {
          __raw = ''
            function(_, issue)
              local icon = ({
                open = '',
                closed = '',
              })[string.lower(issue.state)]
              return string.format('%s #%d: %s', icon, issue.number, issue.title)
            end
          '';
        };
      };
      limit = 250;
      sort_by = {
        __raw = ''
          function(issue)
            local kind_rank = issue.pull_request and 1 or 0
            local state_rank = issue.state == 'open' and 0 or 1
            local age = os.difftime(os.time(), require('cmp_git.utils').parse_github_date(issue.updatedAt))
            return string.format('%d%d%010d', kind_rank, state_rank, age)
          end
        '';
      };
      state = "all";
    };
  };
  remotes = [
    "upstream"
    "origin"
    "foo"
  ];
  trigger_actions = [
    {
      action = ''
        function(sources, trigger_char, callback, params, git_info)
          return sources.git:get_commits(callback, params, trigger_char)
        end
      '';
      debug_name = "git_commits";
      trigger_character = ":";
    }
    {
      action = ''
        function(sources, trigger_char, callback, params, git_info)
          return sources.github:get_issues(callback, git_info, trigger_char)
        end
      '';
      debug_name = "github_issues";
      trigger_character = "#";
    }
  ];
}

Declared by:

plugins.cmp-git.settings.enableRemoteUrlRewrites

Whether to enable remote URL rewrites.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.filetypes

Filetypes for which to trigger.

Plugin default: ["gitcommit" "octo"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.remotes

List of git remotes.

Plugin default: ["upstream" "origin"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.trigger_actions

If you want specific behaviour for a trigger or new behaviour for a trigger, you need to add an entry in the trigger_actions list of the config. The two necessary fields are the trigger_character and the action.

Plugin default:

[
  {
    debug_name = "git_commits";
    trigger_character = ":";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
        return sources.git:get_commits(callback, params, trigger_char)
      end
    \'\';
  }
  {
    debug_name = "gitlab_issues";
    trigger_character = "#";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
          return sources.gitlab:get_issues(callback, git_info, trigger_char)
      end
    \'\';
  }
  {
    debug_name = "gitlab_mentions";
    trigger_character = "@";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
          return sources.gitlab:get_mentions(callback, git_info, trigger_char)
      end
    \'\';
  }
  {
    debug_name = "gitlab_mrs";
    trigger_character = "!";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
        return sources.gitlab:get_merge_requests(callback, git_info, trigger_char)
      end
    \'\';
  }
  {
    debug_name = "github_issues_and_pr";
    trigger_character = "#";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
        return sources.github:get_issues_and_prs(callback, git_info, trigger_char)
      end
    \'\';
  }
  {
    debug_name = "github_mentions";
    trigger_character = "@";
    action = \'\'
      function(sources, trigger_char, callback, params, git_info)
        return sources.github:get_mentions(callback, git_info, trigger_char)
      end
    \'\';
  }
]

Type: null or (list of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.git.commits.format

Function used to format the commits.

Plugin default: {__raw = "require('cmp_git.format').git.commits";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.git.commits.limit

Max number of git commits to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.git.commits.sort_by

Function used to sort the commits.

Plugin default: {__raw = "require('cmp_git.sort').git.commits";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.hosts

List of private instances of github.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.fields

The fields used for issues.

Plugin default: ["title" "number" "body" "updatedAt" "state"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.filter

The filter to use when fetching issues.

Plugin default: "all"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.format

Function used to format the issues.

Plugin default: {__raw = "require('cmp_git.format').github.issues";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.limit

Max number of issues to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.sort_by

Function used to sort the issues.

Plugin default: {__raw = "require('cmp_git.sort').github.issues";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.issues.state

Which issues to fetch ("open", "closed" or "all").

Plugin default: "open"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.github.mentions.format

Function used to format the mentions.

Plugin default: {__raw = "require('cmp_git.format').github.mentions";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.mentions.limit

Max number of mentions to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.github.mentions.sort_by

Function used to sort the mentions.

Plugin default: {__raw = "require('cmp_git.sort').github.mentions";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.pull_requests.fields

The fields used for pull requests.

Plugin default: ["title" "number" "body" "updatedAt" "state"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.github.pull_requests.format

Function used to format the pull requests.

Plugin default: {__raw = "require('cmp_git.format').github.pull_requests";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.pull_requests.limit

Max number of pull requests to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.github.pull_requests.sort_by

Function used to sort the pull requests.

Plugin default: {__raw = "require('cmp_git.sort').github.pull_requests";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.github.pull_requests.state

Which issues to fetch ("open", "closed", "merged" or "all").

Plugin default: "open"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.hosts

List of private instances of gitlab.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.issues.format

Function used to format the issues.

Plugin default: {__raw = "require('cmp_git.format').gitlab.issues";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.issues.limit

Max number of issues to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.issues.sort_by

Function used to sort the issues.

Plugin default: {__raw = "require('cmp_git.sort').gitlab.issues";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.issues.state

Which issues to fetch ("open", "closed" or "all").

Plugin default: "open"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.mentions.format

Function used to format the mentions.

Plugin default: {__raw = "require('cmp_git.format').gitlab.mentions";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.mentions.limit

Max number of mentions to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.mentions.sort_by

Function used to sort the mentions.

Plugin default: {__raw = "require('cmp_git.sort').gitlab.mentions";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.merge_requests.format

Function used to format the merge requests.

Plugin default: {__raw = "require('cmp_git.format').gitlab.merge_requests";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.merge_requests.limit

Max number of merge requests to fetch.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.merge_requests.sort_by

Function used to sort the merge requests.

Plugin default: {__raw = "require('cmp_git.sort').gitlab.merge_requests";}

Type: null or anything

Default: null

Declared by:

plugins.cmp-git.settings.gitlab.merge_requests.state

Which issues to fetch ("open", "closed", "locked" or "merged").

Plugin default: "open"

Type: null or string or raw lua code

Default: null

Declared by:

cmp-greek

Maintainers: Gaetan Lepage

plugins.cmp-greek.enable

Whether to enable cmp-greek.

Type: boolean

Default: false

Example: true

Declared by:

cmp-latex-symbols

Maintainers: Gaetan Lepage

plugins.cmp-latex-symbols.enable

Whether to enable cmp-latex-symbols.

Type: boolean

Default: false

Example: true

Declared by:

cmp-look

Maintainers: Gaetan Lepage

plugins.cmp-look.enable

Whether to enable cmp-look.

Type: boolean

Default: false

Example: true

Declared by:

cmp-npm

Maintainers: Gaetan Lepage

plugins.cmp-npm.enable

Whether to enable cmp-npm.

Type: boolean

Default: false

Example: true

Declared by:

cmp-nvim-lsp

Maintainers: Gaetan Lepage

plugins.cmp-nvim-lsp.enable

Whether to enable cmp-nvim-lsp.

Type: boolean

Default: false

Example: true

Declared by:

cmp-nvim-lsp-document-symbol

Maintainers: Gaetan Lepage

plugins.cmp-nvim-lsp-document-symbol.enable

Whether to enable cmp-nvim-lsp-document-symbol.

Type: boolean

Default: false

Example: true

Declared by:

cmp-nvim-lsp-signature-help

Maintainers: Gaetan Lepage

plugins.cmp-nvim-lsp-signature-help.enable

Whether to enable cmp-nvim-lsp-signature-help.

Type: boolean

Default: false

Example: true

Declared by:

cmp-nvim-lua

Maintainers: Gaetan Lepage

plugins.cmp-nvim-lua.enable

Whether to enable cmp-nvim-lua.

Type: boolean

Default: false

Example: true

Declared by:

cmp-nvim-ultisnips

Maintainers: Gaetan Lepage

plugins.cmp-nvim-ultisnips.enable

Whether to enable cmp-nvim-ultisnips.

Type: boolean

Default: false

Example: true

Declared by:

cmp-omni

Maintainers: Gaetan Lepage

plugins.cmp-omni.enable

Whether to enable cmp-omni.

Type: boolean

Default: false

Example: true

Declared by:

cmp-pandoc-nvim

Maintainers: Gaetan Lepage

plugins.cmp-pandoc-nvim.enable

Whether to enable cmp-pandoc-nvim.

Type: boolean

Default: false

Example: true

Declared by:

cmp-pandoc-references

Maintainers: Gaetan Lepage

plugins.cmp-pandoc-references.enable

Whether to enable cmp-pandoc-references.

Type: boolean

Default: false

Example: true

Declared by:

cmp-path

Maintainers: Gaetan Lepage

plugins.cmp-path.enable

Whether to enable cmp-path.

Type: boolean

Default: false

Example: true

Declared by:

cmp-rg

Maintainers: Gaetan Lepage

plugins.cmp-rg.enable

Whether to enable cmp-rg.

Type: boolean

Default: false

Example: true

Declared by:

cmp-snippy

Maintainers: Gaetan Lepage

plugins.cmp-snippy.enable

Whether to enable cmp-snippy.

Type: boolean

Default: false

Example: true

Declared by:

cmp-spell

Maintainers: Gaetan Lepage

plugins.cmp-spell.enable

Whether to enable cmp-spell.

Type: boolean

Default: false

Example: true

Declared by:

cmp-tabby

Maintainers: Gaetan Lepage

plugins.cmp-tabby.enable

Whether to enable cmp-tabby.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cmp-tabby.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.cmp-tabby.host

The address of the tabby host server.

Plugin default: "http://localhost:5000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.cmp-tabby.maxLines

The max number of lines to complete.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.cmp-tabby.runOnEveryKeyStroke

Whether to run the completion on every keystroke.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cmp-tabby.stop

Plugin default: ["\n"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

cmp-tabnine

Maintainers: Gaetan Lepage

plugins.cmp-tabnine.enable

Whether to enable cmp-tabnine.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cmp-tabnine.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

cmp-tmux

Maintainers: Gaetan Lepage

plugins.cmp-tmux.enable

Whether to enable cmp-tmux.

Type: boolean

Default: false

Example: true

Declared by:

cmp-treesitter

Maintainers: Gaetan Lepage

plugins.cmp-treesitter.enable

Whether to enable cmp-treesitter.

Type: boolean

Default: false

Example: true

Declared by:

cmp-vim-lsp

Maintainers: Gaetan Lepage

plugins.cmp-vim-lsp.enable

Whether to enable cmp-vim-lsp.

Type: boolean

Default: false

Example: true

Declared by:

cmp-vimwiki-tags

Maintainers: Gaetan Lepage

plugins.cmp-vimwiki-tags.enable

Whether to enable cmp-vimwiki-tags.

Type: boolean

Default: false

Example: true

Declared by:

cmp-vsnip

Maintainers: Gaetan Lepage

plugins.cmp-vsnip.enable

Whether to enable cmp-vsnip.

Type: boolean

Default: false

Example: true

Declared by:

cmp-zsh

Maintainers: Gaetan Lepage

plugins.cmp-zsh.enable

Whether to enable cmp-zsh.

Type: boolean

Default: false

Example: true

Declared by:

cmp_luasnip

Maintainers: Gaetan Lepage

plugins.cmp_luasnip.enable

Whether to enable cmp_luasnip.

Type: boolean

Default: false

Example: true

Declared by:

cmp_yanky

Maintainers: Gaetan Lepage

plugins.cmp_yanky.enable

Whether to enable cmp_yanky.

Type: boolean

Default: false

Example: true

Declared by:

codeium-nvim

Maintainers: Gaetan Lepage

plugins.codeium-nvim.enable

Whether to enable codeium-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.codeium-nvim.package

Which package to use for the codeium.nvim plugin.

Type: package

Default: <derivation vimplugin-codeium.nvim-2024-05-03>

Declared by:

plugins.codeium-nvim.binPath

The path to the directory where the Codeium server will be downloaded to.

Plugin default: "{__raw = \"vim.fn.stdpath('cache') .. '/codeium/bin'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-nvim.configPath

The path to the config file, used to store the API key.

Plugin default: "{__raw = \"vim.fn.stdpath('cache') .. '/codeium/config.json'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-nvim.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.codeium-nvim.wrapper

The path to a wrapper script/binary that is used to execute any binaries not listed under tools. This is primarily useful for NixOS, where a FHS wrapper can be used for the downloaded codeium server.

Type: null or string

Default: null

Declared by:

plugins.codeium-nvim.api.host

The hostname of the API server to use.

Plugin default: "server.codeium.com"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-nvim.api.port

The port of the API server to use.

Plugin default: 443

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.codeium-nvim.tools.curl

The path to the curl binary.

Type: null or string

Default: null

Declared by:

plugins.codeium-nvim.tools.gzip

The path to the gzip binary.

Type: null or string

Default: null

Declared by:

plugins.codeium-nvim.tools.languageServer

The path to the language server downloaded from the official source.

Type: null or string

Default: null

Declared by:

plugins.codeium-nvim.tools.uname

The path to the uname binary.

Type: null or string

Default: null

Declared by:

plugins.codeium-nvim.tools.uuidgen

The path to the uuidgen binary.

Type: null or string

Default: null

Declared by:

codeium-vim

Url: https://github.com/Exafunction/codeium.vim/

Maintainers: Gaetan Lepage

plugins.codeium-vim.enable

Whether to enable codeium.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.codeium-vim.package

Which package to use for the codeium-vim plugin.

Type: package

Default: <derivation vimplugin-codeium.vim-2024-05-03>

Declared by:

plugins.codeium-vim.keymaps.accept

Keymap for inserting the proposed suggestion. Command: vim.fn['codeium#Accept']()

Plugin default: "<Tab>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-vim.keymaps.clear

Keymap for clearing current suggestion. Command: vim.fn['codeium#Clear']()

Plugin default: "<C-]>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-vim.keymaps.complete

Keymap for manually triggering the suggestion. Command: vim.fn['codeium#Complete']()

Plugin default: "<M-Bslash>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-vim.keymaps.next

Keymap for cycling to the next suggestion. Command: vim.fn['codeium#CycleCompletions'](1)

Plugin default: "<M-]>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-vim.keymaps.prev

Keymap for cycling to the previous suggestion. Command: vim.fn['codeium#CycleCompletions'](-1)

Plugin default: "<M-[>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings

The configuration options for codeium-vim without the codeium_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal codeium_foo_bar=1
  • hello = "world" -> :setglobal codeium_hello="world"
  • some_toggle = true -> :setglobal codeium_some_toggle
  • other_toggle = false -> :setglobal nocodeium_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.codeium-vim.settings.bin

The path to the codeium language server executable.

Type: null or string

Default: "/nix/store/fxfqrifyj98wxlvx1aii61bb07zsgf1i-codeium-1.8.42/bin/codeium_language_server"

Declared by:

plugins.codeium-vim.settings.disable_bindings

Whether to disable default keybindings.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings.filetypes

A dictionary mapping whether codeium should be enabled or disabled in certain filetypes. This can be used to opt out of completions for certain filetypes.

Plugin default:

{
  help = false;
  gitcommit = false;
  gitrebase = false;
  "." = false;
}

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

plugins.codeium-vim.settings.idle_delay

Delay in milliseconds before autocompletions are shown (limited by language server to a minimum of 75).

Plugin default: 75

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings.manual

If true, codeium completions will never automatically trigger.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings.no_map_tab

Whether to disable the <Tab> keybinding.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings.render

A global boolean flag that controls whether codeium renders are enabled or disabled.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.codeium-vim.settings.tab_fallback

The fallback key when there is no suggestion display in codeium#Accept().

Default: “<C-N>” when a popup menu is visible, else “\t”.

Type: null or string

Default: null

Declared by:

comment

Url: https://github.com/numtostr/comment.nvim/

Maintainers: Gaetan Lepage

plugins.comment.enable

Whether to enable Comment.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.comment.package

Which package to use for the Comment.nvim plugin.

Type: package

Default: <derivation vimplugin-comment.nvim-2023-08-07>

Declared by:

plugins.comment.settings

Options provided to the require('comment').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  ignore = "^const(.*)=(%s?)%((.*)%)(%s?)=>";
  opleader = {
    block = "gb";
    line = "gc";
  };
  post_hook = ''
    function(ctx)
        if ctx.range.srow == ctx.range.erow then
            -- do something with the current line
        else
            -- do something with lines range
        end
    end
  '';
  pre_hook = "require('ts_context_commentstring.integrations.comment_nvim').create_pre_hook()";
  toggler = {
    block = "gbc";
    line = "gcc";
  };
}

Declared by:

plugins.comment.settings.ignore

Lines to be ignored while (un)comment.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.mappings

Enables keybindings. NOTE: If given ‘false’, then the plugin won’t create any mappings.

Plugin default:

{
  basic = true;
  extra = true;
}

Type: null or value false (singular enum) or (submodule)

Default: null

Declared by:

plugins.comment.settings.padding

Add a space b/w comment and the line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.comment.settings.post_hook

Lua function called after (un)comment.

Type: null or lua code string

Default: null

Declared by:

plugins.comment.settings.pre_hook

Lua function called before (un)comment.

Type: null or lua code string

Default: null

Declared by:

plugins.comment.settings.sticky

Whether the cursor should stay at its position.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.comment.settings.extra.above

Add comment on the line above.

Plugin default: "gcO"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.extra.below

Add comment on the line below.

Plugin default: "gco"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.extra.eol

Add comment at the end of line.

Plugin default: "gcA"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.opleader.block

Block-comment operator-pending keymap in NORMAL and VISUAL mode.

Plugin default: "gb"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.opleader.line

Line-comment operator-pending keymap in NORMAL and VISUAL mode.

Plugin default: "gc"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.toggler.block

Block-comment toggle keymap in NORMAL mode.

Plugin default: "gbc"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.comment.settings.toggler.line

Line-comment toggle keymap in NORMAL mode.

Plugin default: "gcc"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.commentary.enable

Whether to enable commentary.

Type: boolean

Default: false

Example: true

Declared by:

plugins.commentary.package

Which package to use for the commentary plugin.

Type: package

Default: <derivation vimplugin-vim-commentary-2024-04-08>

Declared by:

committia

Url: https://github.com/rhysd/committia.vim/

Maintainers: Alison Jenkins

plugins.committia.enable

Whether to enable committia.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.committia.package

Which package to use for the committia plugin.

Type: package

Default: <derivation vimplugin-committia.vim-2023-11-25>

Declared by:

plugins.committia.settings

The configuration options for committia without the committia_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal committia_foo_bar=1
  • hello = "world" -> :setglobal committia_hello="world"
  • some_toggle = true -> :setglobal committia_some_toggle
  • other_toggle = false -> :setglobal nocommittia_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.committia.settings.diff_window_opencmd

Vim command which opens a diff window in multi-columns mode.

Plugin default: "botright vsplit"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.committia.settings.edit_window_width

If committia.vim is in multi-columns mode, specifies the width of the edit window.

Plugin default: 80

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.committia.settings.min_window_width

If the width of window is narrower than the value, committia.vim employs single column mode.

Plugin default: 160

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.committia.settings.open_only_vim_starting

If false, committia.vim always attempts to open committia’s buffer when COMMIT_EDITMSG buffer is opened. If you use vim-fugitive, I recommend to set this value to true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.committia.settings.singlecolumn_diff_window_opencmd

Vim command which opens a diff window in single-column mode.

Plugin default: "belowright split"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.committia.settings.status_window_min_height

Minimum height of a status window.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.committia.settings.status_window_opencmd

Vim command which opens a status window in multi-columns mode.

Plugin default: "belowright split"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.committia.settings.use_singlecolumn

If the value is ‘always’, committia.vim always employs single column mode.

Plugin default: "always"

Type: null or string or raw lua code

Default: null

Declared by:

competitest

Url: https://github.com/xeluxee/competitest.nvim/

Maintainers: svl

plugins.competitest.enable

Whether to enable competitest.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.competitest.package

Which package to use for the competitest.nvim plugin.

Type: package

Default: <derivation vimplugin-competitest.nvim-2024-01-23>

Declared by:

plugins.competitest.settings

Options provided to the require('competitest').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  compile_command = {
    cpp = {
      args = [
        "-DLOCAL"
        "$(FNAME)"
        "-o"
        "$(FNOEXT)"
        "-Wall"
        "-Wextra"
      ];
      exec = "g++";
    };
  };
  evaluate_template_modifiers = true;
  received_problems_path = "$(HOME)/cp/$(JUDGE)/$(CONTEST)/$(PROBLEM)/main.$(FEXT)";
  template_file = "$(HOME)/cp/templates/template.$(FEXT)";
}

Declared by:

plugins.competitest.settings.companion_port

Competitive companion port number.

Plugin default: 27121

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.competitest.settings.compile_directory

Execution directory of compiler, relatively to current file’s path.

Plugin default: "."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.date_format

String used to format $(DATE) modifier (see receive modifiers). The string should follow the formatting rules as per Lua’s [os.date](https://www.lua.org/pil/22.1.html) function.

Plugin default: "%c"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.evaluate_template_modifiers

Whether to evaluate receive modifiers inside a template file or not.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.local_config_file_name

You can use a different configuration for every different folder. See local configuration.

Plugin default: ".competitest.lua"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.maximum_time

Maximum time, in milliseconds, given to processes. If it’s exceeded process will be killed.

Plugin default: 5000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.competitest.settings.multiple_testing

How many testcases to run at the same time

  • Set it to -1 to make the most of the amount of available parallelism. Often the number of testcases run at the same time coincides with the number of CPUs.
  • Set it to 0 if you want to run all the testcases together.
  • Set it to any positive integer to run that number of testcases contemporarily.

Plugin default: -1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.competitest.settings.open_received_contests

Automatically open source files when receiving a contest.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.open_received_problems

Automatically open source files when receiving a single problem.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.output_compare_method

How given output (stdout) and expected output should be compared. It can be a string, representing the method to use, or a custom function. Available options follows:

  • “exact”: character by character comparison.
  • “squish”: compare stripping extra white spaces and newlines.
  • custom function: you can use a function accepting two arguments, two strings representing output and expected output. It should return true if the given output is acceptable, false otherwise.

Plugin default: squish

Type: null or one of “exact”, “squish” or raw lua code

Default: null

Declared by:

plugins.competitest.settings.receive_print_message

If true notify user that plugin is ready to receive testcases, problems and contests or that they have just been received.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_contests_directory

Directory where received contests are stored. It can be string or function, exactly as received_problems_path.

Plugin default: "$(CWD)"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_contests_problems_path

Relative path from contest root directory, each problem of a received contest is stored following this option. It can be string or function, exactly as received_problems_path.

Plugin default: "$(PROBLEM).$(FEXT)"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_contests_prompt_directory

Whether to ask user confirmation about the directory where received contests are stored or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_contests_prompt_extension

Whether to ask user confirmation about what file extension to use when receiving a contest or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_files_extension

Default file extension for received problems.

Plugin default: "cpp"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_problems_path

Path where received problems (not contests) are stored. Can be one of the following:

  • string with receive modifiers.
  • function: function accepting two arguments, a table with task details and a string with preferred file extension. It should return the absolute path to store received problem.

Plugin default: "$(CWD)/$(PROBLEM).$(FEXT)"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.received_problems_prompt_path

Whether to ask user confirmation about path where the received problem is stored or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.replace_received_testcases

This option applies when receiving only testcases. If true replace existing testcases with received ones, otherwise ask user what to do.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.running_directory

Execution directory of your solutions, relatively to current file’s path.

Plugin default: "."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.save_all_files

If true save all the opened files before running testcases.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.save_current_file

If true save current file before running testcases.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.template_file

Templates to use when creating source files for received problems or contests. Can be one of the following:

  • false: do not use templates.
  • string with file-format modifiers: useful when templates for different file types have a regular file naming.
  • table with paths: table associating file extension to template file.

Type: null or value false (singular enum) or string or attribute set of string

Default: null

Declared by:

plugins.competitest.settings.testcases_auto_detect_storage

If true testcases storage method will be detected automatically. When both text files and single file are available, testcases will be loaded according to the preference specified in testcases_use_single_file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.testcases_directory

Where testcases files are located, relatively to current file’s path.

Plugin default: "."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.testcases_input_file_format

String representing how testcases input files should be named (see file-format modifiers).

Plugin default: "$(FNOEXT)_input$(TCNUM).txt"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.testcases_output_file_format

String representing how testcases output files should be named (see file-format modifiers).

Plugin default: "$(FNOEXT)_output$(TCNUM).txt"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.testcases_single_file_format

String representing how single testcases files should be named (see file-format modifiers).

Plugin default: "$(FNOEXT).testcases"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.competitest.settings.testcases_use_single_file

If true testcases will be stored in a single file instead of using multiple text files. If you want to change the way already existing testcases are stored see conversion.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.view_output_diff

View diff between actual output and expected output in their respective windows.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.competitest.settings.compile_command

Configure the command used to compile code for every different language, see here.

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.competitest.settings.compile_command.<name>.args

Arguments to the command.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.competitest.settings.compile_command.<name>.exec

Command to execute

Type: string

Declared by:

plugins.competitest.settings.run_command

Configure the command used to run your solutions for every different language, see here.

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.competitest.settings.run_command.<name>.args

Arguments to the command.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.competitest.settings.run_command.<name>.exec

Command to execute.

Type: string

Declared by:

plugins.conform-nvim.enable

Whether to enable conform-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.conform-nvim.package

Which package to use for the conform-nvim plugin.

Type: package

Default: <derivation vimplugin-conform.nvim-2024-05-16>

Declared by:

plugins.conform-nvim.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.conform-nvim.formatAfterSave

If this is set, Conform will run the formatter asynchronously after save. It will pass the table to conform.format(). This can also be a function that returns the table.

Plugin default: see documentation

Type: null or lua function string or (submodule)

Default: null

Declared by:

plugins.conform-nvim.formatOnSave

If this is set, Conform will run the formatter on save. It will pass the table to conform.format(). This can also be a function that returns the table. See :help conform.format for details.

Plugin default: see documentation

Type: null or lua function string or (submodule)

Default: null

Declared by:

plugins.conform-nvim.formatters

Custom formatters and changes to built-in formatters

Plugin default: see documentation

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.conform-nvim.formattersByFt

  # Map of filetype to formatters
  formattersByFt =
    {
      lua = [ "stylua" ];
      # Conform will run multiple formatters sequentially
      python = [ "isort" "black" ];
      # Use a sub-list to run only the first available formatter
      javascript = [ [ "prettierd" "prettier" ] ];
      # Use the "*" filetype to run formatters on all filetypes.
      "*" = [ "codespell" ];
      # Use the "_" filetype to run formatters on filetypes that don't
      # have other formatters configured.
      "_" = [ "trim_whitespace" ];
     };

Plugin default: see documentation

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.conform-nvim.logLevel

Set the log level. Use :ConformInfo to see the location of the log file.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "error"

Declared by:

plugins.conform-nvim.notifyOnError

Conform will notify you when a formatter errors

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.conjure.enable

Whether to enable Conjure.

Type: boolean

Default: false

Example: true

Declared by:

plugins.conjure.package

Which package to use for the conjure plugin.

Type: package

Default: <derivation vimplugin-conjure-2024-03-11>

Declared by:

copilot-chat

Url: https://github.com/CopilotC-Nvim/CopilotChat.nvim/

Maintainers: Gaetan Lepage

plugins.copilot-chat.enable

Whether to enable CopilotChat.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.copilot-chat.package

Which package to use for the CopilotChat.nvim plugin.

Type: package

Default: <derivation vimplugin-CopilotChat.nvim-2024-05-08>

Declared by:

plugins.copilot-chat.settings

Options provided to the require('copilot-chat').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  answer_header = "## Copilot ";
  auto_follow_cursor = false;
  error_header = "## Error ";
  mappings = {
    close = {
      insert = "<C-c>";
      normal = "q";
    };
    complete = {
      detail = "Use @<Tab> or /<Tab> for options.";
      insert = "<Tab>";
    };
  };
  prompts = {
    Explain = "Please explain how the following code works.";
    Review = "Please review the following code and provide suggestions for improvement.";
    Tests = "Please explain how the selected code works, then generate unit tests for it.";
  };
  question_header = "## User ";
  show_help = false;
}

Declared by:

plugins.copilot-chat.settings.allow_insecure

Allow insecure server connections.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.answer_header

Header to use for AI answers.

Plugin default: "## Copilot "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.auto_follow_cursor

Auto-follow cursor in chat.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.auto_insert_mode

Automatically enter insert mode when opening window and if auto follow cursor is enabled on new prompt.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.callback

Callback to use when ask response is received.

fun(response: string, source: CopilotChat.config.source)

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.copilot-chat.settings.clear_chat_on_new_prompt

Clears chat on every new prompt.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.context

Default context to use, "buffers", "buffer" or null (can be specified manually in prompt via @).

Plugin default: null

Type: null or one of “buffers”, “buffer” or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.debug

Enable debug logging.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.error_header

Header to use for errors.

Plugin default: "## Error "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.highlight_selection

Highlight selection.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.history_path

Default path to stored history.

Plugin default:

{
  __raw = "vim.fn.stdpath('data') .. '/copilotchat_history'";
}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.mappings

Mappings for CopilotChat.

Plugin default:

{
  accept_diff = {
    insert = "<C-y>";
    normal = "<C-y>";
  };
  close = {
    insert = "<C-c>";
    normal = "q";
  };
  complete = {
    detail = "Use @<Tab> or /<Tab> for options.";
    insert = "<Tab>";
  };
  reset = {
    insert = "<C-l>";
    normal = "<C-l>";
  };
  show_diff = {
    normal = "gd";
  };
  show_system_prompt = {
    normal = "gp";
  };
  show_user_selection = {
    normal = "gs";
  };
  submit_prompt = {
    insert = "<C-m>";
    normal = "<CR>";
  };
  yank_diff = {
    normal = "gy";
  };
}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.copilot-chat.settings.model

GPT model to use, ‘gpt-3.5-turbo’ or ‘gpt-4’.

Plugin default: "gpt-4"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.prompts

Default prompts.

Plugin default:

{
  Commit = {
    prompt = "Write commit message for the change with commitizen convention. Make sure the title has maximum 50 characters and message is wrapped at 72 characters. Wrap the whole message in code block with language gitcommit.";
    selection = "require('CopilotChat.select').gitdiff";
  };
  CommitStaged = {
    prompt = "Write commit message for the change with commitizen convention. Make sure the title has maximum 50 characters and message is wrapped at 72 characters. Wrap the whole message in code block with language gitcommit.";
    selection = ''
      function(source)
        return select.gitdiff(source, true)
      end
    '';
  };
  Docs = {
    prompt = "/COPILOT_GENERATE Please add documentation comment for the selection.";
  };
  Explain = {
    prompt = "/COPILOT_EXPLAIN Write an explanation for the active selection as paragraphs of text.";
  };
  Fix = {
    prompt = "/COPILOT_GENERATE There is a problem in this code. Rewrite the code to show it with the bug fixed.";
  };
  FixDiagnostic = {
    prompt = "Please assist with the following diagnostic issue in file:";
    selection = "require('CopilotChat.select').diagnostics";
  };
  Optimize = {
    prompt = "/COPILOT_GENERATE Optimize the selected code to improve performance and readablilty.";
  };
  Review = {
    callback = ''
      function(response, source)
        -- see config.lua for implementation
      end
    '';
    prompt = "/COPILOT_REVIEW Review the selected code.";
  };
  Tests = {
    prompt = "/COPILOT_GENERATE Please generate tests for my code.";
  };
}

Type: null or (attribute set of (string or (attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.copilot-chat.settings.proxy

Custom proxy to use, formatted as [protocol://]host[:port].

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.question_header

Header to use for user questions.

Plugin default: "## User "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.selection

Default selection (visual or line). fun(source: CopilotChat.config.source):CopilotChat.config.selection

Plugin default:

function(source)
  local select = require('CopilotChat.select')
  return select.visual(source) or select.line(source)
end

Type: null or lua function string

Default: null

Declared by:

plugins.copilot-chat.settings.separator

Separator to use in chat.

Plugin default: "───"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.show_folds

Shows folds for sections in chat.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.show_help

Shows help message as virtual lines when waiting for user input.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.system_prompt

System prompt to use.

Plugin default: require('CopilotChat.prompts').COPILOT_INSTRUCTIONS

Type: null or lua code string

Default: null

Declared by:

plugins.copilot-chat.settings.temperature

GPT temperature.

Plugin default: 0.1

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.border

Border for this window. (Only for floating windows.)

Plugin default: "single"

Type: null or one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.col

Column position of the window, default is centered. (Only for floating windows.)

Plugin default: null

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.footer

Footer of chat window.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.height

Fractional height of parent, or absolute height in rows when > 1.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or (positive integer, meaning >0) or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.layout

Layout for the window.

Plugin default: "vertical"

Type: null or one of “vertical”, “horizontal”, “float”, “replace” or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.relative

Relative position. (Only for floating windows.)

Plugin default: "editor"

Type: null or one of “editor”, “win”, “cursor”, “mouse” or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.row

Row position of the window, default is centered. (Only for floating windows.)

Plugin default: null

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.title

Title of chat window.

Plugin default: "Copilot Chat"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.width

Fractional width of parent, or absolute width in columns when > 1.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or (positive integer, meaning >0) or raw lua code

Default: null

Declared by:

plugins.copilot-chat.settings.window.zindex

Determines if window is on top or below other floating windows.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

copilot-cmp

Maintainers: Gaetan Lepage

plugins.copilot-cmp.enable

Whether to enable copilot-cmp.

Type: boolean

Default: false

Example: true

Declared by:

plugins.copilot-cmp.event

Configures when the source is registered. Unless you have a unique problem for your particular configuration you probably don’t want to touch this.

Plugin default: ["InsertEnter" "LspAttach"]

Type: null or (list of string)

Default: null

Declared by:

plugins.copilot-cmp.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.copilot-cmp.fixPairs

Suppose you have the following code: print('h'). Copilot might try to account for the ' and ) and complete it with this: print('hello.

This is not good behavior for consistency reasons and will just end up deleting the two ending characters. This option fixes that. Don’t turn this off unless you are having problems with pairs and believe this might be causing them.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-lua.enable

Whether to enable copilot.lua.

Type: boolean

Default: false

Example: true

Declared by:

plugins.copilot-lua.package

Which package to use for the copilot.lua plugin.

Type: package

Default: <derivation vimplugin-copilot.lua-2024-02-28>

Declared by:

plugins.copilot-lua.copilotNodeCommand

Use this field to provide the path to a specific node version such as one installed by nvm. Node.js version must be 16.x or newer.

Type: string

Default: "/nix/store/mhbh2l1rsxpvq1czhjiqcpnmahbgvql9-nodejs-18.20.3/bin/node"

Declared by:

plugins.copilot-lua.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.copilot-lua.filetypes

Specify filetypes for attaching copilot. Each value can be either a boolean or a lua function that returns a boolean.

Example:

  {
    markdown = true; # overrides default
    terraform = false; # disallow specific filetype
    sh.__raw = \'\'
      function ()
        if string.match(vim.fs.basename(vim.api.nvim_buf_get_name(0)), '^%.env.*') then
          -- disable for .env files
          return false
        end
        return true
      end
    \'\';
  }

The key "*" can be used to disable the default configuration. Example:

  {
    javascript = true; # allow specific filetype
    typescript = true; # allow specific filetype
    "*" = false; # disable for all other filetypes and ignore default `filetypes`
  }

Plugin default:

{
  yaml = false;
  markdown = false;
  help = false;
  gitcommit = false;
  gitrebase = false;
  hgcommit = false;
  svn = false;
  cvs = false;
  "." = false;
}

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

plugins.copilot-lua.serverOptsOverrides

Override copilot lsp client settings. The settings field is where you can set the values of the options defined in https://github.com/zbirenbaum/copilot.lua/blob/master/SettingsOpts.md. These options are specific to the copilot lsp and can be used to customize its behavior.

Ensure that the name field is not overridden as is is used for efficiency reasons in numerous checks to verify copilot is actually running.

See :h vim.lsp.start_client for list of options.

Example:

  {
    trace = "verbose";
    settings = {
      advanced = {
        listCount = 10; # number of completions for panel
        inlineSuggestCount = 3; # number of completions for getCompletions
      };
    };
  }

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.copilot-lua.panel.enabled

Enable the panel.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-lua.panel.autoRefresh

Enable auto-refresh.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-lua.panel.keymap.accept

Keymap to accept the proposed suggestion.

Plugin default: <CR>

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.panel.keymap.jumpNext

Keymap for jumping to the next suggestion.

Plugin default: ]]

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.panel.keymap.jumpPrev

Keymap for jumping to the previous suggestion.

Plugin default: [[

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.panel.keymap.open

Keymap to open.

Plugin default: <M-CR>

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.panel.keymap.refresh

Keymap to refresh the suggestions.

Plugin default: gr

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.panel.layout.position

The panel position.

Plugin default: "bottom"

Type: null or one of “bottom”, “top”, “left”, “right” or raw lua code

Default: null

Declared by:

plugins.copilot-lua.panel.layout.ratio

The panel ratio.

Plugin default: 0.4

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.copilot-lua.suggestion.enabled

Enable suggestion.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-lua.suggestion.autoTrigger

Enable auto-trigger.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.copilot-lua.suggestion.debounce

Debounce.

Plugin default: 75

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.accept

Keymap for accepting the suggestion.

Plugin default: <M-l>

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.acceptLine

Keymap for accepting a line suggestion.

Plugin default: false

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.acceptWord

Keymap for accepting a word suggestion.

Plugin default: false

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.dismiss

Keymap to dismiss the suggestion.

Plugin default: <C-]>

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.next

Keymap for accepting the next suggestion.

Plugin default: <M-]>

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.copilot-lua.suggestion.keymap.prev

Keymap for accepting the previous suggestion.

Plugin default: <M-[>

Type: null or value false (singular enum) or string

Default: null

Declared by:

copilot-vim

Url: https://github.com/github/copilot.vim/

Maintainers: Gaetan Lepage

plugins.copilot-vim.enable

Whether to enable copilot.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.copilot-vim.package

Which package to use for the copilot-vim plugin.

Type: package

Default: <derivation vimplugin-copilot.vim-2024-05-10>

Declared by:

plugins.copilot-vim.settings

The configuration options for copilot-vim without the copilot_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal copilot_foo_bar=1
  • hello = "world" -> :setglobal copilot_hello="world"
  • some_toggle = true -> :setglobal copilot_some_toggle
  • other_toggle = false -> :setglobal nocopilot_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  filetypes = {
    "*" = false;
    python = true;
  };
  proxy = "localhost:3128";
  proxy_strict_ssl = false;
  workspace_folders = [
    "~/Projects/myproject"
  ];
}

Declared by:

plugins.copilot-vim.settings.filetypes

A dictionary mapping file types to their enabled status.

Type: null or (attribute set of boolean)

Default: null

Example:

{
  "*" = false;
  python = true;
}

Declared by:

plugins.copilot-vim.settings.node_command

Tell Copilot what node binary to use.

Type: null or string

Default: "/nix/store/mhbh2l1rsxpvq1czhjiqcpnmahbgvql9-nodejs-18.20.3/bin/node"

Declared by:

plugins.copilot-vim.settings.proxy

Tell Copilot what proxy server to use.

If this is not set, Copilot will use the value of environment variables like $HTTPS_PROXY.

Type: null or string

Default: null

Example: "localhost:3128"

Declared by:

plugins.copilot-vim.settings.proxy_strict_ssl

Corporate proxies sometimes use a man-in-the-middle SSL certificate which is incompatible with GitHub Copilot. To work around this, SSL certificate verification can be disabled by setting this option to false.

You can also tell Node.js to disable SSL verification by setting the $NODE_TLS_REJECT_UNAUTHORIZED environment variable to "0".

Type: null or boolean

Default: null

Declared by:

plugins.copilot-vim.settings.workspace_folders

A list of “workspace folders” or project roots that Copilot may use to improve to improve the quality of suggestions.

Example: [“~/Projects/myproject”]

You can also set b:workspace_folder for an individual buffer and newly seen values will be added automatically.

Type: null or (list of string)

Default: null

Declared by:

coq-nvim

Url: https://github.com/ms-jpq/coq_nvim/

Maintainers: Quentin Boyer, Kareem Medhat

plugins.coq-nvim.enable

Whether to enable coq_nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.coq-nvim.package

Which package to use for the coq_nvim plugin.

Type: package

Default: <derivation vimplugin-coq_nvim-2024-04-26>

Declared by:

plugins.coq-nvim.artifactsPackage

Package to use for coq-artifacts (when enabled with installArtifacts)

Type: package

Default: <derivation vimplugin-coq.artifacts-2024-03-01>

Declared by:

plugins.coq-nvim.installArtifacts

Whether to enable and install coq-artifacts.

Type: boolean

Default: false

Example: true

Declared by:

plugins.coq-nvim.settings

Options provided to the require('coq-nvim').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.coq-nvim.settings.auto_start

Auto-start or shut up

Type: null or boolean or value “shut-up” (singular enum) or raw lua code

Default: null

Declared by:

plugins.coq-nvim.settings.xdg

Use XDG paths. May be required when installing coq with Nix.

Type: boolean

Default: true

Declared by:

plugins.coq-nvim.settings.completion.always

Always trigger completion on keystroke

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coq-nvim.settings.keymap.recommended

Use the recommended keymaps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coq-thirdparty.enable

Whether to enable coq-thirdparty.

Type: boolean

Default: false

Example: true

Declared by:

plugins.coq-thirdparty.package

Which package to use for the coq-thirdparty plugin.

Type: package

Default: <derivation vimplugin-coq.thirdparty-2024-04-18>

Declared by:

plugins.coq-thirdparty.sources

List of sources. Each source is a free-form type, so additional settings like accept_key may be specified even if they are not declared by nixvim.

Type: list of (attribute set)

Default: [ ]

Example:

[
  {
    short_name = "nLUA";
    src = "nvimlua";
  }
  {
    short_name = "vTEX";
    src = "vimtex";
  }
  {
    accept_key = "<c-f>";
    short_name = "COP";
    src = "copilot";
  }
  {
    src = "demo";
  }
]

Declared by:

plugins.coq-thirdparty.sources.*.short_name

A short name for the source. If not specified, it is uppercase src.

Type: null or string

Default: null

Example: "nLUA"

Declared by:

plugins.coq-thirdparty.sources.*.src

The name of the source

Type: string

Declared by:

plugins.coverage.enable

Whether to enable nvim-coverage.

Type: boolean

Default: false

Example: true

Declared by:

plugins.coverage.package

Which package to use for the nvim-coverage plugin.

Type: package

Default: <derivation vimplugin-nvim-coverage-2024-03-24>

Declared by:

plugins.coverage.autoReload

If true, the coverage_file for a language will be watched for changes after executing :CoverageLoad or coverage.load(). The file watcher will be stopped after executing :CoverageClear or coverage.clear().

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coverage.autoReloadTimeoutMs

The number of milliseconds to wait before auto-reloading coverage after detecting a change.

Plugin default: 500

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.coverage.commands

If true, create commands.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coverage.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.coverage.keymapsSilent

Whether nvim-coverage keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.coverage.lang

Each key corresponds with the filetype of the language and maps to an attrs of configuration values that differ. See plugin documentation for language specific options.

Example:

  {
    python = {
      coverage_file = ".coverage";
      coverage_command = "coverage json --fail-under=0 -q -o -";
    };
    ruby = {
        coverage_file = "coverage/coverage.json";
    };
  }

Plugin default: see upstream documentation

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.lcovFile

File that the plugin will try to read lcov coverage from.

Type: null or string

Default: null

Declared by:

plugins.coverage.loadCoverageCb

A lua function that will be called when a coverage file is loaded.

Example:

  function (ftype)
    vim.notify("Loaded " .. ftype .. " coverage")
  end

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.coverage.signGroup

Name of the sign group used when placing the signs. See :h sign-group.

Plugin default: "coverage"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.highlights.covered

Highlight group for covered signs.

Plugin default: {fg = "#B7F071";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.partial

Highlight group for partial coverage signs.

Plugin default: {fg = "#AA71F0";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryBorder

Border highlight group of the summary pop-up.

Plugin default: {link = "FloatBorder";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryCursorLine

Cursor line highlight group of the summary pop-up.

Plugin default: {link = "CursorLine";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryFail

Fail text highlight group of the summary pop-up.

Plugin default: {link = "CoverageUncovered";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryHeader

Header text highlight group of the summary pop-up.

Plugin default: { style = "bold,underline"; sp = "bg"; }

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryNormal

Normal text highlight group of the summary pop-up.

Plugin default: {link = "NormalFloat";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.summaryPass

Pass text highlight group of the summary pop-up.

Plugin default: {link = "CoverageCovered";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.highlights.uncovered

Highlight group for uncovered signs.

Plugin default: {fg = "#F07178";}

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.keymaps.clear

Unloads the cached coverage signs. :Coverage or :CoverageLoad must be called again to relad the data.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.coverage

Loads a coverage report and immediately displays the coverage signs.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.hide

Hides the coverage signs. Must call :Coverage or :CoverageLoad first.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.load

Loads a coverage report but does not display the coverage signs.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.show

Shows the coverage signs. Must call :Coverage or :CoverageLoad first.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.summary

Displays a coverage summary report in a floating window.

Type: null or string

Default: null

Declared by:

plugins.coverage.keymaps.toggle

Toggles the coverage signs. Must call :Coverage or :CoverageLoad first.

Type: null or string

Default: null

Declared by:

plugins.coverage.signs.covered.hl

The highlight group used for covered signs.

Plugin default: "CoverageCovered"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.signs.covered.text

The text used for covered signs.

Plugin default: "▎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.signs.partial.hl

The highlight group used for partial coverage signs.

Plugin default: "CoveragePartial"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.signs.partial.text

The text used for partial coverage signs.

Plugin default: "▎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.signs.uncovered.hl

The highlight group used for uncovered signs.

Plugin default: "CoverageUncovered"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.signs.uncovered.text

The text used for uncovered signs.

Plugin default: "▎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.heightPercentage

Height of the pop-up window.

Plugin default: 0.50

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.coverage.summary.minCoverage

Minimum coverage percentage. Values below this are highlighted with the fail group, values above are highlighted with the pass group.

Plugin default: 80

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.coverage.summary.widthPercentage

Width of the pop-up window.

Plugin default: 0.70

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.coverage.summary.borders.bot

Plugin default: "─"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.botleft

Plugin default: "╰"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.botright

Plugin default: "╯"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.highlight

Plugin default: "Normal:CoverageSummaryBorder"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.left

Plugin default: "│"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.right

Plugin default: "│"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.top

Plugin default: "─"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.topleft

Plugin default: "╭"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.coverage.summary.borders.topright

Plugin default: "╮"

Type: null or string or raw lua code

Default: null

Declared by:

crates-nvim

Maintainers: Gaetan Lepage

plugins.crates-nvim.enable

Whether to enable crates-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.crates-nvim.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.cursorline.enable

Whether to enable nvim-cursorline.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cursorline.package

Which package to use for the nvim-cursorline plugin.

Type: package

Default: <derivation vimplugin-nvim-cursorline-2022-04-15>

Declared by:

plugins.cursorline.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.cursorline.cursorline.enable

Show / hide cursorline in connection with cursor moving.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cursorline.cursorline.number

Whether to also highlight the line number.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cursorline.cursorline.timeout

Time (in ms) after which the cursorline appears.

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.cursorline.cursorword.enable

Underlines the word under the cursor.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.cursorline.cursorword.hl

Highliht definition map for cursorword highlighting.

Plugin default: {underline = true;}

Type: null or (attribute set)

Default: null

Declared by:

plugins.cursorline.cursorword.minLength

Minimum length for underlined words.

Plugin default: 3

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dap.enable

Whether to enable dap.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dap.package

Which package to use for the dap plugin.

Type: package

Default: <derivation vimplugin-nvim-dap-2024-05-16>

Declared by:

plugins.dap.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.dap.adapters

Dap adapters.

Type: null or (submodule)

Default: null

Declared by:

plugins.dap.adapters.executables

Debug adapters of executable type. The adapters can also be set to a function which takes three arguments:

  • A on_config callback. This must be called with the actual adapter table.
  • The |dap-configuration| which the user wants to use.
  • An optional parent session. This is only available if the debug-adapter wants to start a child-session via a startDebugging request.

This can be used to defer the resolving of the values to when a configuration is used. A use-case for this is starting an adapter asynchronous.

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.dap.adapters.servers

Debug adapters of server type. The adapters can also be set to a function which takes three arguments:

  • A on_config callback. This must be called with the actual adapter table.
  • The |dap-configuration| which the user wants to use.
  • An optional parent session. This is only available if the debug-adapter wants to start a child-session via a startDebugging request.

This can be used to defer the resolving of the values to when a configuration is used. A use-case for this is starting an adapter asynchronous.

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.dap.configurations

Debuggee configurations, see :h dap-configuration for more info.

Type: null or (attribute set of list of (attribute set))

Default: null

Declared by:

plugins.dap.configurations.<name>.*.name

A user readable name for the configuration.

Type: string

Declared by:

plugins.dap.configurations.<name>.*.request

Indicates whether the debug adapter should launch a debuggee or attach to one that is already running.

Type: one of “attach”, “launch”

Declared by:

plugins.dap.configurations.<name>.*.type

Which debug adapter to use.

Type: string

Declared by:

plugins.dap.extensions.dap-go.enable

Whether to enable dap-go.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dap.extensions.dap-go.package

Which package to use for the dap-go plugin.

Type: package

Default: <derivation vimplugin-nvim-dap-go-2024-05-02>

Declared by:

plugins.dap.extensions.dap-go.dapConfigurations

Additional dap configurations. See :h dap-configuration for more detail.

Type: null or (list of (attribute set))

Default: null

Declared by:

plugins.dap.extensions.dap-go.dapConfigurations.*.name

A user readable name for the configuration.

Type: string

Declared by:

plugins.dap.extensions.dap-go.dapConfigurations.*.request

Indicates whether the debug adapter should launch a debuggee or attach to one that is already running.

Type: one of “attach”, “launch”

Declared by:

plugins.dap.extensions.dap-go.dapConfigurations.*.type

Which debug adapter to use.

Type: string

Declared by:

plugins.dap.extensions.dap-go.delve.args

Additional args to pass to dlv.

Type: null or (list of string)

Default: null

Declared by:

plugins.dap.extensions.dap-go.delve.buildFlags

Build flags to pass to dlv.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-go.delve.initializeTimeoutSec

Time to wait for delve to initialize the debug session.

Plugin default: 20

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-go.delve.path

The path to the executable dlv which will be used for debugging.

Plugin default: "dlv"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-go.delve.port

A string that defines the port to start delve debugger. Defaults to string “${port}” which instructs dap to start the process in a random available port.

Plugin default: "\${port}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-python.enable

Whether to enable dap-python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dap.extensions.dap-python.package

Which package to use for the dap-python plugin.

Type: package

Default: <derivation vimplugin-nvim-dap-python-2024-04-10>

Declared by:

plugins.dap.extensions.dap-python.adapterPythonPath

Path to the python interpreter. Path must be absolute or in $PATH and needs to have the debugpy package installed.

Type: string

Default: "/nix/store/jimgq5gnp7jiyns7ikvq6vsxrmqf7ji6-python3-3.11.9-env/bin/python3"

Declared by:

plugins.dap.extensions.dap-python.console

Debugpy console.

Plugin default: "integratedTerminal"

Type: null or one of “integratedTerminal”, “internalConsole”, “externalTerminal” or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-python.includeConfigs

Add default configurations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-python.resolvePython

Function to resolve path to python to use for program or test execution. By default the VIRTUAL_ENV and CONDA_PREFIX environment variables are used if present.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.dap.extensions.dap-python.testRunner

The name of test runner to use by default. The default value is dynamic and depends on pytest.ini or manage.py markers. If neither is found “unittest” is used.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-python.testRunners

Set to register test runners. Built-in are test runners for unittest, pytest and django. The key is the test runner name, the value a function to generate the module name to run and its arguments. See |dap-python.TestRunner|.

Type: null or (attribute set of lua function string)

Default: null

Declared by:

plugins.dap.extensions.dap-python.customConfigurations

Custom python configurations for dap.

Type: null or (list of (attribute set))

Default: null

Declared by:

plugins.dap.extensions.dap-python.customConfigurations.*.name

A user readable name for the configuration.

Type: string

Declared by:

plugins.dap.extensions.dap-python.customConfigurations.*.request

Indicates whether the debug adapter should launch a debuggee or attach to one that is already running.

Type: one of “attach”, “launch”

Declared by:

plugins.dap.extensions.dap-python.customConfigurations.*.type

Which debug adapter to use.

Type: string

Declared by:

plugins.dap.extensions.dap-ui.enable

Whether to enable dap-ui.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dap.extensions.dap-ui.package

Which package to use for the dap-ui plugin.

Type: package

Default: <derivation vimplugin-nvim-dap-ui-2024-04-28>

Declared by:

plugins.dap.extensions.dap-ui.expandLines

Expand current line to hover window if larger than window size.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.dap.extensions.dap-ui.forceBuffers

Prevents other buffers being loaded into dap-ui windows.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.selectWindow

A function which returns a window to be used for opening buffers such as a stack frame location.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.enabled

Enable controls

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.element

Element to show the controls on.

Plugin default: "repl"

Type: null or one of “repl”, “scopes”, “stacks”, “watches”, “breakpoints”, “console” or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.disconnect

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.pause

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.play

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.run_last

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.step_back

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.step_into

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.step_out

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.step_over

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.controls.icons.terminate

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings

Per-element overrides of global mappings.

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.edit

Map edit for element mapping overrides

Plugin default: e

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.expand

Map expand for element mapping overrides

Plugin default: ["<CR>" "<2-LeftMouse>"]

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.open

Map open for element mapping overrides

Plugin default: o

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.remove

Map remove for element mapping overrides

Plugin default: d

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.repl

Map repl for element mapping overrides

Plugin default: r

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.elementMappings.<name>.toggle

Map toggle for element mapping overrides

Plugin default: t

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.floating.border

Defines the border to use for dap-ui floating window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: single

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.floating.maxHeight

Maximum height of the floating window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dap.extensions.dap-ui.floating.maxWidth

Maximum width of the floating window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dap.extensions.dap-ui.floating.mappings

Keys to trigger actions in elements.

Type: null or (submodule)

Default: null

Declared by:

plugins.dap.extensions.dap-ui.floating.mappings.close

Map close for dap-ui floating

Plugin default: ["<ESC>" "q"]

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.icons.collapsed

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.icons.current_frame

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.icons.expanded

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.layouts

List of layouts for dap-ui.

Plugin default:

```nix
  [
    {
      elements = [
        {
          id = "scopes";
          size = 0.25;
        }
        {
          id = "breakpoints";
          size = 0.25;
        }
        {
          id = "stacks";
          size = 0.25;
        }
        {
          id = "watches";
          size = 0.25;
        }
      ];
      position = "left";
      size = 40;
    }
    {
      elements = [
        {
          id = "repl";
          size = 0.5;
        }
        {
          id = "console";
          size = 0.5;
        }
      ];
      position = "bottom";
      size = 10;
    }
  ];

Type: null or (list of (submodule))

Default: null

Declared by:

plugins.dap.extensions.dap-ui.layouts.*.elements

Elements to display in this layout.

Type: list of (string or (submodule))

Default: [ ]

Declared by:

plugins.dap.extensions.dap-ui.layouts.*.position

Which side of editor to open layout on.

Type: one of “left”, “right”, “top”, “bottom”

Default: "left"

Declared by:

plugins.dap.extensions.dap-ui.layouts.*.size

Size of the layout in lines/columns.

Type: signed integer

Default: 10

Declared by:

plugins.dap.extensions.dap-ui.mappings

Keys to trigger actions in elements.

Type: null or (submodule)

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.edit

Map edit for dap-ui

Plugin default: e

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.expand

Map expand for dap-ui

Plugin default: ["<CR>" "<2-LeftMouse>"]

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.open

Map open for dap-ui

Plugin default: o

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.remove

Map remove for dap-ui

Plugin default: d

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.repl

Map repl for dap-ui

Plugin default: r

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.mappings.toggle

Map toggle for dap-ui

Plugin default: t

Type: null or string or list of string

Default: null

Declared by:

plugins.dap.extensions.dap-ui.render.indent

Default indentation size.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-ui.render.maxTypeLength

Maximum number of characters to allow a type name to fill before trimming.

Type: null or signed integer

Default: null

Declared by:

plugins.dap.extensions.dap-ui.render.maxValueLines

Maximum number of lines to allow a value to fill before trimming.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.enable

Whether to enable dap-virtual-text.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dap.extensions.dap-virtual-text.enabledCommands

Create commands DapVirtualTextEnable, DapVirtualTextDisable, DapVirtualTextToggle. (DapVirtualTextForceRefresh for refreshing when debug adapter did not notify its termination).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.package

Which package to use for the dap-virtual-text plugin.

Type: package

Default: <derivation vimplugin-nvim-dap-virtual-text-2024-04-05>

Declared by:

plugins.dap.extensions.dap-virtual-text.allFrames

Show virtual text for all stack frames not only current.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.allReferences

Show virtual text on all all references of the variable (not only definitions).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.clearOnContinue

Clear virtual text on continue (might cause flickering when stepping).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.commented

Prefix virtual text with comment string.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.displayCallback

A callback that determines how a variable is displayed or whether it should be omitted.

Plugin default:

function(variable, buf, stackframe, node, options)
  if options.virt_text_pos == 'inline' then
    return ' = ' .. variable.value
  else
    return variable.name .. ' = ' .. variable.value
  end
end,

Type: null or lua function string

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.highlightChangedVariables

Highlight changed values with NvimDapVirtualTextChanged, else always NvimDapVirtualText.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.highlightNewAsChanged

Highlight new variables in the same way as changed variables (if highlightChangedVariables).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.onlyFirstDefinition

Only show virtual text at first definition (if there are multiple).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.showStopReason

Show stop reason when stopped for exceptions.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.virtLines

Show virtual lines instead of virtual text (will flicker!).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.virtTextPos

Position of virtual text, see :h nvim_buf_set_extmark(). Default tries to inline the virtual text. Use ‘eol’ to set to end of line.

Plugin default: "vim.fn.has 'nvim-0.10' == 1 and 'inline' or 'eol'"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.extensions.dap-virtual-text.virtTextWinCol

Position the virtual text at a fixed window column (starting from the first text column). See :h nvim_buf_set_extmark().

Type: null or signed integer

Default: null

Declared by:

plugins.dap.signs

Signs for dap.

Type: null or (submodule)

Default: null

Declared by:

plugins.dap.signs.dapBreakpoint.linehl

linehl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpoint.numhl

numhl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpoint.text

Sign for breakpoints.

Plugin default: "B"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.signs.dapBreakpoint.texthl

texthl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointCondition.linehl

linehl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointCondition.numhl

numhl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointCondition.text

Sign for conditional breakpoints.

Plugin default: "C"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.signs.dapBreakpointCondition.texthl

texthl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointRejected.linehl

linehl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointRejected.numhl

numhl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapBreakpointRejected.text

Sign to indicate breakpoints rejected by the debug adapter.

Plugin default: "R"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.signs.dapBreakpointRejected.texthl

texthl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapLogPoint.linehl

linehl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapLogPoint.numhl

numhl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapLogPoint.text

Sign for log points.

Plugin default: "L"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.signs.dapLogPoint.texthl

texthl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapStopped.linehl

linehl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapStopped.numhl

numhl for sign.

Type: null or string

Default: null

Declared by:

plugins.dap.signs.dapStopped.text

Sign to indicate where the debuggee is stopped.

Plugin default: "→"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dap.signs.dapStopped.texthl

texthl for sign.

Type: null or string

Default: null

Declared by:

dashboard

Url: https://github.com/nvimdev/dashboard-nvim/

Maintainers: Matt Sturgeon

plugins.dashboard.enable

Whether to enable dashboard-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dashboard.package

Which package to use for the dashboard-nvim plugin.

Type: package

Default: <derivation vimplugin-dashboard-nvim-2024-05-05>

Declared by:

plugins.dashboard.settings

Options provided to the require('dashboard').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  change_to_vcs_root = true;
  config = {
    mru = {
      limit = 20;
    };
    project = {
      enable = false;
    };
    shortcut = [
      {
        action = {
          __raw = "function(path) vim.cmd('Telescope find_files') end";
        };
        desc = "Files";
        group = "Label";
        icon = " ";
        icon_hl = "@variable";
        key = "f";
      }
      {
        action = "Telescope app";
        desc = " Apps";
        group = "DiagnosticHint";
        key = "a";
      }
      {
        action = "Telescope dotfiles";
        desc = " dotfiles";
        group = "Number";
        key = "d";
      }
    ];
    week_header = {
      enable = true;
    };
  };
  theme = "hyper";
}

Declared by:

plugins.dashboard.settings.change_to_vcs_root

When opening a file in the “hyper” theme’s “recent files” list (mru), vim will change to the root of vcs.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.shortcut_type

The shortcut type.

Plugin default: "letter"

Type: null or one of “letter”, “number” or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.theme

Dashboard comes with two themes, that each have their own distinct config options.

  • “hyper” includes a header, custom shortcuts, recent projects, recent files, and a footer.
  • “doom” is simpler, consisting of a header, center, and footer.

Some options have a note stating which theme they relate to.

Plugin default: "hyper"

Type: null or one of “hyper”, “doom” or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.disable_move

Disable movement keymaps in the dashboard buffer.

Specifically, the following keymaps are disabled:

w, f, b, h, j, k, l, <Up>, <Down>, <Left>, <Right>

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.footer

The footer text, displayed at the bottom of the buffer.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.dashboard.settings.config.header

The header text, displayed at the top of the buffer.

Plugin default:

[
  ""
  " ██████╗  █████╗ ███████╗██╗  ██╗██████╗  ██████╗  █████╗ ██████╗ ██████╗  "
  " ██╔══██╗██╔══██╗██╔════╝██║  ██║██╔══██╗██╔═══██╗██╔══██╗██╔══██╗██╔══██╗ "
  " ██║  ██║███████║███████╗███████║██████╔╝██║   ██║███████║██████╔╝██║  ██║ "
  " ██║  ██║██╔══██║╚════██║██╔══██║██╔══██╗██║   ██║██╔══██║██╔══██╗██║  ██║ "
  " ██████╔╝██║  ██║███████║██║  ██║██████╔╝╚██████╔╝██║  ██║██║  ██║██████╔╝ "
  " ╚═════╝ ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝  "
  ""
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.dashboard.settings.config.center

Actions to be added to the center section of the “doom” theme.

Note: This option is only compatible with the “doom” theme.

Type: null or (list of (attribute set of anything))

Default: null

Example:

[
  {
    action = "lua print(2)";
    desc = "Find File           ";
    desc_hl = "String";
    icon = " ";
    icon_hl = "Title";
    key = "b";
    key_format = " %s";
    key_hl = "Number";
    keymap = "SPC f f";
  }
  {
    action = {
      __raw = "function() print(3) end";
    };
    desc = "Find Dotfiles";
    icon = " ";
    key = "f";
    key_format = " %s";
    keymap = "SPC f d";
  }
]

Declared by:

plugins.dashboard.settings.config.center.*.action

Action done when you press key. Can be a command or a function.

To use a lua function, pass a raw type instead of a string, e.g:

  action.__raw = "function(path) vim.cmd('Telescope find_files cwd=' .. path) end";

Is equivialent to:

  action = "Telescope find_files cwd=";

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.desc

The action’s description, shown next to the icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.desc_hl

The highlight group to use for the description.

Plugin default: "DashboardDesc"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.icon

The icon to display with this action.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.icon_hl

The highlight group for the icon.

Plugin default: "DashboardIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.key

Shortcut key available in the dashboard buffer.

Note: this will not create an actual keymap.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.key_format

Format string used when rendering the key. %s will be substituted with value of key.

Plugin default: "[%s]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.center.*.key_hl

The highlight group to use for the key.

Plugin default: "DashboardKey"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.mru

Options relating to the “hyper” theme’s recent files list.

Note: This option is only compatible with the “hyper” theme.

Type: null or (submodule)

Default: null

Declared by:

plugins.dashboard.settings.config.mru.cwd_only

Whether to only include files from the current working directory.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.mru.icon

Icon used in the section header.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.mru.icon_hl

Highlight group used for the icon.

Plugin default: "DashboardMruIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.mru.label

Text used in the section header.

Plugin default: " Most Recent Files:"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.mru.limit

The maximum number of files to list.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.packages.enable

Show how many vim plugins are loaded.

Note: This option is only compatible with the “hyper” theme.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project

Options relating to the “hyper” theme’s recent projects list.

Note: This option is only compatible with the “hyper” theme.

Type: null or (submodule)

Default: null

Declared by:

plugins.dashboard.settings.config.project.enable

Whether to display the recent projects list.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project.action

When you press key or enter it will run this action

Plugin default: "Telescope find_files cwd="

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project.icon

Icon used in the section header.

Plugin default: "󰏓 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project.icon_hl

Highlight group used for the icon.

Plugin default: "DashboardRecentProjectIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project.label

Text used in the section header.

Plugin default: " Recent Projects:"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.project.limit

The maximum number of projects to list.

Plugin default: 8

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut

Shortcut actions to be added to the “hyper” theme.

Note: This option is only compatible with the “hyper” theme.

Type: null or (list of (attribute set of anything))

Default: null

Example:

[
  {
    action = {
      __raw = "function(path) vim.cmd('Telescope find_files') end";
    };
    desc = "Files";
    group = "Label";
    icon = " ";
    icon_hl = "@variable";
    key = "f";
  }
  {
    action = "Telescope app";
    desc = " Apps";
    group = "DiagnosticHint";
    key = "a";
  }
  {
    action = "Telescope dotfiles";
    desc = " dotfiles";
    group = "Number";
    key = "d";
  }
]

Declared by:

plugins.dashboard.settings.config.shortcut.*.action

Action done when you press key. Can be a command or a function.

To use a lua function, pass a raw type instead of a string, e.g:

  action.__raw = "function(path) vim.cmd('Telescope find_files cwd=' .. path) end";

Is equivialent to:

  action = "Telescope find_files cwd=";

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.desc

The action’s description, shown next to the icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.desc_hl

The highlight group to use for the description.

Plugin default: "DashboardDesc"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.group

Highlight group used with the “hyper” theme,

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.icon

The icon to display with this action.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.icon_hl

The highlight group for the icon.

Plugin default: "DashboardIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.key

Shortcut key available in the dashboard buffer.

Note: this will not create an actual keymap.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.shortcut.*.key_hl

The highlight group to use for the key.

Plugin default: "DashboardKey"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.week_header.enable

Whether to use a header based on the current day of the week, instead of the default “DASHBOARD” header.

A subheading showing the current time is also displayed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.config.week_header.append

Additional header lines to append after the the time line.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.dashboard.settings.config.week_header.concat

Additional text to append at the end of the time line.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.hide.statusline

Whether to hide the status line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.hide.tabline

Whether to hide the status line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.preview.command

Command to print file contents.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.preview.file_height

The height of the preview file.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.preview.file_path

Path to preview file.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dashboard.settings.preview.file_width

The width of the preview file.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

debugprint

Url: https://github.com/andrewferrier/debugprint.nvim/

Maintainers: Gaetan Lepage

plugins.debugprint.enable

Whether to enable debugprint.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.debugprint.package

Which package to use for the debugprint.nvim plugin.

Type: package

Default: <derivation vimplugin-debugprint.nvim-2024-05-16>

Declared by:

plugins.debugprint.settings

Options provided to the require('debugprint').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  commands = {
    delete_debug_prints = "DeleteDebugPrints";
    toggle_comment_debug_prints = "ToggleCommentDebugPrints";
  };
  display_counter = true;
  display_snippet = true;
  filetypes = {
    python = {
      left = "print(f'";
      mid_var = "{";
      right = "')";
      right_var = "}')";
    };
  };
  keymaps = {
    normal = {
      variable_above = "g?V";
      variable_above_alwaysprompt = {
        __raw = "nil";
      };
      variable_below = "g?v";
      variable_below_alwaysprompt = {
        __raw = "nil";
      };
    };
    visual = {
      variable_above = "g?V";
      variable_below = "g?v";
    };
  };
  move_to_debugline = false;
  print_tag = "DEBUGPRINT";
}

Declared by:

plugins.debugprint.settings.commands

By default, the plugin will create some commands for use ‘out of the box’. There are also some function invocations which are not mapped to any commands by default, but could be. This can be overridden using this option.

You only need to include the commands which you wish to override, others will default as shown in the documentation. Setting any command to nil (warning: use __raw) will skip it.

Plugin default:

{
  toggle_comment_debug_prints = "ToggleCommentDebugPrints";
  delete_debug_prints = "DeleteDebugPrints";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.debugprint.settings.display_counter

Whether to display/include the monotonically increasing counter in each debug message.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.debugprint.settings.display_snippet

Whether to include a snippet of the line above/below in plain debug lines.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.debugprint.settings.keymaps

By default, the plugin will create some keymappings for use ‘out of the box’. There are also some function invocations which are not mapped to any keymappings by default, but could be. This can be overridden using this option.

You only need to include the keys which you wish to override, others will default as shown in the documentation. Setting any key to nil (warning: use __raw) will skip it.

The default keymappings are chosen specifically because ordinarily in NeoVim they are used to convert sections to ROT-13, which most folks don’t use.

Plugin default:

{
  normal = {
    plain_below = "g?p";
    plain_above = "g?P";
    variable_below = "g?v";
    variable_above = "g?V";
    variable_below_alwaysprompt.__raw = "nil";
    variable_above_alwaysprompt.__raw = "nil";
    textobj_below = "g?o";
    textobj_above = "g?O";
    toggle_comment_debug_prints.__raw = "nil";
    delete_debug_prints.__raw = "nil";
  };
  visual = {
    variable_below = "g?v";
    variable_above = "g?V";
  };
}

Type: null or (attribute set of ((attribute set of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.debugprint.settings.move_to_debugline

When adding a debug line, moves the cursor to that line.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.debugprint.settings.print_tag

The string inserted into each print statement, which can be used to uniquely identify statements inserted by debugprint.

Plugin default: "DEBUGPRINT"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.debugprint.settings.filetypes

Custom filetypes. Your new file format will be merged in with those that already exist. If you pass in one that already exists, your configuration will override the built-in configuration.

Example:

  filetypes = {
    python = {
      left = "print(f'";
      right = "')";
      mid_var = "{";
      right_var = "}')";
    };
  };

Plugin default: {}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.debugprint.settings.filetypes.<name>.left

Left part of snippet to insert.

Type: string

Declared by:

plugins.debugprint.settings.filetypes.<name>.mid_var

Middle part of snippet to insert (variable debug line mode).

Type: string

Declared by:

plugins.debugprint.settings.filetypes.<name>.right

Right part of snippet to insert (plain debug line mode).

Type: string

Declared by:

plugins.debugprint.settings.filetypes.<name>.right_var

Right part of snippet to insert (variable debug line mode).

Type: string

Declared by:

plugins.diffview.enable

Whether to enable diffview.

Type: boolean

Default: false

Example: true

Declared by:

plugins.diffview.package

Which package to use for the diffview plugin.

Type: package

Default: <derivation vimplugin-diffview.nvim-2023-11-20>

Declared by:

plugins.diffview.diffBinaries

Show diffs for binaries

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.disableDefaultKeymaps

Disable the default keymaps;

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.enhancedDiffHl

See ‘:h diffview-config-enhanced_diff_hl’

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.diffview.gitCmd

The git executable followed by default args.

Plugin default: [ "git" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.hgCmd

The hg executable followed by default args.

Plugin default: [ "hg" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.showHelpHints

Show hints for how to open the help panel

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.useIcons

Requires nvim-web-devicons

Type: boolean

Default: true

Declared by:

plugins.diffview.watchIndex

Update views and index buffers when the git index changes.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.height

The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".

Plugin default: null

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.position

Determines where the panel is positioned (only when type="split").

Plugin default: null

Type: null or one of “left”, “top”, “right”, “bottom” or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.relative

Determines what the position is relative to (when type="split").

Plugin default: "editor"

Type: null or one of “editor”, “win” or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.type

Determines whether the window should be a float or a normal split.

Plugin default: "float"

Type: null or one of “split”, “float” or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.width

The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".

Plugin default: null

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.win

The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.commitLogPanel.winConfig.winOpts

Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.diffview.defaultArgs.diffviewFileHistory

Default args prepended to the arg-list for the listed commands

Plugin default: [ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.defaultArgs.diffviewOpen

Default args prepended to the arg-list for the listed commands

Plugin default: [ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.all

Include all refs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.author

Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.base

Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.cherryPick

Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.diffMerges

Determines how merge commits are treated.

Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.firstParent

Follow only the first parent upon seeing a merge commit.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.follow

Follow renames (only for single file).

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.g

Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.grep

Limit the commits output to ones with log message that matches the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.l

{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }

Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.leftOnly

List only the commits on the left side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.maxCount

Limit the number of commits.

Type: null or signed integer

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.merges

List only merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.noMerges

List no merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.pathArgs

Limit the target files to only the files matching the given path arguments (git pathspec is supported).

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.reflog

Include all reachable objects mentioned by reflogs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.revRange

List only the commits in the specified revision range.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.reverse

List commits in reverse order.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.rightOnly

List only the commits on the right side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.s

Look for differences that change the number of occurrences of the specified pattern (extended regular expression) in a file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.showPulls

Show merge commits that are not TREESAME to its first parent, but are to a later parent.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.all

Include all refs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.author

Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.base

Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.cherryPick

Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.diffMerges

Determines how merge commits are treated.

Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.firstParent

Follow only the first parent upon seeing a merge commit.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.follow

Follow renames (only for single file).

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.g

Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.grep

Limit the commits output to ones with log message that matches the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.l

{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }

Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.leftOnly

List only the commits on the left side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.maxCount

Limit the number of commits.

Type: null or signed integer

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.merges

List only merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.noMerges

List no merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.pathArgs

Limit the target files to only the files matching the given path arguments (git pathspec is supported).

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.reflog

Include all reachable objects mentioned by reflogs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.revRange

List only the commits in the specified revision range.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.reverse

List commits in reverse order.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.rightOnly

List only the commits on the right side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.s

Look for differences that change the number of occurrences of the specified pattern (extended regular expression) in a file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.showPulls

Show merge commits that are not TREESAME to its first parent, but are to a later parent.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.all

Include all refs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.author

Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.base

Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.cherryPick

Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.diffMerges

Determines how merge commits are treated.

Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.firstParent

Follow only the first parent upon seeing a merge commit.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.follow

Follow renames (only for single file).

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.g

Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.grep

Limit the commits output to ones with log message that matches the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.l

{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }

Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.leftOnly

List only the commits on the left side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.maxCount

Limit the number of commits.

Type: null or signed integer

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.merges

List only merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.noMerges

List no merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.pathArgs

Limit the target files to only the files matching the given path arguments (git pathspec is supported).

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.reflog

Include all reachable objects mentioned by reflogs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.revRange

List only the commits in the specified revision range.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.reverse

List commits in reverse order.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.rightOnly

List only the commits on the right side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.s

Look for differences that change the number of occurrences of the specified pattern (extended regular expression) in a file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.showPulls

Show merge commits that are not TREESAME to its first parent, but are to a later parent.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.all

Include all refs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.author

Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.base

Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.cherryPick

Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.diffMerges

Determines how merge commits are treated.

Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.firstParent

Follow only the first parent upon seeing a merge commit.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.follow

Follow renames (only for single file).

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.g

Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.grep

Limit the commits output to ones with log message that matches the specified pattern (regular expression).

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.l

{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }

Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.leftOnly

List only the commits on the left side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.maxCount

Limit the number of commits.

Type: null or signed integer

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.merges

List only merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.noMerges

List no merge commits.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.pathArgs

Limit the target files to only the files matching the given path arguments (git pathspec is supported).

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.reflog

Include all reachable objects mentioned by reflogs.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.revRange

List only the commits in the specified revision range.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.reverse

List commits in reverse order.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.rightOnly

List only the commits on the right side of a symmetric difference.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.s

Look for differences that change the number of occurrences of the specified pattern (extended regular expression) in a file.

Type: null or string

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.showPulls

Show merge commits that are not TREESAME to its first parent, but are to a later parent.

Type: null or boolean

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.height

The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".

Plugin default: 16

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.position

Determines where the panel is positioned (only when type="split").

Plugin default: "bottom"

Type: null or one of “left”, “top”, “right”, “bottom” or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.relative

Determines what the position is relative to (when type="split").

Plugin default: "editor"

Type: null or one of “editor”, “win” or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.type

Determines whether the window should be a float or a normal split.

Plugin default: "split"

Type: null or one of “split”, “float” or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.width

The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".

Plugin default: null

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.win

The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.fileHistoryPanel.winConfig.winOpts

Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.diffview.filePanel.listingStyle

One of ‘list’ or ‘tree’

Plugin default: "tree"

Type: null or one of “list”, “tree” or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.treeOptions.flattenDirs

Flatten dirs that only contain one single dir Only applies when listing_style is ‘tree’

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.treeOptions.folderStatuses

One of ‘never’, ‘only_folded’ or ‘always’. Only applies when listing_style is ‘tree’

Plugin default: "only_folded"

Type: null or one of “never”, “only_folded”, “always” or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.height

The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".

Plugin default: null

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.position

Determines where the panel is positioned (only when type="split").

Plugin default: "left"

Type: null or one of “left”, “top”, “right”, “bottom” or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.relative

Determines what the position is relative to (when type="split").

Plugin default: "editor"

Type: null or one of “editor”, “win” or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.type

Determines whether the window should be a float or a normal split.

Plugin default: "split"

Type: null or one of “split”, “float” or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.width

The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".

Plugin default: 35

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.win

The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.diffview.filePanel.winConfig.winOpts

Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.diffview.hooks.diffBufRead

{diff_buf_read} (fun(bufnr: integer, ctx: table))

Emitted after a new diff buffer is ready (the first time it's
created and loaded into a window). Diff buffers are all
buffers with |diff-mode| enabled. That includes buffers of
local files (not created from git).

This is always called with the new buffer as the current
buffer and the correct diff window as the current window such
that |:setlocal| will apply settings to the relevant buffer /
window.

Callback Parameters:
    {bufnr} (`integer`)
        The buffer number of the new buffer.
    {ctx} (`table`)
        • {symbol} (string)
          A symbol that identifies the window's position in
          the layout. These symbols correspond with the
          figures under |diffview-config-view.x.layout|.
        • {layout_name} (string)
          The name of the current layout.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.diffBufWinEnter

{diff_buf_win_enter} (fun(bufnr: integer, winid: integer, ctx: table))

Emitted after a diff buffer is displayed in a window.

This is always called with the new buffer as the current
buffer and the correct diff window as the current window such
that |:setlocal| will apply settings to the relevant buffer /
window.

Callback Parameters:
    {bufnr} (`integer`)
        The buffer number of the new buffer.
    {winid} (`integer`)
        The window id of window inside which the buffer was
        displayed.
    {ctx} (`table`)
        • {symbol} (string)
          A symbol that identifies the window's position in
          the layout. These symbols correspond with the
          figures under |diffview-config-view.x.layout|.
        • {layout_name} (string)
          The name of the current layout.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.viewClosed

{view_closed} (fun(view: View))

Emitted after closing a view.

Callback Parameters:
    {view} (`View`)
        The `View` instance that was closed.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.viewEnter

{view_enter} (fun(view: View))

Emitted just after entering the tabpage of a view.

Callback Parameters:
    {view} (`View`)
        The `View` instance that was entered.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.viewLeave

{view_leave} (fun(view: View))

Emitted just before leaving the tabpage of a view.

Callback Parameters:
    {view} (`View`)
        The `View` instance that's about to be left.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.viewOpened

{view_opened} (fun(view: View))

Emitted after a new view has been opened. It’s called after initializing the layout in the new tabpage (all windows are ready).

Callback Parameters: {view} (View) The View instance that was opened.

Type: null or string

Default: null

Declared by:

plugins.diffview.hooks.viewPostLayout

{view_post_layout} (fun(view: View))

Emitted after the window layout in a view has been adjusted.

Callback Parameters:
    {view} (`View`)
        The `View` whose layout was adjusted.

Type: null or string

Default: null

Declared by:

plugins.diffview.icons.folderClosed

Only applies when use_icons is true.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.diffview.icons.folderOpen

Only applies when use_icons is true.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.diffview.keymaps.disableDefaults

Disable the default keymaps.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.keymaps.diff1

List of keybindings. Mappings in single window diff layouts

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.diff1.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.diff1.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.diff1.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.diff1.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.diff2

List of keybindings. Mappings in 2-way diff layouts

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.diff2.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.diff2.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.diff2.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.diff2.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.diff3

List of keybindings. Mappings in 3-way diff layouts

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.diff3.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.diff3.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.diff3.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.diff3.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.diff4

List of keybindings. Mappings in 4-way diff layouts

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.diff4.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.diff4.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.diff4.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.diff4.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.fileHistoryPanel

List of keybindings. Mappings in file history panel.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.fileHistoryPanel.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.fileHistoryPanel.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.fileHistoryPanel.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.fileHistoryPanel.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.filePanel

List of keybindings. Mappings in file panel.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.filePanel.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.filePanel.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.filePanel.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.filePanel.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.helpPanel

List of keybindings. Mappings in help panel.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.helpPanel.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.helpPanel.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.helpPanel.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.helpPanel.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.optionPanel

List of keybindings. Mappings in options panel.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.optionPanel.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.optionPanel.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.optionPanel.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.optionPanel.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.keymaps.view

List of keybindings. The view bindings are active in the diff buffers, only when the current tabpage is a Diffview.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "actions.select_next_entry";
    description = "Open the diff for the next file";
    key = "<tab>";
    mode = "n";
  }
]

Declared by:

plugins.diffview.keymaps.view.*.action

action for keybinding

Type: string

Example: "action.select_next_entry"

Declared by:

plugins.diffview.keymaps.view.*.description

description for keybinding

Type: null or string

Default: null

Declared by:

plugins.diffview.keymaps.view.*.key

key to bind keybinding to

Type: string

Example: "<tab>"

Declared by:

plugins.diffview.keymaps.view.*.mode

mode to bind keybinding to

Type: string

Example: "n"

Declared by:

plugins.diffview.signs.done

Plugin default: "✓"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.diffview.signs.foldClosed

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.diffview.signs.foldOpen

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.diffview.view.default.layout

Config for changed files, and staged files in diff views. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.

  • A: Old state
  • B: New state

diff2_horizontal:

| A | B |

diff2_vertical:

A

─

B

Plugin default: "diff2_horizontal"

Type: null or one of “diff2_horizontal”, “diff2_vertical” or raw lua code

Default: null

Declared by:

plugins.diffview.view.default.winbarInfo

See ‘:h diffview-config-view.x.winbar_info’

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.view.fileHistory.layout

Config for changed files in file history views. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.

  • A: Old state
  • B: New state

diff2_horizontal:

| A | B |

diff2_vertical:

A

─

B

Plugin default: "diff2_horizontal"

Type: null or one of “diff2_horizontal”, “diff2_vertical” or raw lua code

Default: null

Declared by:

plugins.diffview.view.fileHistory.winbarInfo

See ‘:h diffview-config-view.x.winbar_info’

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.view.mergeTool.disableDiagnostics

Temporarily disable diagnostics for conflict buffers while in the view.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.diffview.view.mergeTool.layout

Config for conflicted files in diff views during a merge or rebase. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.

  • A: OURS (current branch)
  • B: LOCAL (the file as it currently exists on disk)
  • C: THEIRS (incoming branch)
  • D: BASE (common ancestor)

diff1_plain:

B

diff3_horizontal:

A | B | C

diff3_vertical:

A

B

C

diff3_mixed:

A | C

B

diff4_mixed:

A | D | C

B

Plugin default: "diff3_horizontal"

Type: null or one of “diff1_plain”, “diff3_horizontal”, “diff3_vertical”, “diff3_mixed”, “diff4_mixed” or raw lua code

Default: null

Declared by:

plugins.diffview.view.mergeTool.winbarInfo

See ‘:h diffview-config-view.x.winbar_info’

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

direnv

Url: https://github.com/direnv/direnv.vim/

Maintainers: Alison Jenkins

plugins.direnv.enable

Whether to enable direnv.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.direnv.package

Which package to use for the direnv plugin.

Type: package

Default: <derivation vimplugin-direnv.vim-2023-12-02>

Declared by:

plugins.direnv.settings

The configuration options for direnv without the direnv_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal direnv_foo_bar=1
  • hello = "world" -> :setglobal direnv_hello="world"
  • some_toggle = true -> :setglobal direnv_some_toggle
  • other_toggle = false -> :setglobal nodirenv_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.direnv.settings.direnv_auto

It will not execute :DirenvExport automatically if the value is false. Default: true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.direnv.settings.direnv_edit_mode

Select the command to open buffers to edit. Default: ‘edit’.

Plugin default: "edit"

Type: null or one of “edit”, “split”, “tabedit”, “vsplit” or raw lua code

Default: null

Declared by:

plugins.direnv.settings.direnv_silent_load

Stop echoing output from Direnv command. Default: true

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

dressing

Url: https://github.com/stevearc/dressing.nvim/

Maintainers: Andres Bermeo Marinelli

plugins.dressing.enable

Whether to enable dressing.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.dressing.package

Which package to use for the dressing.nvim plugin.

Type: package

Default: <derivation vimplugin-dressing.nvim-2024-05-16>

Declared by:

plugins.dressing.settings

Options provided to the require('dressing').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  input = {
    enabled = true;
    mappings = {
      i = {
        "<C-c>" = "Close";
        "<CR>" = "Confirm";
        "<Down>" = "HistoryNext";
        "<Up>" = "HistoryPrev";
      };
      n = {
        "<CR>" = "Confirm";
        "<Esc>" = "Close";
      };
    };
  };
  select = {
    backend = [
      "telescope"
      "fzf_lua"
      "fzf"
      "builtin"
      "nui"
    ];
    builtin = {
      mappings = {
        "<C-c>" = "Close";
        "<CR>" = "Confirm";
        "<Esc>" = "Close";
      };
    };
    enabled = true;
  };
}

Declared by:

plugins.dressing.settings.input.enabled

Enable the vim.ui.input implementation.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.border

Defines the border to use for the input window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.buf_options

An attribute set of neovim buffer options.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.input.default_prompt

Default prompt string for vim.ui.input.

Plugin default: "Input"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.get_config

This can be a function that accepts the opts parameter that is passed in to ‘vim.select’ or ‘vim.input’. It must return either nil or config values to use in place of the global config values for that module.

See :h dressing_get_config for more info.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.input.insert_only

When true, <Esc> will close the modal.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.mappings

Mappings for defined modes.

To disable a default mapping in a specific mode, set it to false.

Plugin default:

{
  n = {
    "<Esc>" = "Close";
    "<CR>" = "Confirm";
  };
  i = {
    "<C-c>" = "Close";
    "<CR>" = "Confirm";
    "<Up>" = "HistoryPrev";
    "<Down>" = "HistoryNext";
  };
}

Type: null or (attribute set of ((attribute set of (string or value false (singular enum))) or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.input.max_width

Max width of window.

Can be a list of mixed types, e.g. [140 0.9] means “less than 140 columns or 90% of total.”

Plugin default: [140 0.9]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.input.min_width

Min width of window.

Can be a list of mixed types, e.g. [140 0.9] means “less than 140 columns or 90% of total.”

Plugin default: [20 0.2]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.input.override

Lua function that takes config that is passed to nvim_open_win. Used to customize the layout.

Plugin default: function(conf) return conf end

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.input.prefer_width

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: 40

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.input.relative

Affects the dimensions of the window with respect to this setting. If ‘editor’ or ‘win’, will default to being centered.

Plugin default: "cursor"

Type: null or one of “cursor”, “win”, “editor” or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.start_in_insert

When true, input will start in insert mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.title_pos

Position of title.

Plugin default: "left"

Type: null or one of “left”, “right”, “center” or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.trim_prompt

Trim trailing : from prompt.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.width

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: null

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.input.win_options

An attribute set of window options.

Plugin default:

{
  wrap = false;
  list = true;
  listchars = "precedes:...,extends:...";
  sidescrolloff = 0;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.enabled

Enable the vim.ui.select implementation.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.select.backend

Priority list of preferred vim.select implementations.

Plugin default:

["telescope" "fzf_lua" "fzf" "builtin" "nui"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.format_item_override

Override the formatting/display for a specific “kind” when using vim.ui.select. For example, code actions from vim.lsp.buf.code_action use a kind=“codeaction”. You can override the format function when selecting for that kind, e.g.

{
  codeaction = \'\'
    function(action_tuple)
      local title = action_tuple[2].title:gsub("\r\n", "\\r\\n")
      local client = vim.lsp.get_client_by_id(action_tuple[1])
      return string.format("%s\t[%s]", title:gsub("\n", "\\n"), client.name)
    end
   \'\';
}

Plugin default: {}

Type: null or (attribute set of (lua function string or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.fzf_lua

Options for fzf-lua selector.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.get_config

This can be a function that accepts the opts parameter that is passed in to ‘vim.select’ or ‘vim.input’. It must return either nil or config values to use in place of the global config values for that module.

See :h dressing_get_config for more info.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.select.nui

Options for nui selector.

Plugin default:

{
  position = "50%";
  size = null;
  relative = "editor";
  border = {
    style = "rounded";
  };
  buf_options = {
    swapfile = false;
    filetype = "DressingSelect";
  };
  win_options = {
    winblend = 0;
  };
  max_width = 80;
  max_height = 40;
  min_width = 40;
  min_height = 10;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.telescope

Options for telescope selector.

Can be a raw lua string like:

telescope = \'\'require("telescope.themes").get_ivy({})\'\'

or an attribute set of telescope settings.

Plugin default: null

Type: null or lua code string or attribute set of anything

Default: null

Declared by:

plugins.dressing.settings.select.trim_prompt

Trim trailing : from prompt.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.select.builtin.border

Defines the border to use for the select window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.dressing.settings.select.builtin.buf_options

An attribute set of buffer options.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.height

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: null

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.select.builtin.mappings

Mappings in normal mode for the builtin selector.

To disable a default mapping in a specific mode, set it to false.

Plugin default:

{
  "<Esc>" = "Close";
  "<C-c>" = "Close";
  "<CR>" = "Confirm";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.max_height

Max height of window.

Can be a list of mixed types, e.g. [140 0.8] means “less than 140 rows or 80% of total.”

Plugin default: 0.9

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.max_width

Max width of window.

Can be a list of mixed types, e.g. [140 0.8] means “less than 140 columns or 80% of total.”

Plugin default: [140 0.8]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.min_height

Min height of window.

Can be a list of mixed types, e.g. [10 0.2] means “less than 10 rows or 20% of total.”

Plugin default: [10 0.2]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.min_width

Min width of window.

Can be a list of mixed types, e.g. [40 0.2] means “less than 40 columns or 20% of total.”

Plugin default: [40 0.2]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.select.builtin.override

Lua function that takes config that is passed to nvim_open_win. Used to customize the layout.

Plugin default: function(conf) return conf end

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.select.builtin.relative

Affects the dimensions of the window with respect to this setting. If ‘editor’ or ‘win’, will default to being centered.

Plugin default: "editor"

Type: null or one of “editor”, “win”, “cursor” or raw lua code

Default: null

Declared by:

plugins.dressing.settings.select.builtin.show_numbers

Display numbers for options and set up keymaps.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.select.builtin.width

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: null

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.select.builtin.win_options

An attribute set of window options.

Plugin default:

{
  cursorline = true;
  cursorlineopt = "both";
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.select.fzf.window

Window options for fzf selector.

Plugin default:

{
  width = 0.5;
  height = 0.4;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.easyescape.enable

Whether to enable easyescape.

Type: boolean

Default: false

Example: true

Declared by:

plugins.easyescape.package

Which package to use for the easyescape plugin.

Type: package

Default: <derivation vimplugin-vim-easyescape-2020-11-22>

Declared by:

edgy

Url: https://github.com/folke/edgy.nvim/

Maintainers: Gaetan Lepage

plugins.edgy.enable

Whether to enable edgy.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.edgy.package

Which package to use for the edgy.nvim plugin.

Type: package

Default: <derivation vimplugin-edgy.nvim-2024-03-26>

Declared by:

plugins.edgy.settings

Options provided to the require('edgy').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  animate = {
    enabled = false;
  };
  bottom = [
    {
      filter = ''
        function(buf, win)
          return vim.api.nvim_win_get_config(win).relative == ""
        end
      '';
      ft = "toggleterm";
      size = 30;
    }
    {
      filter = ''
        function(buf)
          return vim.bo[buf].buftype == "help"
        end
      '';
      ft = "help";
      size = 20;
    }
  ];
  left = [
    {
      ft = "NvimTree";
      size = 30;
      title = "nvimtree";
    }
    {
      ft = "Outline";
      open = "SymbolsOutline";
    }
    {
      ft = "dapui_scopes";
    }
    {
      ft = "dapui_breakpoints";
    }
    {
      ft = "dap-repl";
    }
  ];
  wo = {
    signcolumn = "no";
    spell = false;
    winbar = false;
    winfixheight = false;
    winfixwidth = false;
    winhighlight = "";
  };
}

Declared by:

plugins.edgy.settings.bottom

List of the bottom edgebar configurations.

Plugin default: [ ]

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Declared by:

plugins.edgy.settings.close_when_all_hidden

Close edgy when all windows are hidden instead of opening one of them. Disable to always keep at least one edgy split visible in each open section.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.edgy.settings.exit_when_last

Enable this to exit Neovim when only edgy windows are left.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.edgy.settings.keys

Buffer-local keymaps to be added to edgebar buffers. Existing buffer-local keymaps will never be overridden.

Each value is either:

  • A function declaration (as a raw lua string) -> fun(win:Edgy.Window)
  • false to disable this mapping.

Plugin default:

{
  "<c-q>" = ''
    function(win)
      win:hide()
    end
  '';
  "<c-w>+" = ''
    function(win)
      win:resize("height", 2)
    end
  '';
  "<c-w>-" = ''
    function(win)
      win:resize("height", -2)
    end
  '';
  "<c-w><lt>" = ''
    function(win)
      win:resize("width", -2)
    end
  '';
  "<c-w>=" = ''
    function(win)
      win.view.edgebar:equalize()
    end
  '';
  "<c-w>>" = ''
    function(win)
      win:resize("width", 2)
    end
  '';
  Q = ''
    function(win)
      win.view.edgebar:close()
    end
  '';
  "[W" = ''
    function(win)
      win:prev({ pinned = false, focus = true })
    end
  '';
  "[w" = ''
    function(win)
      win:prev({ visible = true, focus = true })
    end
  '';
  "]W" = ''
    function(win)
      win:next({ pinned = false, focus = true })
    end
  '';
  "]w" = ''
    function(win)
      win:next({ visible = true, focus = true })
    end
  '';
  q = ''
    function(win)
      win:close()
    end
  '';
}

Type: attribute set of (lua function string or value false (singular enum))

Default: { }

Declared by:

plugins.edgy.settings.left

List of the left edgebar configurations.

Plugin default: [ ]

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Declared by:

plugins.edgy.settings.right

List of the right edgebar configurations.

Plugin default: [ ]

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Declared by:

plugins.edgy.settings.top

List of the top edgebar configurations.

Plugin default: [ ]

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Declared by:

plugins.edgy.settings.wo

Global window options for edgebar windows.

Plugin default:

{
  signcolumn = "no";
  spell = false;
  winbar = true;
  winfixheight = false;
  winfixwidth = true;
  winhighlight = "WinBar:EdgyWinBar,Normal:EdgyNormal";
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.edgy.settings.animate.enabled

Whether to enable animations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.edgy.settings.animate.cps

Cells per second.

Plugin default: 120

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.animate.fps

Frames per second.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.animate.on_begin

Callback for the beginning of animations.

Plugin default:

function()
  vim.g.minianimate_disable = true
end

Type: null or lua function string

Default: null

Declared by:

plugins.edgy.settings.animate.on_end

Callback for the ending of animations.

Plugin default:

function()
  vim.g.minianimate_disable = false
end

Type: null or lua function string

Default: null

Declared by:

plugins.edgy.settings.animate.spinner

Spinner for pinned views that are loading.

Plugin default:

{
  frames = [
    "⠋"
    "⠙"
    "⠹"
    "⠸"
    "⠼"
    "⠴"
    "⠦"
    "⠧"
    "⠇"
    "⠏"
  ];
  interval = 80;
}

Type: null or lua code string or (attribute set of anything)

Default: null

Example: "require('noice.util.spinners').spinners.circleFull"

Declared by:

plugins.edgy.settings.icons.closed

Icon for closed edgebars.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.edgy.settings.icons.open

Icon for opened edgebars.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.edgy.settings.options.bottom.size

Size of the short edge of the edgebar. For edgebars, this is the minimum width. For panels, minimum height.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.options.bottom.wo

View-specific window options.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.edgy.settings.options.left.size

Size of the short edge of the edgebar. For edgebars, this is the minimum width. For panels, minimum height.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.options.left.wo

View-specific window options.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.edgy.settings.options.right.size

Size of the short edge of the edgebar. For edgebars, this is the minimum width. For panels, minimum height.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.options.right.wo

View-specific window options.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.edgy.settings.options.top.size

Size of the short edge of the edgebar. For edgebars, this is the minimum width. For panels, minimum height.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.edgy.settings.options.top.wo

View-specific window options.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.efmls-configs.enable

Whether to enable efmls-configs, premade configurations for efm-langserver.

Type: boolean

Default: false

Example: true

Declared by:

plugins.efmls-configs.package

Which package to use for the efmls-configs-nvim plugin.

Type: package

Default: <derivation vimplugin-efmls-configs-nvim-2024-05-07>

Declared by:

plugins.efmls-configs.externallyManagedPackages

Linters/Formatters to skip installing with nixvim. Set to all to install no packages

Type: value “all” (singular enum) or list of string

Default: [ ]

Declared by:

plugins.efmls-configs.setup

Configuration for each filetype. Use all to match any filetype.

Type: attribute set

Default: { }

Declared by:

plugins.efmls-configs.setup.all.formatter

formatter tools for all languages

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.all.linter

linter tools for all languages

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.bash.formatter

formatter tools for bash

Type: one of “beautysh”, “shfmt” or raw lua code or list of (one of “beautysh”, “shfmt” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.bash.linter

linter tools for bash

Type: one of “bashate”, “shellcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “bashate”, “shellcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.blade.formatter

formatter tools for blade

Type: value “blade_formatter” (singular enum) or raw lua code or list of (value “blade_formatter” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.blade.linter

linter tools for blade

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.c.formatter

formatter tools for c

Type: one of “astyle”, “clang_format”, “clang_tidy”, “uncrustify” or raw lua code or list of (one of “astyle”, “clang_format”, “clang_tidy”, “uncrustify” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.c.linter

linter tools for c

Type: one of “clang_tidy”, “cppcheck”, “cpplint”, “flawfinder”, “gcc”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “clang_tidy”, “cppcheck”, “cpplint”, “flawfinder”, “gcc”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."c#".formatter

formatter tools for c#

Type: one of “dotnet_format”, “uncrustify” or raw lua code or list of (one of “dotnet_format”, “uncrustify” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."c#".linter

linter tools for c#

Type: one of “mcs”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “mcs”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."c++".formatter

formatter tools for c++

Type: one of “astyle”, “clang_format”, “clang_tidy”, “uncrustify” or raw lua code or list of (one of “astyle”, “clang_format”, “clang_tidy”, “uncrustify” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."c++".linter

linter tools for c++

Type: one of “clang_tidy”, “clazy”, “cppcheck”, “cpplint”, “gcc”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “clang_tidy”, “clazy”, “cppcheck”, “cpplint”, “gcc”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.clojure.formatter

formatter tools for clojure

Type: one of “cljstyle”, “joker” or raw lua code or list of (one of “cljstyle”, “joker” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.clojure.linter

linter tools for clojure

Type: one of “clj_kondo”, “joker”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “clj_kondo”, “joker”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.cmake.formatter

formatter tools for cmake

Type: value “gersemi” (singular enum) or raw lua code or list of (value “gersemi” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.cmake.linter

linter tools for cmake

Type: one of “cmake_lint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “cmake_lint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.crystal.formatter

formatter tools for crystal

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.crystal.linter

linter tools for crystal

Type: one of “ameba”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “ameba”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.csh.formatter

formatter tools for csh

Type: value “beautysh” (singular enum) or raw lua code or list of (value “beautysh” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.csh.linter

linter tools for csh

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.css.formatter

formatter tools for css

Type: one of “fecs”, “prettier”, “prettier_d”, “stylelint” or raw lua code or list of (one of “fecs”, “prettier”, “prettier_d”, “stylelint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.css.linter

linter tools for css

Type: one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.d.formatter

formatter tools for d

Type: one of “dfmt”, “uncrustify” or raw lua code or list of (one of “dfmt”, “uncrustify” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.d.linter

linter tools for d

Type: one of “dmd”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “dmd”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.dart.formatter

formatter tools for dart

Type: value “dartfmt” (singular enum) or raw lua code or list of (value “dartfmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.dart.linter

linter tools for dart

Type: one of “dartanalyzer”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “dartanalyzer”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.docker.formatter

formatter tools for docker

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.docker.linter

linter tools for docker

Type: one of “hadolint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “hadolint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.fennel.formatter

formatter tools for fennel

Type: value “fnlfmt” (singular enum) or raw lua code or list of (value “fnlfmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.fennel.linter

linter tools for fennel

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.fish.formatter

formatter tools for fish

Type: value “fish_indent” (singular enum) or raw lua code or list of (value “fish_indent” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.fish.linter

linter tools for fish

Type: one of “fish”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “fish”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.gitcommit.formatter

formatter tools for gitcommit

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.gitcommit.linter

linter tools for gitcommit

Type: one of “gitlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “gitlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.go.formatter

formatter tools for go

Type: one of “gofmt”, “gofumpt”, “goimports”, “golines” or raw lua code or list of (one of “gofmt”, “gofumpt”, “goimports”, “golines” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.go.linter

linter tools for go

Type: one of “djlint”, “go_revive”, “golangci_lint”, “golint”, “staticcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “djlint”, “go_revive”, “golangci_lint”, “golint”, “staticcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.haskell.formatter

formatter tools for haskell

Type: value “fourmolu” (singular enum) or raw lua code or list of (value “fourmolu” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.haskell.linter

linter tools for haskell

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.html.formatter

formatter tools for html

Type: one of “fecs”, “prettier”, “prettier_d” or raw lua code or list of (one of “fecs”, “prettier”, “prettier_d” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.html.linter

linter tools for html

Type: one of “djlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “djlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.java.formatter

formatter tools for java

Type: one of “google_java_format”, “uncrustify” or raw lua code or list of (one of “google_java_format”, “uncrustify” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.java.linter

linter tools for java

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.javascript.formatter

formatter tools for javascript

Type: one of “biome”, “deno_fmt”, “dprint”, “eslint”, “eslint_d”, “fecs”, “js_standard”, “prettier”, “prettier_d”, “prettier_eslint”, “prettier_standard”, “rome”, “xo” or raw lua code or list of (one of “biome”, “deno_fmt”, “dprint”, “eslint”, “eslint_d”, “fecs”, “js_standard”, “prettier”, “prettier_d”, “prettier_eslint”, “prettier_standard”, “rome”, “xo” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.javascript.linter

linter tools for javascript

Type: one of “eslint”, “eslint_d”, “fecs”, “js_standard”, “xo”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “eslint”, “eslint_d”, “fecs”, “js_standard”, “xo”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.javascriptreact.formatter

formatter tools for javascriptreact

Type: value “deno_fmt” (singular enum) or raw lua code or list of (value “deno_fmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.javascriptreact.linter

linter tools for javascriptreact

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.json.formatter

formatter tools for json

Type: one of “biome”, “dprint”, “fixjson”, “jq”, “prettier”, “prettier_d”, “rome” or raw lua code or list of (one of “biome”, “dprint”, “fixjson”, “jq”, “prettier”, “prettier_d”, “rome” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.json.linter

linter tools for json

Type: one of “jq”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “jq”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.jsonc.formatter

formatter tools for jsonc

Type: value “biome” (singular enum) or raw lua code or list of (value “biome” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.jsonc.linter

linter tools for jsonc

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.ksh.formatter

formatter tools for ksh

Type: value “beautysh” (singular enum) or raw lua code or list of (value “beautysh” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.ksh.linter

linter tools for ksh

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.less.formatter

formatter tools for less

Type: one of “prettier”, “prettier_d”, “stylelint” or raw lua code or list of (one of “prettier”, “prettier_d”, “stylelint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.less.linter

linter tools for less

Type: one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.lua.formatter

formatter tools for lua

Type: one of “lua_format”, “stylua” or raw lua code or list of (one of “lua_format”, “stylua” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.lua.linter

linter tools for lua

Type: one of “luacheck”, “selene”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “luacheck”, “selene”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.make.formatter

formatter tools for make

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.make.linter

linter tools for make

Type: one of “checkmake”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “checkmake”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.markdown.formatter

formatter tools for markdown

Type: one of “cbfmt”, “dprint”, “mdformat” or raw lua code or list of (one of “cbfmt”, “dprint”, “mdformat” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.markdown.linter

linter tools for markdown

Type: one of “markdownlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “markdownlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.misc.formatter

formatter tools for misc

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.misc.linter

linter tools for misc

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.nix.formatter

formatter tools for nix

Type: one of “alejandra”, “nixfmt” or raw lua code or list of (one of “alejandra”, “nixfmt” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.nix.linter

linter tools for nix

Type: one of “statix”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “statix”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.objective-c.formatter

formatter tools for objective-c

Type: value “uncrustify” (singular enum) or raw lua code or list of (value “uncrustify” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.objective-c.linter

linter tools for objective-c

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."objective-c++".formatter

formatter tools for objective-c++

Type: value “uncrustify” (singular enum) or raw lua code or list of (value “uncrustify” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup."objective-c++".linter

linter tools for objective-c++

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.pawn.formatter

formatter tools for pawn

Type: value “uncrustify” (singular enum) or raw lua code or list of (value “uncrustify” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.pawn.linter

linter tools for pawn

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.php.formatter

formatter tools for php

Type: one of “php_cs_fixer”, “phpcbf”, “pint” or raw lua code or list of (one of “php_cs_fixer”, “phpcbf”, “pint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.php.linter

linter tools for php

Type: one of “djlint”, “phan”, “php”, “phpcs”, “phpstan”, “psalm”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “djlint”, “phan”, “php”, “phpcs”, “phpstan”, “psalm”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.proto.formatter

formatter tools for proto

Type: one of “buf”, “protolint” or raw lua code or list of (one of “buf”, “protolint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.proto.linter

linter tools for proto

Type: one of “buf”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “buf”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.python.formatter

formatter tools for python

Type: one of “autopep8”, “black”, “isort”, “ruff”, “yapf” or raw lua code or list of (one of “autopep8”, “black”, “isort”, “ruff”, “yapf” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.python.linter

linter tools for python

Type: one of “djlint”, “flake8”, “mypy”, “pylint”, “ruff”, “vulture”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “djlint”, “flake8”, “mypy”, “pylint”, “ruff”, “vulture”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.roslyn.formatter

formatter tools for roslyn

Type: value “dprint” (singular enum) or raw lua code or list of (value “dprint” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.roslyn.linter

linter tools for roslyn

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.ruby.formatter

formatter tools for ruby

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.ruby.linter

linter tools for ruby

Type: one of “debride”, “reek”, “rubocop”, “sorbet”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “debride”, “reek”, “rubocop”, “sorbet”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.rust.formatter

formatter tools for rust

Type: one of “dprint”, “rustfmt” or raw lua code or list of (one of “dprint”, “rustfmt” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.rust.linter

linter tools for rust

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sass.formatter

formatter tools for sass

Type: one of “prettier”, “prettier_d”, “stylelint” or raw lua code or list of (one of “prettier”, “prettier_d”, “stylelint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sass.linter

linter tools for sass

Type: one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.scala.formatter

formatter tools for scala

Type: value “scalafmt” (singular enum) or raw lua code or list of (value “scalafmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.scala.linter

linter tools for scala

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.scss.formatter

formatter tools for scss

Type: one of “prettier”, “prettier_d”, “stylelint” or raw lua code or list of (one of “prettier”, “prettier_d”, “stylelint” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.scss.linter

linter tools for scss

Type: one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “stylelint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sh.formatter

formatter tools for sh

Type: one of “beautysh”, “shellharden”, “shfmt” or raw lua code or list of (one of “beautysh”, “shellharden”, “shfmt” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sh.linter

linter tools for sh

Type: one of “shellcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “shellcheck”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.slim.formatter

formatter tools for slim

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.slim.linter

linter tools for slim

Type: one of “slim_lint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “slim_lint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sml.formatter

formatter tools for sml

Type: value “smlfmt” (singular enum) or raw lua code or list of (value “smlfmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sml.linter

linter tools for sml

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.solidity.formatter

formatter tools for solidity

Type: value “forge_fmt” (singular enum) or raw lua code or list of (value “forge_fmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.solidity.linter

linter tools for solidity

Type: one of “slither”, “solhint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “slither”, “solhint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sql.formatter

formatter tools for sql

Type: value “sql-formatter” (singular enum) or raw lua code or list of (value “sql-formatter” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.sql.linter

linter tools for sql

Type: one of “sqlfluff”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “sqlfluff”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.swift.formatter

formatter tools for swift

Type: value “swiftformat” (singular enum) or raw lua code or list of (value “swiftformat” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.swift.linter

linter tools for swift

Type: one of “swiftlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “swiftlint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.terraform.formatter

formatter tools for terraform

Type: value “terraform_fmt” (singular enum) or raw lua code or list of (value “terraform_fmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.terraform.linter

linter tools for terraform

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.tex.formatter

formatter tools for tex

Type: value “latexindent” (singular enum) or raw lua code or list of (value “latexindent” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.tex.linter

linter tools for tex

Type: one of “chktex”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “chktex”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.toml.formatter

formatter tools for toml

Type: one of “dprint”, “taplo” or raw lua code or list of (one of “dprint”, “taplo” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.toml.linter

linter tools for toml

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typescript.formatter

formatter tools for typescript

Type: one of “biome”, “deno_fmt”, “dprint”, “eslint”, “eslint_d”, “fecs”, “prettier”, “prettier_d”, “prettier_eslint”, “prettier_standard”, “rome”, “xo” or raw lua code or list of (one of “biome”, “deno_fmt”, “dprint”, “eslint”, “eslint_d”, “fecs”, “prettier”, “prettier_d”, “prettier_eslint”, “prettier_standard”, “rome”, “xo” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typescript.linter

linter tools for typescript

Type: one of “eslint”, “eslint_d”, “xo”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “eslint”, “eslint_d”, “xo”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typescriptreact.formatter

formatter tools for typescriptreact

Type: value “deno_fmt” (singular enum) or raw lua code or list of (value “deno_fmt” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typescriptreact.linter

linter tools for typescriptreact

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typst.formatter

formatter tools for typst

Type: one of “prettypst”, “typstfmt” or raw lua code or list of (one of “prettypst”, “typstfmt” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.typst.linter

linter tools for typst

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.vala.formatter

formatter tools for vala

Type: value “uncrustify” (singular enum) or raw lua code or list of (value “uncrustify” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.vala.linter

linter tools for vala

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.vim.formatter

formatter tools for vim

Type: impossible (empty enum) or raw lua code or list of (impossible (empty enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.vim.linter

linter tools for vim

Type: one of “vint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “vint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.yaml.formatter

formatter tools for yaml

Type: one of “prettier”, “yq” or raw lua code or list of (one of “prettier”, “yq” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.yaml.linter

linter tools for yaml

Type: one of “actionlint”, “ansible_lint”, “yamllint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “actionlint”, “ansible_lint”, “yamllint”, “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.zsh.formatter

formatter tools for zsh

Type: value “beautysh” (singular enum) or raw lua code or list of (value “beautysh” (singular enum) or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.setup.zsh.linter

linter tools for zsh

Type: one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code or list of (one of “alex”, “codespell”, “cspell”, “languagetool”, “proselint”, “redpen”, “textlint”, “vale”, “write_good” or raw lua code)

Default: [ ]

Declared by:

plugins.efmls-configs.toolPackages.actionlint

Package for actionlint

Type: package

Default: <derivation actionlint-1.7.0>

Declared by:

plugins.efmls-configs.toolPackages.alejandra

Package for alejandra

Type: package

Default: <derivation alejandra-3.0.0>

Declared by:

plugins.efmls-configs.toolPackages.alex

Package for alex

Type: package

Default: <derivation alex-11.0.1>

Declared by:

plugins.efmls-configs.toolPackages.ameba

Package for ameba

Type: package

Default: <derivation ameba-1.6.1>

Declared by:

plugins.efmls-configs.toolPackages.ansible_lint

Package for ansible_lint

Type: package

Default: <derivation ansible-lint-24.2.2>

Declared by:

plugins.efmls-configs.toolPackages.astyle

Package for astyle

Type: package

Default: <derivation astyle-3.4.15>

Declared by:

plugins.efmls-configs.toolPackages.autopep8

Package for autopep8

Type: package

Default: <derivation python3.11-autopep8-2.0.4-unstable-2023-10-27>

Declared by:

plugins.efmls-configs.toolPackages.bashate

Package for bashate

Type: package

Default: <derivation bashate-2.1.1>

Declared by:

plugins.efmls-configs.toolPackages.beautysh

Package for beautysh

Type: package

Default: <derivation beautysh-6.2.1>

Declared by:

plugins.efmls-configs.toolPackages.biome

Package for biome

Type: package

Default: <derivation biome-1.7.3>

Declared by:

plugins.efmls-configs.toolPackages.black

Package for black

Type: package

Default: <derivation black-24.4.0>

Declared by:

plugins.efmls-configs.toolPackages.buf

Package for buf

Type: package

Default: <derivation buf-1.31.0>

Declared by:

plugins.efmls-configs.toolPackages.cbfmt

Package for cbfmt

Type: package

Default: <derivation cbfmt-0.2.0>

Declared by:

plugins.efmls-configs.toolPackages.checkmake

Package for checkmake

Type: package

Default: <derivation checkmake-0.2.2>

Declared by:

plugins.efmls-configs.toolPackages.chktex

Package for chktex

Type: package

Default: <derivation texlive-2023-env>

Declared by:

plugins.efmls-configs.toolPackages.clang_format

Package for clang_format

Type: package

Default: <derivation clang-tools-17.0.6>

Declared by:

plugins.efmls-configs.toolPackages.clang_tidy

Package for clang_tidy

Type: package

Default: <derivation clang-tools-17.0.6>

Declared by:

plugins.efmls-configs.toolPackages.clazy

Package for clazy

Type: package

Default: <derivation clazy-1.11>

Declared by:

plugins.efmls-configs.toolPackages.clj_kondo

Package for clj_kondo

Type: package

Default: <derivation clj-kondo-2024.03.13>

Declared by:

plugins.efmls-configs.toolPackages.cmake_lint

Package for cmake_lint

Type: package

Default: <derivation cmake-format-0.6.13>

Declared by:

plugins.efmls-configs.toolPackages.codespell

Package for codespell

Type: package

Default: <derivation codespell-2.2.6>

Declared by:

plugins.efmls-configs.toolPackages.cppcheck

Package for cppcheck

Type: package

Default: <derivation cppcheck-2.14.0>

Declared by:

plugins.efmls-configs.toolPackages.cpplint

Package for cpplint

Type: package

Default: <derivation cpplint-1.5.5>

Declared by:

plugins.efmls-configs.toolPackages.dartfmt

Package for dartfmt

Type: package

Default: <derivation dart-3.3.4>

Declared by:

plugins.efmls-configs.toolPackages.dfmt

Package for dfmt

Type: package

Default: <derivation dfmt-1.2.0>

Declared by:

plugins.efmls-configs.toolPackages.djlint

Package for djlint

Type: package

Default: <derivation djlint-1.34.1>

Declared by:

plugins.efmls-configs.toolPackages.dmd

Package for dmd

Type: package

Default: <derivation dmd-2.108.0>

Declared by:

plugins.efmls-configs.toolPackages.dotnet_format

Package for dotnet_format

Type: package

Default: <derivation dotnet-runtime-6.0.30>

Declared by:

plugins.efmls-configs.toolPackages.dprint

Package for dprint

Type: package

Default: <derivation dprint-0.45.1>

Declared by:

plugins.efmls-configs.toolPackages.eslint

Package for eslint

Type: package

Default: <derivation eslint-8.57.0>

Declared by:

plugins.efmls-configs.toolPackages.eslint_d

Package for eslint_d

Type: package

Default: <derivation eslint_d-13.1.2>

Declared by:

plugins.efmls-configs.toolPackages.fish

Package for fish

Type: package

Default: <derivation fish-3.7.1>

Declared by:

plugins.efmls-configs.toolPackages.fish_indent

Package for fish_indent

Type: package

Default: <derivation fish-3.7.1>

Declared by:

plugins.efmls-configs.toolPackages.flake8

Package for flake8

Type: package

Default: <derivation python3.11-flake8-7.0.0>

Declared by:

plugins.efmls-configs.toolPackages.flawfinder

Package for flawfinder

Type: package

Default: <derivation flawfinder-2.0.19>

Declared by:

plugins.efmls-configs.toolPackages.fnlfmt

Package for fnlfmt

Type: package

Default: <derivation fnlfmt-0.3.1>

Declared by:

plugins.efmls-configs.toolPackages.fourmolu

Package for fourmolu

Type: package

Default: <derivation fourmolu-0.14.0.0>

Declared by:

plugins.efmls-configs.toolPackages.gcc

Package for gcc

Type: package

Default: <derivation gcc-wrapper-13.2.0>

Declared by:

plugins.efmls-configs.toolPackages.gitlint

Package for gitlint

Type: package

Default: <derivation gitlint-0.19.1>

Declared by:

plugins.efmls-configs.toolPackages.go_revive

Package for go_revive

Type: package

Default: <derivation revive-1.3.7>

Declared by:

plugins.efmls-configs.toolPackages.gofmt

Package for gofmt

Type: package

Default: <derivation go-1.22.4>

Declared by:

plugins.efmls-configs.toolPackages.gofumpt

Package for gofumpt

Type: package

Default: <derivation gofumpt-0.6.0>

Declared by:

plugins.efmls-configs.toolPackages.goimports

Package for goimports

Type: package

Default: <derivation go-tools-2023.1.7>

Declared by:

plugins.efmls-configs.toolPackages.golangci_lint

Package for golangci_lint

Type: package

Default: <derivation golangci-lint-1.58.2>

Declared by:

plugins.efmls-configs.toolPackages.golines

Package for golines

Type: package

Default: <derivation golines-0.12.2>

Declared by:

plugins.efmls-configs.toolPackages.golint

Package for golint

Type: package

Default: <derivation golint-unstable-2020-12-08>

Declared by:

plugins.efmls-configs.toolPackages.google_java_format

Package for google_java_format

Type: package

Default: <derivation google-java-format-1.22.0>

Declared by:

plugins.efmls-configs.toolPackages.hadolint

Package for hadolint

Type: package

Default: <derivation hadolint-2.12.0>

Declared by:

plugins.efmls-configs.toolPackages.isort

Package for isort

Type: package

Default: <derivation isort-5.13.2>

Declared by:

plugins.efmls-configs.toolPackages.joker

Package for joker

Type: package

Default: <derivation joker-1.3.5>

Declared by:

plugins.efmls-configs.toolPackages.jq

Package for jq

Type: package

Default: <derivation jq-1.7.1>

Declared by:

plugins.efmls-configs.toolPackages.languagetool

Package for languagetool

Type: package

Default: <derivation LanguageTool-6.4>

Declared by:

plugins.efmls-configs.toolPackages.latexindent

Package for latexindent

Type: package

Default: <derivation texlive-2023-env>

Declared by:

plugins.efmls-configs.toolPackages.lua_format

Package for lua_format

Type: package

Default: <derivation luaformatter-1.3.6>

Declared by:

plugins.efmls-configs.toolPackages.luacheck

Package for luacheck

Type: package

Default: <derivation lua5.2-luacheck-1.1.2-1>

Declared by:

plugins.efmls-configs.toolPackages.markdownlint

Package for markdownlint

Type: package

Default: <derivation markdownlint-cli-0.40.0>

Declared by:

plugins.efmls-configs.toolPackages.mcs

Package for mcs

Type: package

Default: <derivation mono-6.12.0.182>

Declared by:

plugins.efmls-configs.toolPackages.mdformat

Package for mdformat

Type: package

Default: <derivation python3.11-mdformat-0.7.17>

Declared by:

plugins.efmls-configs.toolPackages.mypy

Package for mypy

Type: package

Default: <derivation mypy-1.9.0>

Declared by:

plugins.efmls-configs.toolPackages.nixfmt

Package for nixfmt

Type: package

Default: <derivation nixfmt-0.6.0>

Declared by:

plugins.efmls-configs.toolPackages.phan

Package for phan

Type: package

Default: <derivation phan-5.4.3>

Declared by:

plugins.efmls-configs.toolPackages.php

Package for php

Type: package

Default: <derivation php-with-extensions-8.2.20>

Declared by:

plugins.efmls-configs.toolPackages.php_cs_fixer

Package for php_cs_fixer

Type: package

Default: <derivation php-cs-fixer-3.51.0>

Declared by:

plugins.efmls-configs.toolPackages.phpcbf

Package for phpcbf

Type: package

Default: <derivation php-codesniffer-3.9.0>

Declared by:

plugins.efmls-configs.toolPackages.phpcs

Package for phpcs

Type: package

Default: <derivation php-codesniffer-3.9.0>

Declared by:

plugins.efmls-configs.toolPackages.phpstan

Package for phpstan

Type: package

Default: <derivation phpstan-1.11.1>

Declared by:

plugins.efmls-configs.toolPackages.prettier

Package for prettier

Type: package

Default: <derivation prettier-3.2.5>

Declared by:

plugins.efmls-configs.toolPackages.prettier_d

Package for prettier_d

Type: package

Default: <derivation fsouza-prettierd-0.25.3>

Declared by:

plugins.efmls-configs.toolPackages.prettierd

Package for prettierd

Type: package

Default: <derivation fsouza-prettierd-0.25.3>

Declared by:

plugins.efmls-configs.toolPackages.prettypst

Package for prettypst

Type: package

Default: <derivation prettypst-unstable-2023-12-06>

Declared by:

plugins.efmls-configs.toolPackages.proselint

Package for proselint

Type: package

Default: <derivation proselint-0.13.0>

Declared by:

plugins.efmls-configs.toolPackages.protolint

Package for protolint

Type: package

Default: <derivation protolint-0.49.7>

Declared by:

plugins.efmls-configs.toolPackages.psalm

Package for psalm

Type: package

Default: <derivation psalm-5.22.2>

Declared by:

plugins.efmls-configs.toolPackages.pylint

Package for pylint

Type: package

Default: <derivation pylint-3.1.1>

Declared by:

plugins.efmls-configs.toolPackages.rubocop

Package for rubocop

Type: package

Default: <derivation ruby3.1-rubocop-1.62.1>

Declared by:

plugins.efmls-configs.toolPackages.ruff

Package for ruff

Type: package

Default: <derivation ruff-0.4.4>

Declared by:

plugins.efmls-configs.toolPackages.rustfmt

Package for rustfmt

Type: package

Default: <derivation rustfmt-1.77.2>

Declared by:

plugins.efmls-configs.toolPackages.scalafmt

Package for scalafmt

Type: package

Default: <derivation scalafmt-3.7.9>

Declared by:

plugins.efmls-configs.toolPackages.selene

Package for selene

Type: package

Default: <derivation selene-0.27.1>

Declared by:

plugins.efmls-configs.toolPackages.shellcheck

Package for shellcheck

Type: package

Default: <derivation shellcheck-0.10.0>

Declared by:

plugins.efmls-configs.toolPackages.shellharden

Package for shellharden

Type: package

Default: <derivation shellharden-4.3.1>

Declared by:

plugins.efmls-configs.toolPackages.shfmt

Package for shfmt

Type: package

Default: <derivation shfmt-3.8.0>

Declared by:

plugins.efmls-configs.toolPackages.slither

Package for slither

Type: package

Default: <derivation slither-analyzer-0.10.2>

Declared by:

plugins.efmls-configs.toolPackages.smlfmt

Package for smlfmt

Type: package

Default: <derivation smlfmt-1.1.0>

Declared by:

plugins.efmls-configs.toolPackages.sql-formatter

Package for sql-formatter

Type: package

Default: <derivation sql-formatter-15.3.0>

Declared by:

plugins.efmls-configs.toolPackages.sqlfluff

Package for sqlfluff

Type: package

Default: <derivation sqlfluff-3.0.7>

Declared by:

plugins.efmls-configs.toolPackages.staticcheck

Package for staticcheck

Type: package

Default: <derivation go-tools-2023.1.7>

Declared by:

plugins.efmls-configs.toolPackages.statix

Package for statix

Type: package

Default: <derivation statix-0.5.8>

Declared by:

plugins.efmls-configs.toolPackages.stylelint

Package for stylelint

Type: package

Default: <derivation stylelint-16.5.0>

Declared by:

plugins.efmls-configs.toolPackages.stylua

Package for stylua

Type: package

Default: <derivation stylua-0.20.0>

Declared by:

plugins.efmls-configs.toolPackages.taplo

Package for taplo

Type: package

Default: <derivation taplo-0.9.0>

Declared by:

plugins.efmls-configs.toolPackages.terraform_fmt

Package for terraform_fmt

Type: package

Default: <derivation terraform-1.8.3>

Declared by:

plugins.efmls-configs.toolPackages.textlint

Package for textlint

Type: package

Default: <derivation textlint-14.0.4>

Declared by:

plugins.efmls-configs.toolPackages.typstfmt

Package for typstfmt

Type: package

Default: <derivation typstfmt-0.2.9>

Declared by:

plugins.efmls-configs.toolPackages.typstyle

Package for typstyle

Type: package

Default: <derivation typstyle-0.11.22>

Declared by:

plugins.efmls-configs.toolPackages.uncrustify

Package for uncrustify

Type: package

Default: <derivation uncrustify-0.79.0>

Declared by:

plugins.efmls-configs.toolPackages.vale

Package for vale

Type: package

Default: <derivation vale-3.4.2>

Declared by:

plugins.efmls-configs.toolPackages.vint

Package for vint

Type: package

Default: <derivation vim-vint-0.3.21>

Declared by:

plugins.efmls-configs.toolPackages.vulture

Package for vulture

Type: package

Default: <derivation python3.11-vulture-2.11>

Declared by:

plugins.efmls-configs.toolPackages.write-good

Package for write-good

Type: package

Default: <derivation write-good-1.0.8>

Declared by:

plugins.efmls-configs.toolPackages.write_good

Package for write_good

Type: package

Default: <derivation write-good-1.0.8>

Declared by:

plugins.efmls-configs.toolPackages.yamllint

Package for yamllint

Type: package

Default: <derivation yamllint-1.35.1>

Declared by:

plugins.efmls-configs.toolPackages.yapf

Package for yapf

Type: package

Default: <derivation yapf-0.40.2>

Declared by:

plugins.efmls-configs.toolPackages.yq

Package for yq

Type: package

Default: <derivation yq-go-4.44.1>

Declared by:

emmet

Url: https://github.com/mattn/emmet-vim/

Maintainers: Gaetan Lepage

plugins.emmet.enable

Whether to enable emmet-vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.emmet.package

Which package to use for the emmet plugin.

Type: package

Default: <derivation vimplugin-emmet-vim-2021-12-04>

Declared by:

plugins.emmet.settings

The configuration options for emmet without the user_emmet_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal user_emmet_foo_bar=1
  • hello = "world" -> :setglobal user_emmet_hello="world"
  • some_toggle = true -> :setglobal user_emmet_some_toggle
  • other_toggle = false -> :setglobal nouser_emmet_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  leader = "<C-Z>";
  mode = "inv";
  settings = {
    html = {
      default_attributes = {
        option = {
          value = null;
        };
        textarea = {
          cols = 10;
          id = null;
          name = null;
          rows = 10;
        };
      };
      snippets = {
        "html:5" = ''
          <!DOCTYPE html>
          <html lang=\"$\{lang}\">
          <head>
          \t<meta charset=\"$\{charset}\">
          \t<title></title>
          \t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">
          </head>
          <body>\n\t$\{child}|\n</body>
          </html>
        '';
      };
    };
    variables = {
      lang = "ja";
    };
  };
}

Declared by:

plugins.emmet.settings.leader_key

Leading keys to run Emmet functions.

Plugin default: "<C-y>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.emmet.settings.mode

Choose modes, in which Emmet mappings will be created. Default value: ‘a’ - all modes.

  • ‘n’ - normal mode.
  • ‘i’ - insert mode.
  • ‘v’ - visual mode.

Examples:

  • create Emmet mappings only for normal mode: n
  • create Emmet mappings for insert, normal and visual modes: inv
  • create Emmet mappings for all modes: a

Plugin default: "a"

Type: null or string or raw lua code

Default: null

Declared by:

endwise

Url: https://github.com/tpope/vim-endwise/

Maintainers: Gaetan Lepage

plugins.endwise.enable

Whether to enable vim-endwise.

Type: boolean

Default: false

Example: true

Declared by:

plugins.endwise.package

Which package to use for the endwise plugin.

Type: package

Default: <derivation vimplugin-vim-endwise-2024-01-16>

Declared by:

plugins.fidget.enable

Whether to enable fidget-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.fidget.package

Which package to use for the fidget-nvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-fidget.nvim-1.1.0-1-unstable-2024-04-04>

Declared by:

plugins.fidget.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.fidget.integration.nvim-tree.enable

Integrate with nvim-tree/nvim-tree.lua (if installed).

Dynamically offset Fidget’s notifications window when the nvim-tree window is open on the right side + the Fidget window is “editor”-relative.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.logger.floatPrecision

Limit the number of decimals displayed for floats.

Plugin default: 0.01

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.fidget.logger.level

Minimum logging level

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "warn"

Declared by:

plugins.fidget.logger.path

Where Fidget writes its logs to.

Using {__raw = "vim.fn.stdpath('cache')";}, the default path usually ends up at ~/.cache/nvim/fidget.nvim.log.

Plugin default: {__raw = "string.format('%s/fidget.nvim.log', vim.fn.stdpath('cache'))";}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.notification.configs

How to configure notification groups when instantiated.

A configuration with the key "default" should always be specified, and is used as the fallback for notifications lacking a group key.

To see the default config, run: :lua print(vim.inspect(require("fidget.notification").default_config))

Plugin default:

{
  default = "require('fidget.notification').default_config";
}

Type: null or (attribute set of ((submodule) or string))

Default: null

Declared by:

plugins.fidget.notification.filter

Minimum notifications level.

Note that this filter only applies to notifications with an explicit numeric level (i.e., vim.log.levels).

Set to "off" to filter out all notifications with an numeric level, or "trace" to turn off filtering.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

plugins.fidget.notification.historySize

Number of removed messages to retain in history.

Set to 0 to keep around history indefinitely (until cleared).

Plugin default: 128

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.overrideVimNotify

Automatically override vim.notify() with Fidget.

Equivalent to the following:

  fidget.setup({ --[[ options ]] })
  vim.notify = fidget.notify

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.notification.pollRate

How frequently to update and render notifications.

Measured in Hertz (frames per second).

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.redirect

Conditionally redirect notifications to another backend.

This option is useful for delegating notifications to another backend that supports features Fidget has not (yet) implemented.

For instance, Fidget uses a single, shared buffer and window for rendering all notifications, so it lacks a per-notification on_open callback that can be used to, e.g., set the |filetype| for a specific notification. For such notifications, Fidget’s default redirect delegates such notifications with an on_open callback to |nvim-notify| (if available).

Plugin default:

function(msg, level, opts)
  if opts and opts.on_open then
    return require("fidget.integration.nvim-notify").delegate(msg, level, opts)
  end
end

Type: null or lua function string or value false (singular enum)

Default: null

Declared by:

plugins.fidget.notification.view.groupSeparator

Separator between notification groups.

Must not contain any newlines. Set to false to omit separator entirely.

Plugin default: ---

Type: null or string or value false (singular enum)

Default: null

Declared by:

plugins.fidget.notification.view.groupSeparatorHl

Highlight group used for group separator.

Plugin default: Comment

Type: null or string or value false (singular enum)

Default: null

Declared by:

plugins.fidget.notification.view.iconSeparator

Separator between group name and icon.

Must not contain any newlines. Set to "" to remove the gap between names and icons in all notification groups.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.notification.view.stackUpwards

Display notification items from bottom to top.

Setting this to true tends to lead to more stable animations when the window is bottom-aligned.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.align

How to align the notification window.

Plugin default: "bottom"

Type: null or one of “top”, “bottom”, “avoid_cursor” or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.border

Defines the border to use for the notification window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: none

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.borderHl

Highlight group for notification window border.

Set to empty string to keep your theme’s default FloatBorder highlight.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.maxHeight

Maximum height of the notification window. 0 means no maximum height.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.maxWidth

Maximum width of the notification window. 0 means no maximum width.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.normalHl

Base highlight group in the notification window.

Used by any Fidget notification text that is not otherwise highlighted, i.e., message text.

Note that we use this blanket highlight for all messages to avoid adding separate highlights to each line (whose lengths may vary).

Set to empty string to keep your theme defaults.

With winblend set to anything less than 100, this will also affect the background color in the notification box area (see winblend docs).

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.relative

What the notification window position is relative to.

Plugin default: "editor"

Type: null or one of “editor”, “win” or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.winblend

Background color opacity in the notification window.

Note that the notification window is rectangular, so any cells covered by that rectangular area is affected by the background color of normal_hl. With winblend set to anything less than 100, the background of normal_hl will be blended with that of whatever is underneath, including, e.g., a shaded colorcolumn, which is usually not desirable.

However, if you would like to display the notification window as its own “boxed” area (especially if you are using a non-“none” border), you may consider setting winblend to something less than 100.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.xPadding

Padding from right edge of window boundary.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.yPadding

Padding from bottom edge of window boundary.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.notification.window.zindex

Stacking priority of the notification window.

Note that the default priority for Vim windows is 50.

Plugin default: 45

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.progress.clearOnDetach

Clear notification group when LSP server detaches

This option should be set to a function that, given a client ID number, returns the notification group to clear. No group will be cleared if the function returns nil.

The default setting looks up and returns the LSP client name, which is also used by notificationGroup.

Set this option to false to disable this feature entirely (no |LspDetach| callback will be installed).

Plugin default:

function(client_id)
  local client = vim.lsp.get_client_by_id(client_id)
  return client and client.name or nil
end

Type: null or lua function string or value false (singular enum)

Default: null

Declared by:

plugins.fidget.progress.ignore

List of LSP servers to ignore.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.fidget.progress.ignoreDoneAlready

Ignore new tasks that are already complete.

This is useful if you want to avoid excessively bouncy behavior, and only seeing notifications for long-running tasks. Works best when combined with a low pollRate.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.progress.ignoreEmptyMessage

Ignore new tasks that don’t contain a message.

Some servers may send empty messages for tasks that don’t actually exist. And if those tasks are never completed, they will become stale in Fidget. This option tells Fidget to ignore such messages unless the LSP server has anything meaningful to say.

Note that progress messages for new empty tasks will be dropped, but existing tasks will be processed to completion.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.progress.notificationGroup

How to get a progress message’s notification group key

Set this to return a constant to group all LSP progress messages together.

Example:

  notification_group = function(msg)
    -- N.B. you may also want to configure this group key ("lsp_progress")
    -- using progress.display.overrides or notification.configs
    return "lsp_progress"
  end

Plugin default: function(msg) return msg.lsp_name end

Type: null or lua function string

Default: null

Declared by:

plugins.fidget.progress.pollRate

How and when to poll for progress messages.

Set to 0 to immediately poll on each |LspProgress| event.

Set to a positive number to poll for progress messages at the specified frequency (Hz, i.e., polls per second). Combining a slow poll_rate (e.g., 0.5) with the ignoreDoneAlready setting can be used to filter out short-lived progress tasks, de-cluttering notifications.

Note that if too many LSP progress messages are sent between polls, Neovim’s progress ring buffer will overflow and messages will be overwritten (dropped), possibly causing stale progress notifications. Workarounds include using the |fidget.option.progress.lsp.progress_ringbuf_size| option, or manually calling |fidget.notification.reset|.

Set to false to disable polling altogether; you can still manually poll progress messages by calling |fidget.progress.poll|.

Plugin default: 0

Type: null or value false (singular enum) or signed integer or floating point number

Default: null

Declared by:

plugins.fidget.progress.suppressOnInsert

Suppress new messages while in insert mode.

Note that progress messages for new tasks will be dropped, but existing tasks will be processed to completion.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.doneIcon

Icon shown when all LSP progress tasks are complete.

  • When a string literal is given (e.g., "✔"), it is used as a static icon.
  • When a list or attrs (e.g., ["dots"] or {pattern = "clock"; period = 2;}) is given, it is used to generate an animation function.
  • When a function is specified (e.g., {__raw = "function(now) return now % 2 < 1 and '+' or '-' end";}), it is used as the animation function.

Plugin default: ✔

Type: null or string or raw lua code or list of string or attribute set of (string or (unsigned integer, meaning >=0))

Default: null

Declared by:

plugins.fidget.progress.display.doneStyle

Highlight group for completed LSP tasks.

Plugin default: "Constant"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.doneTtl

How long a message should persist after completion.

Set to 0 to use notification group config default, and math.huge to show notification indefinitely (until overwritten).

Measured in seconds.

Plugin default: 3

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.fidget.progress.display.formatAnnote

How to format a progress annotation.

Plugin default: function(msg) return msg.title end

Type: null or lua function string

Default: null

Declared by:

plugins.fidget.progress.display.formatGroupName

How to format a progress notification group’s name.

Plugin default: function(group) return tostring(group) end

Type: null or lua function string

Default: null

Declared by:

plugins.fidget.progress.display.formatMessage

How to format a progress message.

  format_message = function(msg)
    if string.find(msg.title, "Indexing") then
      return nil -- Ignore "Indexing..." progress messages
    end
    if msg.message then
      return msg.message
    else
      return msg.done and "Completed" or "In progress..."
    end
  end

Plugin default: require('fidget.progress.display').default_format_message

Type: null or lua code string

Default: null

Declared by:

plugins.fidget.progress.display.groupStyle

Highlight group for group name (LSP server name).

Plugin default: "Title"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.iconStyle

Highlight group for group icons.

Plugin default: "Question"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.priority

Ordering priority for LSP notification group.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.progressIcon

Icon shown when LSP progress tasks are in progress

  • When a string literal is given (e.g., "✔"), it is used as a static icon.
  • When a list or attrs (e.g., ["dots"] or {pattern = "clock"; period = 2;}) is given, it is used to generate an animation function.
  • When a function is specified (e.g., {__raw = "function(now) return now % 2 < 1 and '+' or '-' end";}), it is used as the animation function.

Plugin default:

{
  pattern = "dots";
}

Type: null or string or raw lua code or list of string or attribute set of (string or (unsigned integer, meaning >=0))

Default: null

Declared by:

plugins.fidget.progress.display.progressStyle

Highlight group for in-progress LSP tasks.

Plugin default: "WarningMsg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.progressTtl

How long a message should persist when in progress.

Plugin default: math.huge

Type: null or lua function string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.fidget.progress.display.renderLimit

How many LSP messages to show at once.

If false, no limit.

This is used to configure each LSP notification group, so by default, this is a per-server limit.

Plugin default: 16

Type: null or value false (singular enum) or signed integer or floating point number

Default: null

Declared by:

plugins.fidget.progress.display.skipHistory

Whether progress notifications should be omitted from history.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides

Override options from the default notification config. Keys of the table are each notification group’s key.

Plugin default:

{
  rust_analyzer = {
    name = "rust-analyzer";
  };
}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.annoteSeparator

Separator between message from annote.

Plugin default: "” ”"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.annoteStyle

Default style used to highlight item annotes.

Plugin default: "Question"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.debugAnnote

Default annotation for debug items.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.debugStyle

Style used to highlight debug item annotes.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.errorAnnote

Default annotation for error items.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.errorStyle

Style used to highlight error item annotes.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.groupStyle

Style used to highlight group name.

Plugin default: "Title"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.icon

Icon of the group; if null, no icon is used.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.iconOnLeft

If true, icon is rendered on the left instead of right.

Type: null or boolean

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.iconStyle

Style used to highlight icon; if null, use groupStyle.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.infoAnnote

Default annotation for info items.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.infoStyle

Style used to highlight info item annotes.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.name

Name of the group; if null, the key is used as name.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.priority

Order in which group should be displayed.

Plugin default: 50

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.renderLimit

How many notification items to show at once.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.skipHistory

Whether progress notifications should be omitted from history.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.ttl

How long a notification item should exist.

Plugin default: 3

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.warnAnnote

Default annotation for warn items.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.display.overrides.<name>.warnStyle

Style used to highlight warn item annotes.

Type: null or string

Default: null

Declared by:

plugins.fidget.progress.lsp.progressRingbufSize

Configure the nvim’s LSP progress ring buffer size.

Useful for avoiding progress message overflow when the LSP server blasts more messages than the ring buffer can handle.

Leaves the progress ringbuf size at its default if this setting is 0 or less. Doesn’t do anything for Neovim pre-v0.10.0.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.flash.enable

Whether to enable flash.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.flash.package

Which package to use for the flash.nvim plugin.

Type: package

Default: <derivation vimplugin-flash.nvim-2024-05-14>

Declared by:

plugins.flash.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.flash.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.char

options used when flash is activated through a regular search with / or ?

Plugin default:

{
  enabled = true;
  /* dynamic configuration for ftFT motions */
  config = ''
    function(opts)
      -- autohide flash when in operator-pending mode
      opts.autohide = vim.fn.mode(true):find("no") and vim.v.operator == "y"

      -- disable jump labels when not enabled, when using a count,
      -- or when recording/executing registers
      opts.jump_labels = opts.jump_labels
        and vim.v.count == 0
        and vim.fn.reg_executing() == ""
        and vim.fn.reg_recording() == ""

      -- Show jump labels only in operator-pending mode
      -- opts.jump_labels = vim.v.count == 0 and vim.fn.mode(true):find("o")
    end
  '';
  autohide = false;
  jumpLabels = false;
  multiLine = false;
  label = { exclude = "hjkliardc"; };
  keys = helpers.listToUnkeyedAttrs [ "f" "F" "t" "T" ";" "," ];
  charActions = ''
    function(motion)
      return {
        [";"] = "next", -- set to right to always go right
        [","] = "prev", -- set to left to always go left
        -- clever-f style
        [motion:lower()] = "next",
        [motion:upper()] = "prev",
        -- jump2d style: same case goes next, opposite case goes prev
        -- [motion] = "next",
        -- [motion:match("%l") and motion:upper() or motion:lower()] = "prev",
      }
    end
  '';
  search = { wrap = false; };
  highlight = { backdrop = true; };
  jump = { register = false; };
}

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.char.enabled

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.char.autohide

hide after jump when not using jump labels

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.charActions

The direction for prev and next is determined by the motion. left and right are always left and right.

Plugin default:

function(motion)
  return {
    [";"] = "next", -- set to right to always go right
    [","] = "prev", -- set to left to always go left
    -- clever-f style
    [motion:lower()] = "next",
    [motion:upper()] = "prev",
    -- jump2d style: same case goes next, opposite case goes prev
    -- [motion] = "next",
    -- [motion:match("%l") and motion:upper() or motion:lower()] = "prev",
  }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.char.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.char.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jumpLabels

show jump labels

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.keys

by default all keymaps are enabled, but you can disable some of them, by removing them from the list. If you rather use another key, you can map them to something else, e.g., { ";" = "L"; "," = "H"; }

Plugin default:

helpers.listToUnkeyedAttrs [ "f" "F" "t" "T" ";" "," ]

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.flash.modes.char.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.multiLine

set to false to use the current line only

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.modes.char.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.modes.char.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.char.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.char.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.char.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.char.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.modes.char.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.modes.char.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.automatic

Automatically set the values according to context. Same as passing search = {} in lua

Type: boolean

Default: false

Declared by:

plugins.flash.modes.char.search.exclude

Excluded filetypes and custom window filters

Plugin default:

[
  "notify"
  "cmp_menu"
  "noice"
  "flash_prompt"
  (
    helpers.mkRaw
    ''
      function(win)
        return not vim.api.nvim_win_get_config(win).focusable
      end
    ''
  )
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.flash.modes.char.search.forward

search direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.incremental

behave like incsearch

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.maxLength

max pattern length. If the pattern length is equal to this labels will no longer be skipped. When it exceeds this length it will either end in a jump or terminate the search

Plugin default: false

Type: null or value false (singular enum) or signed integer

Default: null

Declared by:

plugins.flash.modes.char.search.mode

  • exact: exact match
  • search: regular search
  • fuzzy: fuzzy search
  • fun(str): custom search function that returns a pattern For example, to only match at the beginning of a word: function(str) return “\<” … str end

Plugin default: "exact"

Type: null or one of “exact”, “search”, “fuzzy” or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.multiWindow

search/jump in all windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.trigger

Optional trigger character that needs to be typed before a jump label can be used. It’s NOT recommended to set this, unless you know what you’re doing

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.char.search.wrap

when false, find only matches in the given direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote

options used for remote flash

Plugin default:

{ remoteOp = { restore = true; motion = true; }; }

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.remote.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.remote.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.remote.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.modes.remote.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.modes.remote.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.remote.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.remote.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.remote.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.remote.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.modes.remote.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.modes.remote.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.automatic

Automatically set the values according to context. Same as passing search = {} in lua

Type: boolean

Default: false

Declared by:

plugins.flash.modes.remote.search.exclude

Excluded filetypes and custom window filters

Plugin default:

[
  "notify"
  "cmp_menu"
  "noice"
  "flash_prompt"
  (
    helpers.mkRaw
    ''
      function(win)
        return not vim.api.nvim_win_get_config(win).focusable
      end
    ''
  )
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.flash.modes.remote.search.forward

search direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.incremental

behave like incsearch

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.maxLength

max pattern length. If the pattern length is equal to this labels will no longer be skipped. When it exceeds this length it will either end in a jump or terminate the search

Plugin default: false

Type: null or value false (singular enum) or signed integer

Default: null

Declared by:

plugins.flash.modes.remote.search.mode

  • exact: exact match
  • search: regular search
  • fuzzy: fuzzy search
  • fun(str): custom search function that returns a pattern For example, to only match at the beginning of a word: function(str) return “\<” … str end

Plugin default: "exact"

Type: null or one of “exact”, “search”, “fuzzy” or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.multiWindow

search/jump in all windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.trigger

Optional trigger character that needs to be typed before a jump label can be used. It’s NOT recommended to set this, unless you know what you’re doing

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.remote.search.wrap

when false, find only matches in the given direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search

options used when flash is activated through a regular search with / or ?

Plugin default:

{
  enabled = true;
  highlight = { backdrop = false; };
  jump = { history = true; register = true; nohlsearch = true; };
  /*
    forward will be automatically set to the search direction
    mode is always set to 'search'
    incremental is set to 'true' when 'incsearch' is enabled
  */
  search.automatic = true;
}

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.search.enabled

when true, flash will be activated during regular search by default. You can always toggle when searching with require("flash").toggle()

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.search.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.search.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.modes.search.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.modes.search.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.search.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.search.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.search.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.search.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.modes.search.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.modes.search.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter

options used for treesitter selections require("flash").treesitter()

Plugin default:

{
  labels = "abcdefghijklmnopqrstuvwxyz";
  jump = { pos = "range"; };
  search = { incremental = false; };
  label = { before = true; after = true; style = "inline"; };
  highlight = { backdrop = false; matches = false; };
}helpers.ifNonNull'

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.treesitter.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitter.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitter.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.treesitter.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.treesitter.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitter.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.treesitter.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.modes.treesitter.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.modes.treesitter.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.automatic

Automatically set the values according to context. Same as passing search = {} in lua

Type: boolean

Default: false

Declared by:

plugins.flash.modes.treesitter.search.exclude

Excluded filetypes and custom window filters

Plugin default:

[
  "notify"
  "cmp_menu"
  "noice"
  "flash_prompt"
  (
    helpers.mkRaw
    ''
      function(win)
        return not vim.api.nvim_win_get_config(win).focusable
      end
    ''
  )
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.flash.modes.treesitter.search.forward

search direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.incremental

behave like incsearch

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.maxLength

max pattern length. If the pattern length is equal to this labels will no longer be skipped. When it exceeds this length it will either end in a jump or terminate the search

Plugin default: false

Type: null or value false (singular enum) or signed integer

Default: null

Declared by:

plugins.flash.modes.treesitter.search.mode

  • exact: exact match
  • search: regular search
  • fuzzy: fuzzy search
  • fun(str): custom search function that returns a pattern For example, to only match at the beginning of a word: function(str) return “\<” … str end

Plugin default: "exact"

Type: null or one of “exact”, “search”, “fuzzy” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.multiWindow

search/jump in all windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.trigger

Optional trigger character that needs to be typed before a jump label can be used. It’s NOT recommended to set this, unless you know what you’re doing

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitter.search.wrap

when false, find only matches in the given direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch

Plugin default:

{
  jump = { pos = "range"; };
  search = { multiWindow = true; wrap = true; incremental = false; };
  remoteOp = { restore = true };
  label = { before = true; after = true; style = "inline"; };
}

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.backdrop

show a backdrop with hl FlashBackdrop

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.matches

Highlight the search matches

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.priority

extmark priority

Plugin default: 5000

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.groups.backdrop

Plugin default: "FlashBackdrop"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.groups.current

Plugin default: "FlashCurrent"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.groups.label

Plugin default: "FlashLabel"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.highlight.groups.match

Plugin default: "FlashMatch"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.autojump

automatically jump when there is only one match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.history

add pattern to search history

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.inclusive

You can force inclusive/exclusive jumps by setting the inclusive option. By default it will be automatically set based on the mode.

Type: null or boolean

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.jumplist

save location in the jumplist

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.nohlsearch

clear highlight after jump

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.offset

jump position offset. Not used for range jumps. 0: default 1: when pos == “end” and pos < current position

Type: null or signed integer

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.pos

jump position

Plugin default: "start"

Type: null or one of “start”, “end”, “range” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.jump.register

add pattern to search register

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.after

show the label after the match

Plugin default: true

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.before

show the label before the match

Plugin default: false

Type: null or boolean or list of signed integer

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.current

add a label for the first match in the current window. you can always jump to the first match with <CR>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.distance

for the current window, label targets closer to the cursor first

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.exclude

add any labels with the correct case here, that you want to exclude

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.format

With format, you can change how the label is rendered. Should return a list of [text, highlight] tuples. @class Flash.Format @field state Flash.State @field match Flash.Match @field hl_group string @field after boolean @type fun(opts:Flash.Format): string[][]

Plugin default:

format = function(opts)
  return { { opts.match.label, opts.hl_group } }
end

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.minPatternLength

minimum pattern length to show labels Ignored for custom labelers.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.reuse

flash tries to re-use labels that were already assigned to a position, when typing more characters. By default only lower-case labels are re-used.

Plugin default: "lowercase"

Type: null or one of “lowercase”, “all”, “none” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.style

position of the label extmark

Plugin default: "overlay"

Type: null or one of “eol”, “overlay”, “right_align”, “inline” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.uppercase

allow uppercase labels

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.rainbow.enabled

Enable this to use rainbow colors to highlight labels Can be useful for visualizing Treesitter ranges.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.label.rainbow.shade

Plugin default: 5

Type: null or integer between 1 and 9 (both inclusive)

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.automatic

Automatically set the values according to context. Same as passing search = {} in lua

Type: boolean

Default: false

Declared by:

plugins.flash.modes.treesitterSearch.search.exclude

Excluded filetypes and custom window filters

Plugin default:

[
  "notify"
  "cmp_menu"
  "noice"
  "flash_prompt"
  (
    helpers.mkRaw
    ''
      function(win)
        return not vim.api.nvim_win_get_config(win).focusable
      end
    ''
  )
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.forward

search direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.incremental

behave like incsearch

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.maxLength

max pattern length. If the pattern length is equal to this labels will no longer be skipped. When it exceeds this length it will either end in a jump or terminate the search

Plugin default: false

Type: null or value false (singular enum) or signed integer

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.mode

  • exact: exact match
  • search: regular search
  • fuzzy: fuzzy search
  • fun(str): custom search function that returns a pattern For example, to only match at the beginning of a word: function(str) return “\<” … str end

Plugin default: "exact"

Type: null or one of “exact”, “search”, “fuzzy” or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.multiWindow

search/jump in all windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.trigger

Optional trigger character that needs to be typed before a jump label can be used. It’s NOT recommended to set this, unless you know what you’re doing

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.treesitterSearch.search.wrap

when false, find only matches in the given direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.prompt.enabled

options for the floating window that shows the prompt, for regular jumps

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.prompt.prefix

Plugin default:

[ ["⚡" "FlashPromptIcon"] ]

Type: null or (list of anything)

Default: null

Declared by:

plugins.flash.prompt.winConfig

See nvim_open_win for more details

Plugin default:

{
  relative = "editor";
  width = 1;
  height = 1;
  row = -1;
  col = 0;
  zindex = 1000;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.flash.remoteOp.motion

For jump.pos = "range", this setting is ignored.

  • true: always enter a new motion when doing a remote operation
  • false: use the window’s cursor position and jump target
  • nil: act as true for remote windows, false for the current window

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.remoteOp.restore

restore window views and cursor position after doing a remote operation

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.search.automatic

Automatically set the values according to context. Same as passing search = {} in lua

Type: boolean

Default: false

Declared by:

plugins.flash.search.exclude

Excluded filetypes and custom window filters

Plugin default:

[
  "notify"
  "cmp_menu"
  "noice"
  "flash_prompt"
  (
    helpers.mkRaw
    ''
      function(win)
        return not vim.api.nvim_win_get_config(win).focusable
      end
    ''
  )
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.flash.search.forward

search direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.search.incremental

behave like incsearch

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.search.maxLength

max pattern length. If the pattern length is equal to this labels will no longer be skipped. When it exceeds this length it will either end in a jump or terminate the search

Plugin default: false

Type: null or value false (singular enum) or signed integer

Default: null

Declared by:

plugins.flash.search.mode

  • exact: exact match
  • search: regular search
  • fuzzy: fuzzy search
  • fun(str): custom search function that returns a pattern For example, to only match at the beginning of a word: function(str) return “\<” … str end

Plugin default: "exact"

Type: null or one of “exact”, “search”, “fuzzy” or raw lua code

Default: null

Declared by:

plugins.flash.search.multiWindow

search/jump in all windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.search.trigger

Optional trigger character that needs to be typed before a jump label can be used. It’s NOT recommended to set this, unless you know what you’re doing

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.search.wrap

when false, find only matches in the given direction

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.floaterm.enable

Whether to enable floaterm.

Type: boolean

Default: false

Example: true

Declared by:

plugins.floaterm.package

Which package to use for the floaterm plugin.

Type: package

Default: <derivation vimplugin-vim-floaterm-2024-04-08>

Declared by:

plugins.floaterm.autoclose

Whether to close floaterm window once the job gets finished.

  • 0: Always do NOT close floaterm window
  • 1: Close window if the job exits normally, otherwise stay it with messages like [Process exited 101]
  • 2: Always close floaterm window

Default: 1

Type: null or one of 0, 1, 2

Default: null

Declared by:

plugins.floaterm.autohide

Whether to hide previous floaterms before switching to or opening a another one.

  • 0: Always do NOT hide previous floaterm windows
  • 1: Only hide those whose position (b:floaterm_position) is identical to that of the floaterm which will be opened
  • 2: Always hide them

Default: 1

Type: null or one of 0, 1, 2

Default: null

Declared by:

plugins.floaterm.autoinsert

Whether to enter Terminal-mode after opening a floaterm.

Default: true

Type: null or boolean

Default: null

Declared by:

plugins.floaterm.borderchars

The position of the floating window.

8 characters of the floating window border (top, right, bottom, left, topleft, topright, botright, botleft).

Default: “─│─│┌┐┘└”

Type: null or string

Default: null

Declared by:

plugins.floaterm.giteditor

Whether to override $GIT_EDITOR in floaterm terminals so git commands can open open an editor in the same neovim instance.

Default: true

Type: null or boolean

Default: null

Declared by:

plugins.floaterm.height

Int (number of columns) or float (between 0 and 1). if float, the height is relative to &lines.

Default: 0.6

Type: null or signed integer or floating point number

Default: null

Declared by:

plugins.floaterm.opener

Command used for opening a file in the outside nvim from within :terminal.

Default: ‘split’

Type: null or one of “edit”, “split”, “vsplit”, “tabe”, “drop”

Default: null

Declared by:

plugins.floaterm.position

The position of the floating window.

Available values:

  • If wintype is split/vsplit: ‘leftabove’, ‘aboveleft’, ‘rightbelow’, ‘belowright’, ‘topleft’, ‘botright’. Default: ‘botright’.

  • If wintype is float: ‘top’, ‘bottom’, ‘left’, ‘right’, ‘topleft’, ‘topright’, ‘bottomleft’, ‘bottomright’, ‘center’, ‘auto’ (at the cursor place). Default: ‘center’

In addition, there is another option ‘random’ which allows to pick a random position from above when (re)opening a floaterm window.

Type: null or string

Default: null

Declared by:

plugins.floaterm.rootmarkers

Markers used to detect the project root directory for --cwd=<root>

Default: [“.project” “.git” “.hg” “.svn” “.root”]

Type: null or (list of string)

Default: null

Declared by:

plugins.floaterm.shell

Type: null or string

Default: null

Declared by:

plugins.floaterm.title

Show floaterm info (e.g., ‘floaterm: 1/3’ implies there are 3 floaterms in total and the current is the first one) at the top left corner of floaterm window.

Default: ‘floaterm: $1/$2’($1 and $2 will be substituted by ‘the index of the current floaterm’ and ‘the count of all floaterms’ respectively)

Example: ‘floaterm($1|$2)’

Type: null or string

Default: null

Declared by:

plugins.floaterm.width

Int (number of columns) or float (between 0 and 1). if float, the width is relative to &columns.

Default: 0.6

Type: null or signed integer or floating point number

Default: null

Declared by:

plugins.floaterm.wintype

‘float’(nvim’s floating or vim’s popup) by default. Set it to ‘split’ or ‘vsplit’ if you don’t want to use floating or popup window.

Type: null or one of “float”, “split”, “vsplit”

Default: null

Declared by:

plugins.floaterm.keymaps.first

Key to map to first

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.hide

Key to map to hide

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.kill

Key to map to kill

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.last

Key to map to last

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.new

Key to map to new

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.next

Key to map to next

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.prev

Key to map to prev

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.show

Key to map to show

Type: null or string

Default: null

Declared by:

plugins.floaterm.keymaps.toggle

Key to map to toggle

Type: null or string

Default: null

Declared by:

plugins.friendly-snippets.enable

Whether to enable friendly-snippets.

Type: boolean

Default: false

Example: true

Declared by:

plugins.friendly-snippets.package

Which package to use for the friendly-snippets plugin.

Type: package

Default: <derivation vimplugin-friendly-snippets-2024-05-16>

Declared by:

fugitive

Url: https://github.com/tpope/vim-fugitive/

Maintainers: Gaetan Lepage

plugins.fugitive.enable

Whether to enable vim-fugitive.

Type: boolean

Default: false

Example: true

Declared by:

plugins.fugitive.package

Which package to use for the fugitive plugin.

Type: package

Default: <derivation vimplugin-vim-fugitive-2024-05-15>

Declared by:

fzf-lua

Url: https://github.com/ibhagwan/fzf-lua/

Maintainers: Gaetan Lepage

plugins.fzf-lua.enable

Whether to enable fzf-lua.

Type: boolean

Default: false

Example: true

Declared by:

plugins.fzf-lua.package

Which package to use for the fzf-lua plugin.

Type: package

Default: <derivation vimplugin-lua5.1-fzf-lua-0.0.1243-1-unstable-2024-05-14>

Declared by:

plugins.fzf-lua.fzfPackage

Which package to use for fzf. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation fzf-0.52.1>

Example: <derivation skim-0.10.4>

Declared by:

plugins.fzf-lua.iconsEnabled

Toggle icon support. Installs nvim-web-devicons.

Type: boolean

Default: true

Declared by:

plugins.fzf-lua.keymaps

Keymaps for Fzf-Lua.

Type: attribute set of (string or (submodule))

Default: { }

Example:

{
  "<C-p>" = {
    action = "git_files";
    options = {
      desc = "Fzf-Lua Git Files";
      silent = true;
    };
    settings = {
      previewers = {
        cat = {
          cmd = "/nix/store/ysqx2xfzygv2rxl7nxnw48276z5ckppn-coreutils-9.5/bin/cat";
        };
      };
      winopts = {
        height = 0.5;
      };
    };
  };
  "<leader>fg" = "live_grep";
}

Declared by:

plugins.fzf-lua.profile

Preconfigured profile to use

Plugin default: "default"

Type: null or one of “default”, “fzf-native”, “fzf-tmux”, “fzf-vim”, “max-perf”, “telescope”, “skim” or raw lua code

Default: null

Declared by:

plugins.fzf-lua.settings

Options provided to the require('fzf-lua').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  files = {
    color_icons = true;
    file_icons = true;
    find_opts = {
      __raw = "[[-type f -not -path '*.git/objects*' -not -path '*.env*']]";
    };
    multiprocess = true;
    prompt = "Files❯ ";
  };
  winopts = {
    col = 0.3;
    height = 0.4;
    row = 0.99;
    width = 0.93;
  };
}

Declared by:

plugins.fzf-lua.settings.fzf_bin

The path to the fzf binary to use.

Example: "skim"

Type: null or string or raw lua code

Default: null

Declared by:

git-conflict

Url: https://github.com/akinsho/git-conflict.nvim/

Maintainers: Gaetan Lepage

plugins.git-conflict.enable

Whether to enable git-conflict.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.git-conflict.package

Which package to use for the git-conflict.nvim plugin.

Type: package

Default: <derivation vimplugin-git-conflict.nvim-2024-01-22>

Declared by:

plugins.git-conflict.gitPackage

Which package to use for git. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation git-2.44.1>

Declared by:

plugins.git-conflict.settings

Options provided to the require('git-conflict').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  default_commands = true;
  default_mappings = {
    both = "b";
    next = "n";
    none = "0";
    ours = "o";
    prev = "p";
    theirs = "t";
  };
  disable_diagnostics = false;
  highlights = {
    current = "DiffText";
    incoming = "DiffAdd";
  };
  list_opener = "copen";
}

Declared by:

plugins.git-conflict.settings.default_commands

Set to false to disable commands created by this plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.git-conflict.settings.default_mappings

This plugin offers default buffer local mappings inside conflicted files. This is primarily because applying these mappings only to relevant buffers is impossible through global mappings.

Set to false to disable mappings entirely.

Defaults (if left true):

  {
    ours = "co";
    theirs = "ct";
    none = "c0";
    both = "cb";
    next = "[x";
    prev = "]x";
  }

Plugin default: true

Type: null or boolean or attribute set of string

Default: null

Declared by:

plugins.git-conflict.settings.disable_diagnostics

This will disable the diagnostics in a buffer whilst it is conflicted.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.git-conflict.settings.list_opener

Command or function to open the conflicts list.

Plugin default: "copen"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.git-conflict.settings.highlights.ancestor

Which highlight group to use for ancestor.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.git-conflict.settings.highlights.current

Which highlight group to use for current changes.

Plugin default: "DiffText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.git-conflict.settings.highlights.incoming

Which highlight group to use for incoming changes.

Plugin default: "DiffAdd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.git-worktree.enable

Whether to enable git-worktree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.git-worktree.enableTelescope

Whether to enable telescope integration.

Type: boolean

Default: false

Example: true

Declared by:

plugins.git-worktree.package

Which package to use for the git-worktree plugin.

Type: package

Default: <derivation vimplugin-git-worktree.nvim-2023-11-07>

Declared by:

plugins.git-worktree.autopush

When creating a new worktree, it will push the branch to the upstream then perform a git rebase.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.git-worktree.changeDirectoryCommand

The vim command used to change to the new worktree directory. Set this to tcd if you want to only change the pwd for the current vim Tab.

Plugin default: "cd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.git-worktree.clearJumpsOnChange

If set to true every time you switch branches, your jumplist will be cleared so that you don’t accidentally go backward to a different branch and edit the wrong files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.git-worktree.updateOnChange

If set to true updates the current buffer to point to the new work tree if the file is found in the new project. Otherwise, the following command will be run.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.git-worktree.updateOnChangeCommand

The vim command to run during the update_on_change event. Note, that this command will only be run when the current file is not found in the new worktree. This option defaults to e . which opens the root directory of the new worktree.

Plugin default: "e ."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitblame.enable

Whether to enable gitblame.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitblame.package

Which package to use for the gitblame plugin.

Type: package

Default: <derivation vimplugin-git-blame.nvim-2024-05-10>

Declared by:

plugins.gitblame.dateFormat

The format of the date fields in messageTemplate.

Plugin default: "%c"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitblame.delay

The delay in milliseconds after which the blame info will be displayed.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitblame.displayVirtualText

If the blame message should be displayed as virtual text. You may want to disable this if you display the blame message in statusline.

Plugin default: 1

Type: null or null or boolean

Default: null

Declared by:

plugins.gitblame.extmarkOptions

nvim_buf_set_extmark optional parameters. (Warning: overwriting id and virt_text will break the plugin behavior)

Plugin default: ``

Type: null or (attribute set)

Default: null

Declared by:

plugins.gitblame.highlightGroup

The highlight group for virtual text.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitblame.ignoredFiletypes

A list of filetypes for which gitblame information will not be displayed.

Plugin default: ``

Type: null or (list of string)

Default: null

Declared by:

plugins.gitblame.messageTemplate

The template for the blame message that will be shown.

Plugin default: " <author> • <date> • <summary>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitblame.messageWhenNotCommitted

The blame message that will be shown when the current modification hasn’t been committed yet.

Plugin default: " Not Committed Yet"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitblame.virtualTextColumn

Have the blame message start at a given column instead of EOL. If the current line is longer than the specified column value the blame message will default to being displayed at EOL.

Plugin default: ``

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.gitgutter.enable

Whether to enable gitgutter.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitgutter.enableByDefault

Enable gitgutter by default

Type: boolean

Default: true

Declared by:

plugins.gitgutter.package

Which package to use for the gitgutter plugin.

Type: package

Default: <derivation vimplugin-vim-gitgutter-2024-04-29>

Declared by:

plugins.gitgutter.allowClobberSigns

Don’t preserve other signs on the sign column

Type: boolean

Default: false

Declared by:

plugins.gitgutter.defaultMaps

Let gitgutter set default mappings

Type: boolean

Default: true

Declared by:

plugins.gitgutter.diffRelativeToWorkingTree

Make diffs relative to the working tree instead of the index

Type: boolean

Default: false

Declared by:

plugins.gitgutter.extraDiffArgs

Extra arguments to pass to git diff

Type: string

Default: ""

Declared by:

plugins.gitgutter.extraGitArgs

Extra arguments to pass to git

Type: string

Default: ""

Declared by:

plugins.gitgutter.grep

A non-standard grep to use instead of the default

Type: null or (submodule) or string

Default: null

Declared by:

plugins.gitgutter.highlightLineNumbers

Highlight line numbers by default

Type: boolean

Default: true

Declared by:

plugins.gitgutter.highlightLines

Highlight lines by default

Type: boolean

Default: true

Declared by:

plugins.gitgutter.matchBackgrounds

Make the background colors match the sign column

Type: boolean

Default: false

Declared by:

plugins.gitgutter.maxSigns

Maximum number of signs to show on the screen. Unlimited by default.

Type: null or signed integer

Default: null

Declared by:

plugins.gitgutter.previewWinFloating

Preview hunks on floating windows

Type: boolean

Default: false

Declared by:

plugins.gitgutter.recommendedSettings

Use recommended settings

Type: boolean

Default: true

Declared by:

plugins.gitgutter.runAsync

Disable this to run git diff syncrhonously instead of asynchronously

Type: boolean

Default: true

Declared by:

plugins.gitgutter.showMessageOnHunkJumping

Show a message when jumping between hunks

Type: boolean

Default: true

Declared by:

plugins.gitgutter.signPriority

GitGutter’s sign priority on the sign column

Type: null or signed integer

Default: null

Declared by:

plugins.gitgutter.signsByDefault

Show signs by default

Type: boolean

Default: true

Declared by:

plugins.gitgutter.terminalReportFocus

Let the terminal report its focus status

Type: boolean

Default: true

Declared by:

plugins.gitgutter.useLocationList

Load chunks into windows’s location list instead of the quickfix list

Type: boolean

Default: false

Declared by:

plugins.gitgutter.signs

Custom signs for the sign column

Type: submodule

Default: { }

Declared by:

plugins.gitgutter.signs.added

Sign for added lines

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.modified

Sign for modified lines

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.modifiedAbove

Sign for modified line above

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.modifiedRemoved

Sign for modified and removed lines

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.removed

Sign for removed lines

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.removedAboveAndBelow

Sign for lines removed above and below

Type: null or string

Default: null

Declared by:

plugins.gitgutter.signs.removedFirstLine

Sign for a removed first line

Type: null or string

Default: null

Declared by:

gitignore

Url: https://github.com/wintermute-cell/gitignore.nvim/

Maintainers: Gaetan Lepage

plugins.gitignore.enable

Whether to enable gitignore.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitignore.package

Which package to use for the gitignore plugin.

Type: package

Default: <derivation vimplugin-gitignore.nvim-2024-03-25>

Declared by:

plugins.gitignore.keymap

Keyboard shortcut for the gitignore.generate command. Can be:

  • A string: which key to bind
  • An attrs: if you want to customize the mode and/or the options of the keymap (desc, silent, …)

Type: null or string or (submodule)

Default: null

Example: "<leader>gi"

Declared by:

plugins.gitlinker.enable

Whether to enable gitlinker.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitlinker.package

Which package to use for the gitlinker.nvim plugin.

Type: package

Default: <derivation vimplugin-gitlinker.nvim-2023-02-03>

Declared by:

plugins.gitlinker.actionCallback

Callback for what to do with the url.

Can be

  • the name of a built-in callback. Example: actionCallback = "copy_to_clipboard"; is setting
  require('gitlinker.actions').copy_to_clipboard

in lua.

  • Raw lua code actionCallback.__raw = "function() ... end";.

Plugin default: copy_to_clipboard

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitlinker.addCurrentLineOnNormalMode

Adds current line nr in the url for normal mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitlinker.callbacks

Each key can be

  • the name of a built-in callback. Example: "get_gitlab_type_url"; is setting
  require('gitlinker.hosts').get_gitlab_type_url

in lua.

  • Raw lua code "github.com".__raw = "function(url_data) ... end";.

Learn more by reading :h gitinker-callbacks.

Plugin default:

{
  "github.com" = "get_github_type_url";
  "gitlab.com" = "get_gitlab_type_url";
  "try.gitea.io" = "get_gitea_type_url";
  "codeberg.org" = "get_gitea_type_url";
  "bitbucket.org" = "get_bitbucket_type_url";
  "try.gogs.io" = "get_gogs_type_url";
  "git.sr.ht" = "get_srht_type_url";
  "git.launchpad.net" = "get_launchpad_type_url";
  "repo.or.cz" = "get_repoorcz_type_url";
  "git.kernel.org" = "get_cgit_type_url";
  "git.savannah.gnu.org" = "get_cgit_type_url";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.gitlinker.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.gitlinker.mappings

Mapping to call url generation.

Plugin default: "<leader>gy"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitlinker.printUrl

Print the url after performing the action.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitlinker.remote

Force the use of a specific remote.

Type: null or string

Default: null

Declared by:

plugins.gitmessenger.enable

Whether to enable gitmessenger.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitmessenger.package

Which package to use for the git-messenger plugin.

Type: package

Default: <derivation vimplugin-git-messenger.vim-2022-08-30>

Declared by:

plugins.gitmessenger.alwaysIntoPopup

When this value is set to v:true, the cursor goes into a popup window when running :GitMessenger or <Plug>(git-messenger).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.closeOnCursorMoved

A popup window is no longer closed automatically when moving a cursor after the window is shown up.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.concealWordDiffMarker

When this value is set to v:true, markers for word diffs like [-, -], {+, +} are concealed. Set false when you don’t want to hide them.

Note: Word diff is enabled by typing “r” in a popup window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.dateFormat

String value to format dates in popup window. Please see :help strftime() to know the details of the format.

Plugin default: "%c"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitmessenger.extraBlameArgs

When this variable is set the contents will be appended to the git blame command. Use it to add options (like -w).

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitmessenger.floatingWinOps

Options passed to nvim_open_win() on opening a popup window. This is useful when you want to override some window options.

Plugin default: {}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.gitmessenger.gitCommand

git command to retrieve commit messages.

Plugin default: "git"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitmessenger.includeDiff

When this value is not set to “none”, a popup window includes diff hunks of the commit at showing up. “current” includes diff hunks of only current file in the commit. “all” includes all diff hunks in the commit.

Please note that typing d/D or r/R in popup window toggle showing diff hunks even if this value is set to “none”.

Plugin default: "none"

Type: null or one of “none”, “current”, “all” or raw lua code

Default: null

Declared by:

plugins.gitmessenger.intoPopupAfterShow

When this value is set to v:false, running :GitMessenger or <plug>(git-messenger) again after showing a popup does not move the cursor in the window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.maxPopupHeight

Max lines of popup window in an integer value. Setting null means no limit.

Type: null or signed integer

Default: null

Declared by:

plugins.gitmessenger.maxPopupWidth

Max characters of popup window in an integer value. Setting null means no limit.

Type: null or signed integer

Default: null

Declared by:

plugins.gitmessenger.noDefaultMappings

When this value is set, it does not define any key mappings

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.popupContentMargins

Setting true means adding margins in popup window. Blank lines at the top and bottom of popup content are inserted. And every line is indented with one whitespace character. Setting false to this variable removes all the margins.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitmessenger.previewMods

This variable is effective only when opening preview window (on Neovim (0.3.0 or earlier) or Vim).

Command modifiers for opening preview window. The value will be passed as prefix of :pedit command. For example, setting “botright” to the variable opens a preview window at bottom of the current window. Please see :help <mods> for more details.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

gitsigns

Url: https://github.com/lewis6991/gitsigns.nvim/

Maintainers: Gaetan Lepage

plugins.gitsigns.enable

Whether to enable gitsigns.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.gitsigns.package

Which package to use for the gitsigns.nvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-gitsigns.nvim-scm-1-unstable-2024-05-06>

Declared by:

plugins.gitsigns.gitPackage

Which package to use for git. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation git-2.44.1>

Declared by:

plugins.gitsigns.settings

Options provided to the require('gitsigns').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  current_line_blame = false;
  current_line_blame_opts = {
    virt_text = true;
    virt_text_pos = "eol";
  };
  signcolumn = true;
  signs = {
    add = {
      text = "│";
    };
    change = {
      text = "│";
    };
    changedelete = {
      text = "~";
    };
    delete = {
      text = "_";
    };
    topdelete = {
      text = "‾";
    };
    untracked = {
      text = "┆";
    };
  };
  watch_gitdir = {
    follow_files = true;
  };
}

Declared by:

plugins.gitsigns.settings.attach_to_untracked

Attach to untracked files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.auto_attach

Automatically attach to files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.base

The object/revision to diff against. See |gitsigns-revision|.

Type: null or string

Default: null

Declared by:

plugins.gitsigns.settings.count_chars

The count characters used when signs.*.show_count is enabled. The + entry is used as a fallback. With the default, any count outside of 1-9 uses the > character in the sign.

Possible use cases for this field:

  • to specify unicode characters for the counts instead of 1-9.
  • to define characters to be used for counts greater than 9.

Plugin default:

{
  "__unkeyed_1" = "1";
  "__unkeyed_2" = "2";
  "__unkeyed_3" = "3";
  "__unkeyed_4" = "4";
  "__unkeyed_5" = "5";
  "__unkeyed_6" = "6";
  "__unkeyed_7" = "7";
  "__unkeyed_8" = "8";
  "__unkeyed_9" = "9";
  "+" = ">";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame

Adds an unobtrusive and customisable blame annotation at the end of the current line. The highlight group used for the text is GitSignsCurrentLineBlame.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_formatter

String or function used to format the virtual text of current_line_blame.

When a string, accepts the following format specifiers:

  • <abbrev_sha>
  • <orig_lnum>
  • <final_lnum>
  • <author>
  • <author_mail>
  • <author_time> or <author_time:FORMAT>
  • <author_tz>
  • <committer>
  • <committer_mail>
  • <committer_time> or <committer_time:FORMAT>
  • <committer_tz>
  • <summary>
  • <previous>
  • <filename>

For <author_time:FORMAT> and <committer_time:FORMAT>, FORMAT can be any valid date format that is accepted by os.date() with the addition of %R (defaults to %Y-%m-%d):

  • %a abbreviated weekday name (e.g., Wed)
  • %A full weekday name (e.g., Wednesday)
  • %b abbreviated month name (e.g., Sep)
  • %B full month name (e.g., September)
  • %c date and time (e.g., 09/16/98 23:48:10)
  • %d day of the month (16) [01-31]
  • %H hour, using a 24-hour clock (23) [00-23]
  • %I hour, using a 12-hour clock (11) [01-12]
  • %M minute (48) [00-59]
  • %m month (09) [01-12]
  • %p either “am” or “pm” (pm)
  • %S second (10) [00-61]
  • %w weekday (3) [0-6 = Sunday-Saturday]
  • %x date (e.g., 09/16/98)
  • %X time (e.g., 23:48:10)
  • %Y full year (1998)
  • %y two-digit year (98) [00-99]
  • %% the character `%´
  • %R relative (e.g., 4 months ago)

When a function:

Parameters:

  • {name} Git user name returned from git config user.name

  • {blame_info} Table with the following keys:

    • abbrev_sha: string
    • orig_lnum: integer
    • final_lnum: integer
    • author: string
    • author_mail: string
    • author_time: integer
    • author_tz: string
    • committer: string
    • committer_mail: string
    • committer_time: integer
    • committer_tz: string
    • summary: string
    • previous: string
    • filename: string
    • boundary: true?

Note that the keys map onto the output of: git blame --line-porcelain

  • {opts} Passed directly from settings.current_line_blame_formatter_opts.

Return: The result of this function is passed directly to the opts.virt_text field of |nvim_buf_set_extmark| and thus must be a list of [text, highlight] tuples.

Plugin default: " <author>, <author_time> - <summary> "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_formatter_nc

String or function used to format the virtual text of |gitsigns-config-current_line_blame| for lines that aren’t committed.

See |gitsigns-config-current_line_blame_formatter| for more information.

Plugin default: " <author>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.debug_mode

Enables debug logging and makes the following functions available: dump_cache, debug_messages, clear_debug.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.linehl

Enable/disable line highlights.

When enabled the highlights defined in signs.*.linehl are used. If the highlight group does not exist, then it is automatically defined and linked to the corresponding highlight group in signs.*.hl.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.max_file_length

Max file length (in lines) to attach to.

Plugin default: 40000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.numhl

Enable/disable line number highlights.

When enabled the highlights defined in signs.*.numhl are used. If the highlight group does not exist, then it is automatically defined and linked to the corresponding highlight group in signs.*.hl.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.on_attach

Callback called when attaching to a buffer. Mainly used to setup keymaps when config.keymaps is empty. The buffer number is passed as the first argument.

This callback can return false to prevent attaching to the buffer.

Example:

  function(bufnr)
    if vim.api.nvim_buf_get_name(bufnr):match(<PATTERN>) then
      -- Don't attach to specific buffers whose name matches a pattern
      return false
    end
    -- Setup keymaps
    vim.api.nvim_buf_set_keymap(bufnr, 'n', 'hs', '<cmd>lua require"gitsigns".stage_hunk()<CR>', {})
    ... -- More keymaps
  end

Type: null or lua code string

Default: null

Declared by:

plugins.gitsigns.settings.preview_config

Option overrides for the Gitsigns preview window. Table is passed directly to nvim_open_win.

Plugin default:

{
  border = "single";
  style = "minimal";
  relative = "cursor";
  row = 0;
  col = 1;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.gitsigns.settings.show_deleted

Show the old version of hunks inline in the buffer (via virtual lines).

Note: Virtual lines currently use the highlight GitSignsDeleteVirtLn.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.sign_priority

Priority to use for signs.

Plugin default: 6

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signcolumn

Enable/disable symbols in the sign column.

When enabled the highlights defined in signs.*.hl and symbols defined in signs.*.text are used.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.status_formatter

Function used to format b:gitsigns_status.

Plugin default:

function(status)
  local added, changed, removed = status.added, status.changed, status.removed
  local status_txt = {}
  if added and added > 0 then
    table.insert(status_txt, '+' .. added)
  end
  if changed and changed > 0 then
    table.insert(status_txt, '~' .. changed)
  end
  if removed and removed > 0 then
    table.insert(status_txt, '-' .. removed)
  end
  return table.concat(status_txt, ' ')
end

Type: null or lua function string

Default: null

Declared by:

plugins.gitsigns.settings.trouble

When using setqflist() or setloclist(), open Trouble instead of the quickfix/location list window.

Default: pcall(require, 'trouble')

Type: null or boolean

Default: null

Declared by:

plugins.gitsigns.settings.update_debounce

Debounce time for updates (in milliseconds).

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.word_diff

Highlight intra-line word differences in the buffer. Requires config.diff_opts.internal = true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_opts.delay

Sets the delay (in milliseconds) before blame virtual text is displayed.

Plugin default: 1000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_opts.ignore_whitespace

Ignore whitespace when running blame.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_opts.virt_text

Whether to show a virtual text blame annotation

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_opts.virt_text_pos

Blame annotation position.

Available values:

  • eol Right after eol character.
  • overlay Display over the specified column, without shifting the underlying text.
  • right_align Display right aligned in the window.

Plugin default: "eol"

Type: null or one of “eol”, “overlay”, “right_align” or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.current_line_blame_opts.virt_text_priority

Priority of virtual text.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts

Diff options. If set to null they are derived from the vim diffopt.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.algorithm

Diff algorithm to use. Values:

  • “myers” the default algorithm
  • “minimal” spend extra time to generate the smallest possible diff
  • “patience” patience diff algorithm
  • “histogram” histogram diff algorithm

Plugin default: "myers"

Type: null or one of “myers”, “minimal”, “patience”, “histogram” or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.ignore_blank_lines

Ignore changes where lines are blank.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.ignore_whitespace

Ignore all white space changes.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.ignore_whitespace_change

Ignore changes in amount of white space. It should ignore adding trailing white space, but not leading white space.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.ignore_whitespace_change_at_eol

Ignore white space changes at end of line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.indent_heuristic

Use the indent heuristic for the internal diff library.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.internal

Use Neovim’s built in xdiff library for running diffs.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.linematch

Enable second-stage diff on hunks to align lines. Requires internal=true.

Type: null or signed integer

Default: null

Declared by:

plugins.gitsigns.settings.diff_opts.vertical

Start diff mode with vertical splits.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.add.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsAdd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.add.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsAddLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.add.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsAddNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.add.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.add.text

Specifies the character to use for the sign.

Plugin default: "┃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.change.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsChange"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.change.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsChangeLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.change.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsChangeNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.change.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.change.text

Specifies the character to use for the sign.

Plugin default: "┃"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.changedelete.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsChange"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.changedelete.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsChangeLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.changedelete.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsChangeNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.changedelete.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.changedelete.text

Specifies the character to use for the sign.

Plugin default: "~"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.delete.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsDelete"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.delete.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsDeleteLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.delete.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsDeleteNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.delete.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.delete.text

Specifies the character to use for the sign.

Plugin default: "▁"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.topdelete.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsDelete"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.topdelete.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsDeleteLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.topdelete.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsDeleteNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.topdelete.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.topdelete.text

Specifies the character to use for the sign.

Plugin default: "▔"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.untracked.hl

Specifies the highlight group to use for the sign.

Plugin default: "GitSignsAdd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.untracked.linehl

Specifies the highlight group to use for the line.

Plugin default: "GitSignsAddLn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.untracked.numhl

Specifies the highlight group to use for the number column.

Plugin default: "GitSignsAddNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.untracked.show_count

Showing count of hunk, e.g. number of deleted lines.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.signs.untracked.text

Specifies the character to use for the sign.

Plugin default: "┆"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.watch_gitdir.enable

When opening a file, a libuv watcher is placed on the respective .git directory to detect when changes happen to use as a trigger to update signs.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.watch_gitdir.follow_files

If a file is moved with git mv, switch the buffer to the new location.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.gitsigns.settings.worktrees

Detached working trees. If normal attaching fails, then each entry in the table is attempted with the work tree details set.

Type: null or (list of (attribute set of anything))

Default: null

Declared by:

plugins.gitsigns.settings.worktrees.*.gitdir

This option has no description.

Type: string or raw lua code

Declared by:

plugins.gitsigns.settings.worktrees.*.toplevel

This option has no description.

Type: string or raw lua code

Declared by:

plugins.gitsigns.settings.yadm.enable

Enable YADM support.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

godot

Url: https://github.com/habamax/vim-godot/

Maintainers: Gaetan Lepage

plugins.godot.enable

Whether to enable vim-godot.

Type: boolean

Default: false

Example: true

Declared by:

plugins.godot.package

Which package to use for the godot plugin.

Type: package

Default: <derivation vimplugin-vim-godot-2024-02-17>

Declared by:

plugins.godot.godotPackage

Which package to use for godot. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation godot4-4.2.2-stable>

Declared by:

plugins.godot.settings

The configuration options for godot without the godot_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal godot_foo_bar=1
  • hello = "world" -> :setglobal godot_hello="world"
  • some_toggle = true -> :setglobal godot_some_toggle
  • other_toggle = false -> :setglobal nogodot_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  executable = "godot";
}

Declared by:

plugins.godot.settings.executable

Path to the godot executable.

Plugin default: "godot"

Type: null or string or raw lua code

Default: null

Declared by:

goyo

Url: https://github.com/junegunn/goyo.vim/

Maintainers: Gaetan Lepage

plugins.goyo.enable

Whether to enable goyo.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.goyo.package

Which package to use for the goyo plugin.

Type: package

Default: <derivation vimplugin-goyo.vim-2023-03-04>

Declared by:

plugins.goyo.settings

The configuration options for goyo without the goyo_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal goyo_foo_bar=1
  • hello = "world" -> :setglobal goyo_hello="world"
  • some_toggle = true -> :setglobal goyo_some_toggle
  • other_toggle = false -> :setglobal nogoyo_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.goyo.settings.height

height

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.goyo.settings.linenr

Show line numbers when in Goyo mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.goyo.settings.width

width

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.hardtime.enable

Whether to enable hardtime.

Type: boolean

Default: false

Example: true

Declared by:

plugins.hardtime.enabled

Whether the plugin in enabled by default or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hardtime.package

Which package to use for the hardtime plugin.

Type: package

Default: <derivation vimplugin-hardtime.nvim-2024-04-17>

Declared by:

plugins.hardtime.allowDifferentKey

Allow different keys to reset the count.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hardtime.disableMouse

Disable mouse support.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hardtime.disabledFiletypes

hardtime.nvim is disabled under these filetypes.

default:

["qf" "netrw" "NvimTree" "lazy" "mason"]

Type: null or (list of string)

Default: null

Declared by:

plugins.hardtime.disabledKeys

Keys in what modes are disabled.

default:

{
  "<Up>" = [ "" "i" ];
  "<Down>" = [ "" "i" ];
  "<Left>" = [ "" "i" ];
  "<Right>" = [ "" "i" ];
}

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.hardtime.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.hardtime.hint

Enable hint messages for better commands.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hardtime.maxCount

Maximum count of repeated key presses allowed within the max_time period.

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.hardtime.maxTime

Maximum time (in milliseconds) to consider key presses as repeated.

Plugin default: 1000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.hardtime.notification

Enable notification messages for restricted and disabled keys.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hardtime.resettingKeys

Keys in what modes that reset the count.

default:

{
  "1" = [ "n" "x" ];
  "2" = [ "n" "x" ];
  "3" = [ "n" "x" ];
  "4" = [ "n" "x" ];
  "5" = [ "n" "x" ];
  "6" = [ "n" "x" ];
  "7" = [ "n" "x" ];
  "8" = [ "n" "x" ];
  "9" = [ "n" "x" ];
  "c" = [ "n" ];
  "C" = [ "n" ];
  "d" = [ "n" ];
  "x" = [ "n" ];
  "X" = [ "n" ];
  "y" = [ "n" ];
  "Y" = [ "n" ];
  "p" = [ "n" ];
  "P" = [ "n" ];
}

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.hardtime.restrictedKeys

Keys in what modes triggering the count mechanism.

default:

{
  "h" = [ "n" "x" ];
  "j" = [ "n" "x" ];
  "k" = [ "n" "x" ];
  "l" = [ "n" "x" ];
  "-" = [ "n" "x" ];
  "+" = [ "n" "x" ];
  "gj" = [ "n" "x" ];
  "gk" = [ "n" "x" ];
  "<CR>" = [ "n" "x" ];
  "<C-M>" = [ "n" "x" ];
  "<C-N>" = [ "n" "x" ];
  "<C-P>" = [ "n" "x" ];
}

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.hardtime.restrictionMode

The behavior when restricted_keys trigger count mechanism.

Plugin default: "block"

Type: null or one of “block”, “hint” or raw lua code

Default: null

Declared by:

plugins.hardtime.hints

key is a string pattern you want to match, value is a table of hint massage and pattern length.

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.hardtime.hints.<name>.length

The length of actual key strokes that matches this pattern.

Type: unsigned integer, meaning >=0

Declared by:

plugins.hardtime.hints.<name>.message

Hint message to be displayed.

Type: raw lua code

Declared by:

plugins.harpoon.enable

Whether to enable harpoon.

Type: boolean

Default: false

Example: true

Declared by:

plugins.harpoon.enableTelescope

Whether to enable telescope integration.

Type: boolean

Default: false

Example: true

Declared by:

plugins.harpoon.package

Which package to use for the harpoon plugin.

Type: package

Default: <derivation vimplugin-harpoon-2023-12-26>

Declared by:

plugins.harpoon.enterOnSendcmd

Sets harpoon to run the command immediately as it’s passed to the terminal when calling sendCommand.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.harpoon.excludedFiletypes

Filetypes that you want to prevent from adding to the harpoon list menu.

Plugin default: ["harpoon"]

Type: null or (list of string)

Default: null

Declared by:

plugins.harpoon.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.harpoon.keymapsSilent

Whether harpoon keymaps should be silent.

Type: boolean

Default: false

Declared by:

plugins.harpoon.markBranch

Set marks specific to each git branch inside git repository.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.harpoon.saveOnChange

Saves the harpoon file upon every change. disabling is unrecommended.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.harpoon.saveOnToggle

Sets the marks upon calling toggle on the ui, instead of require :w.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.harpoon.tmuxAutocloseWindows

Closes any tmux windows harpoon that harpoon creates when you close Neovim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.harpoon.keymaps.addFile

Keymap for marking the current file.";

Type: null or string

Default: null

Declared by:

plugins.harpoon.keymaps.cmdToggleQuickMenu

Keymap for toggling the cmd quick menu.

Type: null or string

Default: null

Declared by:

plugins.harpoon.keymaps.gotoTerminal

Keymaps for navigating to terminals.

Examples: gotoTerminal = { “1” = “<C-j>”; “2” = “<C-k>”; “3” = “<C-l>”; “4” = “<C-m>”; };

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.harpoon.keymaps.navFile

Keymaps for navigating to marks.

Examples: navFile = { “1” = “<C-j>”; “2” = “<C-k>”; “3” = “<C-l>”; “4” = “<C-m>”; };

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.harpoon.keymaps.navNext

Keymap for navigating to next mark.";

Type: null or string

Default: null

Declared by:

plugins.harpoon.keymaps.navPrev

Keymap for navigating to previous mark.";

Type: null or string

Default: null

Declared by:

plugins.harpoon.keymaps.tmuxGotoTerminal

Keymaps for navigating to tmux windows/panes. Attributes can either be tmux window ids or pane identifiers.

Examples: tmuxGotoTerminal = { “1” = “<C-1>”; “2” = “<C-2>”; “{down-of}” = “<leader>g”; };

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.harpoon.keymaps.toggleQuickMenu

Keymap for toggling the quick menu.";

Type: null or string

Default: null

Declared by:

plugins.harpoon.menu.borderChars

Border characters

Plugin default: ["─" "│" "─" "│" "╭" "╮" "╯" "╰"]

Type: null or (list of string)

Default: null

Declared by:

plugins.harpoon.menu.height

Menu window height

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.harpoon.menu.width

Menu window width

Plugin default: 60

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.harpoon.projects

Predefined projetcs. The keys of this attrs should be the path to the project. $HOME is working.

Type: attribute set of (submodule)

Default: { }

Example:

''
  projects = {
    "$HOME/personal/vim-with-me/server" = {
      termCommands = [
          "./env && npx ts-node src/index.ts"
      ];
    };
  };
''

Declared by:

plugins.harpoon.projects.<name>.marks

List of predefined marks (filenames) for this project.

Type: null or (list of string)

Default: null

Declared by:

plugins.harpoon.projects.<name>.termCommands

List of predefined terminal commands for this project.

Type: null or (list of string)

Default: null

Declared by:

haskell-scope-highlighting

Url: https://github.com/kiyoon/haskell-scope-highlighting.nvim/

Maintainers: Gaetan Lepage

plugins.haskell-scope-highlighting.enable

Whether to enable haskell-scope-highlighting.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.haskell-scope-highlighting.package

Which package to use for the haskell-scope-highlighting plugin.

Type: package

Default: <derivation vimplugin-haskell-scope-highlighting.nvim-2023-04-29>

Declared by:

headlines

Url: https://github.com/lukas-reineke/headlines.nvim/

Maintainers: Gaetan Lepage

plugins.headlines.enable

Whether to enable headlines.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.headlines.package

Which package to use for the headlines.nvim plugin.

Type: package

Default: <derivation vimplugin-headlines.nvim-2024-02-29>

Declared by:

plugins.headlines.settings

Options provided to the require('headlines').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  markdown = {
    headline_highlights = [
      "Headline1"
    ];
  };
  norg = {
    codeblock_highlight = false;
    headline_highlights = [
      "Headline"
    ];
  };
  org = {
    headline_highlights = false;
  };
}

Declared by:

plugins.helm.enable

Whether to enable vim-helm.

Type: boolean

Default: false

Example: true

Declared by:

plugins.helm.package

Which package to use for the vim-helm plugin.

Type: package

Default: <derivation vimplugin-vim-helm-2024-02-05>

Declared by:

plugins.hmts.enable

Whether to enable hmts.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.hmts.package

Which package to use for the hmts.nvim plugin.

Type: package

Default: <derivation vimplugin-hmts.nvim-2024-05-07>

Declared by:

hop

Hop doesn’t set any keybindings; you will have to define them by yourself. If you want to create a key binding from within nixvim:

  keymaps = [
    {
      key = "f";
      action.__raw = \'\'
        function()
          require'hop'.hint_char1({
            direction = require'hop.hint'.HintDirection.AFTER_CURSOR,
            current_line_only = true
          })
        end
      \'\';
      options.remap = true;
    }
    {
      key = "F";
      action.__raw = \'\'
        function()
          require'hop'.hint_char1({
            direction = require'hop.hint'.HintDirection.BEFORE_CURSOR,
            current_line_only = true
          })
        end
      \'\';
      options.remap = true;
    }
    {
      key = "t";
      action.__raw = \'\'
        function()
          require'hop'.hint_char1({
            direction = require'hop.hint'.HintDirection.AFTER_CURSOR,
            current_line_only = true,
            hint_offset = -1
          })
        end
      \'\';
      options.remap = true;
    }
    {
      key = "T";
      action.__raw = \'\'
        function()
          require'hop'.hint_char1({
            direction = require'hop.hint'.HintDirection.BEFORE_CURSOR,
            current_line_only = true,
            hint_offset = 1
          })
        end
      \'\';
      options.remap = true;
    }
  ];

Url: https://github.com/smoka7/hop.nvim/

Maintainers: Gaetan Lepage

plugins.hop.enable

Whether to enable hop.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.hop.package

Which package to use for the hop.nvim plugin.

Type: package

Default: <derivation vimplugin-hop.nvim-2024-04-25>

Declared by:

plugins.hop.settings

Options provided to the require('hop').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  case_insensitive = false;
  dim_unmatched = true;
  direction = "require'hop.hint'.HintDirection.BEFORE_CURSOR";
  hint_position = "require'hop.hint'.HintPosition.BEGIN";
  hint_type = "require'hop.hint'.HintType.OVERLAY";
  jump_on_sole_occurrence = true;
  keys = "asdghklqwertyuiopzxcvbnmfj";
  match_mappings = [
    "zh"
    "zh_sc"
  ];
  quit_key = "<Esc>";
  reverse_distribution = false;
  teasing = true;
  virtual_cursor = true;
  x_bias = 10;
}

Declared by:

plugins.hop.settings.case_insensitive

Use case-insensitive matching by default for commands requiring user input.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.create_hl_autocmd

Create and set highlight autocommands to automatically apply highlights. You will want this if you use a theme that clears all highlights before applying its colorscheme.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.current_line_only

Apply Hop commands only to the current line.

Note: Trying to use this option along with multi_windows is unsound.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.dim_unmatched

Whether or not dim the unmatched text to emphasize the hint chars.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.direction

Direction in which to hint. See |hop.hint.HintDirection| for further details.

Setting this in the user configuration will make all commands default to that direction, unless overridden.

Type: null or lua code string

Default: null

Declared by:

plugins.hop.settings.excluded_filetypes

Skip hinting windows with the excluded filetypes. Those windows to check filetypes are collected only when you enable multi_windows or execute MW-commands. This option is useful to skip the windows which are only for displaying something but not for editing.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.hop.settings.extensions

List-table of extensions to enable (names). As described in |hop-extension|, extensions for which the name in that list must have a register(opts) function in their public API for Hop to correctly initialized them.

Type: null or (list of string)

Default: null

Declared by:

plugins.hop.settings.hint_offset

Offset to apply to a jump location.

If it is non-zero, the jump target will be offset horizontally from the selected jump position by hint_offset character(s).

This option can be used for emulating the motion commands |t| and |T| where the cursor is positioned on/before the target position.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.hop.settings.hint_position

Position of hint in match. See |hop.hint.HintPosition| for further details.

Plugin default: require'hop.hint'.HintPosition.BEGIN

Type: null or lua code string

Default: null

Declared by:

plugins.hop.settings.hint_type

How to show the hint char.

Possible values:

  • “overlay”: display over the specified column, without shifting the underlying text.
  • “inline”: display at the specified column, and shift the buffer text to the right as needed.

Plugin default: require'hop.hint'.HintType.OVERLAY

Type: null or lua code string

Default: null

Declared by:

plugins.hop.settings.ignore_injections

Ignore injected languages when jumping to treesitter node.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.jump_on_sole_occurrence

Immediately jump without displaying hints if only one occurrence exists.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.keys

A string representing all the keys that can be part of a permutation. Every character (key) used in the string will be used as part of a permutation. The shortest permutation is a permutation of a single character, and, depending on the content of your buffer, you might end up with 3-character (or more) permutations in worst situations.

However, it is important to notice that if you decide to provide keys, you have to ensure to use enough characters in the string, otherwise you might get very long sequences and a not so pleasant experience.

Plugin default: "asdghklqwertyuiopzxcvbnmfj"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hop.settings.match_mappings

This option allows you to specify the match mappings to use when applying the hint. If you set a non-empty match_mappings, the hint will be used as a key to look up the pattern to search for.

Currently supported mappings:~

  • ‘fa’ : farsi characters
  • ‘zh’ : Basic characters for Chinese
  • ‘zh_sc’ : Simplified Chinese
  • ‘zh_tc’ : Traditional Chinese

For example, if match_mappings is set to `[“zh” “zh_sc”], the characters in “zh” and “zh_sc” can be mixed to match together.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.hop.settings.multi_windows

Enable cross-windows support and hint all the currently visible windows. This behavior allows you to jump around any position in any buffer currently visible in a window. Although a powerful a feature, remember that enabling this will also generate many more sequence combinations, so you could get deeper sequences to type (most of the time it should be good if you have enough keys in |hop-config-keys|).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.perm_method

Permutation method to use.

Permutation methods allow to change the way permutations (i.e. hints sequence labels) are generated internally. There is currently only one possible option:

  • TrieBacktrackFilling: Permutation algorithm based on tries and backtrack filling.

    This algorithm uses the full potential of |hop-config-keys| by using them all to saturate a trie, representing all the permutations. Once a layer is saturated, this algorithm will backtrack (from the end of the trie, deepest first) and create a new layer in the trie, ensuring that the first permutations will be shorter than the last ones.

    Because of the last, deepest trie insertion mechanism and trie saturation, this algorithm yields a much better distribution across your buffer, and you should get 1-sequences and 2-sequences most of the time. Each dimension grows exponentially, so you get keys_length² 2-sequence keys, keys_length³ 3-sequence keys, etc in the worst cases.

Plugin default: require'hop.perm'.TrieBacktrackFilling

Type: null or lua function string

Default: null

Declared by:

plugins.hop.settings.quit_key

A string representing a key that will quit Hop mode without also feeding that key into Neovim to be treated as a normal key press.

It is possible to quit hopping by pressing any key that is not present in |hop-config-keys|; however, when you do this, the key normal function is also performed. For example if, hopping in |visual-mode|, pressing <Esc> will quit hopping and also exit |visual-mode|.

If the user presses quit_key, Hop will be quit without the key normal function being performed. For example if hopping in |visual-mode| with quit_key set to ‘<Esc>’, pressing <Esc> will quit hopping without quitting |visual-mode|.

If you don’t want to use a quit_key, set quit_key to an empty string.

Note: quit_key should only contain a single key or be an empty string.

Note: quit_key should not contain a key that is also present in |hop-config-keys|.

Plugin default: "<Esc>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hop.settings.reverse_distribution

The default behavior for key sequence distribution in your buffer is to concentrate shorter sequences near the cursor, grouping 1-character sequences around. As hints get further from the cursor, the dimension of the sequences will grow, making the furthest sequences the longest ones to type.

Set this option to true to reverse the density and concentrate the shortest sequences (1-character) around the furthest words and the longest sequences around the cursor.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.teasing

Boolean value stating whether Hop should tease you when you do something you are not supposed to.

If you find this setting annoying, feel free to turn it to false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.uppercase_labels

Display labels as uppercase. This option only affects the displayed labels; you still select them by typing the keys on your keyboard.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.virtual_cursor

Creates a virtual cursor in place of actual cursor when hop waits for user input to indicate the active window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hop.settings.x_bias

This Determines which hints get shorter key sequences. The default value has a more balanced distribution around the cursor but increasing it means that hints which are closer vertically will have a shorter key sequences.

For instance, when x_bias is set to 100, hints located at the end of the line will have shorter key sequence compared to hints in the lines above or below.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.hop.settings.yank_register

Determines which one of the registers stores the yanked text.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

hydra

Url: https://github.com/nvimtools/hydra.nvim/

Maintainers: Gaetan Lepage

plugins.hydra.enable

Whether to enable hydra.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.hydra.package

Which package to use for the hydra.nvim plugin.

Type: package

Default: <derivation vimplugin-hydra.nvim-2024-03-14>

Declared by:

plugins.hydra.hydras

This option has no description.

Type: list of (attribute set of anything)

Default: [ ]

Example:

[
  {
    body = "<leader>g";
    config = {
      color = "pink";
      hint = {
        position = "bottom";
      };
      invoke_on_body = true;
      on_enter = ''
        function()
          vim.bo.modifiable = false
          gitsigns.toggle_signs(true)
          gitsigns.toggle_linehl(true)
        end
      '';
      on_exit = ''
          function()
        	gitsigns.toggle_signs(false)
        	gitsigns.toggle_linehl(false)
        	gitsigns.toggle_deleted(false)
        	vim.cmd("echo") -- clear the echo area
        end
      '';
    };
    heads = [
      [
        "J"
        {
          __raw = ''
            function()
              if vim.wo.diff then
                return "]c"
              end
              vim.schedule(function()
                gitsigns.next_hunk()
              end)
              return "<Ignore>"
            end
          '';
        }
        {
          expr = true;
        }
      ]
      [
        "K"
        {
          __raw = ''
            function()
              if vim.wo.diff then
                return "[c"
              end
              vim.schedule(function()
                gitsigns.prev_hunk()
              end)
              return "<Ignore>"
            end
          '';
        }
        {
          expr = true;
        }
      ]
      [
        "s"
        ":Gitsigns stage_hunk<CR>"
        {
          silent = true;
        }
      ]
      [
        "u"
        {
          __raw = "require('gitsigns').undo_stage_hunk";
        }
      ]
      [
        "S"
        {
          __raw = "require('gitsigns').stage_buffer";
        }
      ]
      [
        "p"
        {
          __raw = "require('gitsigns').preview_hunk";
        }
      ]
      [
        "d"
        {
          __raw = "require('gitsigns').toggle_deleted";
        }
        {
          nowait = true;
        }
      ]
      [
        "b"
        {
          __raw = "require('gitsigns').blame_line";
        }
      ]
      [
        "B"
        {
          __raw = ''
            function()
              gitsigns.blame_line({ full = true })
            end,
          '';
        }
      ]
      [
        "/"
        {
          __raw = "require('gitsigns').show";
        }
        {
          exit = true;
        }
      ]
      [
        "<Enter>"
        "<cmd>Neogit<CR>"
        {
          exit = true;
        }
      ]
      [
        "q"
        null
        {
          exit = true;
          nowait = true;
        }
      ]
    ];
    hint = {
      __raw = ''
        [[
           _J_: next hunk   _s_: stage hunk        _d_: show deleted   _b_: blame line
           _K_: prev hunk   _u_: undo stage hunk   _p_: preview hunk   _B_: blame show full
           ^ ^              _S_: stage buffer      ^ ^                 _/_: show base file
           ^
           ^ ^              _<Enter>_: Neogit              _q_: exit
        ]]
      '';
    };
    mode = [
      "n"
      "x"
    ];
    name = "git";
  }
]

Declared by:

plugins.hydra.hydras.*.body

Key required to activate the hydra, when excluded, you can use Hydra:activate().

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.heads

Each Hydra’s head has the form: `[head rhs opts]

Similar to the vim.keymap.set() function.

  • The head is the “lhs” of the mapping (given as a string). These are the keys you press to perform the action.
  • The rhs is the action that gets performed. It can be a string, function (use __raw) or null. When null, the action is a no-op.
  • The opts attrs is empty by default.

Type: null or (list of list of (null or string or raw lua code or (attribute set of anything)))

Default: null

Declared by:

plugins.hydra.hydras.*.hint

The hint for a hydra can let you know that it’s active, and remind you of the hydra’s heads. The string for the hint is passed directly to the hydra.

See the README for more information.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.mode

Modes where the hydra exists, same as vim.keymap.set() accepts.

Plugin default: n

Type: null or one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: null

Declared by:

plugins.hydra.hydras.*.name

Hydra’s name. Only used in auto-generated hint.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.buffer

Define a hydra for the given buffer, pass true for current buf.

Plugin default: null

Type: null or value true (singular enum) or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.hydra.hydras.*.config.color

See :h hydra-colors. "red" | "amaranth" | "teal" | "pink"

Plugin default: "red"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.debug

Whether to enable debug mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.desc

Description used for the body keymap when invoke_on_body is true. When nil, “[Hydra] … name” is used.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.exit

Set the default exit value for each head in the hydra.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.foreign_keys

Decides what to do when a key which doesn’t belong to any head is pressed

  • null: hydra exits and foreign key behaves normally, as if the hydra wasn’t active
  • "warn": hydra stays active, issues a warning and doesn’t run the foreign key
  • "run": hydra stays active, runs the foreign key

Plugin default: null

Type: null or one of “warn”, “run” or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.hint

Configure the hint. Set to false to disable.

Plugin default:

{
  show_name = true;
  position = "bottom";
  offset = 0;
}

Type: null or value false (singular enum) or (attribute set of anything)

Default: null

Declared by:

plugins.hydra.hydras.*.config.invoke_on_body

When true, summon the hydra after pressing only the body keys. Normally a head is required.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.hydras.*.config.on_enter

Called when the hydra is activated.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.hydras.*.config.on_exit

Called before the hydra is deactivated.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.hydras.*.config.on_key

Called after every hydra head.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.hydras.*.config.timeout

Timeout after which the hydra is automatically disabled. Calling any head will refresh the timeout

  • true: timeout set to value of timeoutlen (:h timeoutlen)
  • 5000: set to desired number of milliseconds

By default hydras wait forever (false).

Plugin default: false

Type: null or boolean or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.hydra.settings

Options provided to the require('hydra').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  buffer = true;
  color = "red";
  desc = null;
  exit = false;
  foreign_keys = "run";
  hint = false;
  invoke_on_body = false;
  on_enter = ''
    function()
      print('hello')
    end
  '';
  timeout = 5000;
}

Declared by:

plugins.hydra.settings.buffer

Define a hydra for the given buffer, pass true for current buf.

Plugin default: null

Type: null or value true (singular enum) or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.hydra.settings.color

See :h hydra-colors. "red" | "amaranth" | "teal" | "pink"

Plugin default: "red"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.settings.debug

Whether to enable debug mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.settings.desc

Description used for the body keymap when invoke_on_body is true. When nil, “[Hydra] … name” is used.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.hydra.settings.exit

Set the default exit value for each head in the hydra.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.settings.foreign_keys

Decides what to do when a key which doesn’t belong to any head is pressed

  • null: hydra exits and foreign key behaves normally, as if the hydra wasn’t active
  • "warn": hydra stays active, issues a warning and doesn’t run the foreign key
  • "run": hydra stays active, runs the foreign key

Plugin default: null

Type: null or one of “warn”, “run” or raw lua code

Default: null

Declared by:

plugins.hydra.settings.hint

Configure the hint. Set to false to disable.

Plugin default:

{
  show_name = true;
  position = "bottom";
  offset = 0;
}

Type: null or value false (singular enum) or (attribute set of anything)

Default: null

Declared by:

plugins.hydra.settings.invoke_on_body

When true, summon the hydra after pressing only the body keys. Normally a head is required.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.hydra.settings.on_enter

Called when the hydra is activated.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.settings.on_exit

Called before the hydra is deactivated.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.settings.on_key

Called after every hydra head.

Type: null or lua code string

Default: null

Declared by:

plugins.hydra.settings.timeout

Timeout after which the hydra is automatically disabled. Calling any head will refresh the timeout

  • true: timeout set to value of timeoutlen (:h timeoutlen)
  • 5000: set to desired number of milliseconds

By default hydras wait forever (false).

Plugin default: false

Type: null or boolean or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.illuminate.enable

Whether to enable vim-illuminate.

Type: boolean

Default: false

Example: true

Declared by:

plugins.illuminate.package

Which package to use for the vim-illuminate plugin.

Type: package

Default: <derivation vimplugin-vim-illuminate-2024-04-18>

Declared by:

plugins.illuminate.delay

Delay in milliseconds.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.illuminate.filetypesAllowlist

Filetypes to illuminate, this is overridden by filetypes_denylist.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypesDenylist

Filetypes to not illuminate, this overrides filetypes_allowlist.

Plugin default: ["dirvish" "fugitive"]

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileCutoff

Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.

Type: null or signed integer

Default: null

Declared by:

plugins.illuminate.minCountToHighlight

Minimum number of matches required to perform highlighting.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.modesAllowlist

Modes to illuminate, this is overridden by modes_denylist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.modesDenylist

Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.providers

Provider used to get references in the buffer, ordered by priority.

Plugin default: ["lsp" "treesitter" "regex"]

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.providersRegexSyntaxAllowlist

Syntax to illuminate, this is overridden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.providersRegexSyntaxDenylist

Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.underCursor

Whether or not to illuminate under the cursor.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.illuminate.filetypeOverrides

Filetype specific overrides. The keys are strings to represent the filetype.

Plugin default: {}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.delay

Delay in milliseconds.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.largeFileCutoff

Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.

Type: null or signed integer

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.minCountToHighlight

Minimum number of matches required to perform highlighting.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.modesAllowlist

Modes to illuminate, this is overridden by modes_denylist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.modesDenylist

Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.providers

Provider used to get references in the buffer, ordered by priority.

Plugin default: ["lsp" "treesitter" "regex"]

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.providersRegexSyntaxAllowlist

Syntax to illuminate, this is overridden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.providersRegexSyntaxDenylist

Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.filetypeOverrides.<name>.underCursor

Whether or not to illuminate under the cursor.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.illuminate.largeFileOverrides

Config to use for large files (based on large_file_cutoff). Supports the same keys passed to .configure If null, illuminate will be disabled for large files.

Type: submodule

Default: { }

Declared by:

plugins.illuminate.largeFileOverrides.delay

Delay in milliseconds.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.filetypesAllowlist

Filetypes to illuminate, this is overridden by filetypes_denylist.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.filetypesDenylist

Filetypes to not illuminate, this overrides filetypes_allowlist.

Plugin default: ["dirvish" "fugitive"]

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.largeFileCutoff

Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.

Type: null or signed integer

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.minCountToHighlight

Minimum number of matches required to perform highlighting.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.modesAllowlist

Modes to illuminate, this is overridden by modes_denylist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.modesDenylist

Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.providers

Provider used to get references in the buffer, ordered by priority.

Plugin default: ["lsp" "treesitter" "regex"]

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.providersRegexSyntaxAllowlist

Syntax to illuminate, this is overridden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.providersRegexSyntaxDenylist

Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.illuminate.largeFileOverrides.underCursor

Whether or not to illuminate under the cursor.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.enable

Whether to enable image.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.image.package

Which package to use for the image.nvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-image.nvim-1.2.0-1-unstable-2024-05-14>

Declared by:

plugins.image.backend

All the backends support rendering inside Tmux.

  • kitty - best in class, works great and is very snappy

  • ueberzug - backed by ueberzugpp, supports any terminal, but has lower performance

    • Supports multiple images thanks to @jstkdng.

Plugin default: "kitty"

Type: null or one of “kitty”, “ueberzug” or raw lua code

Default: null

Declared by:

plugins.image.editorOnlyRenderWhenFocused

Auto show/hide images when the editor gains/looses focus.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.image.hijackFilePatterns

Render image files as images when opened.

Plugin default: ["*.png" "*.jpg" "*.jpeg" "*.gif" "*.webp"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.image.maxHeight

Image maximum height.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.image.maxHeightWindowPercentage

Image maximum height as a percentage of the window height.

Plugin default: 50

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.image.maxWidth

Image maximum width.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.image.maxWidthWindowPercentage

Image maximum width as a percentage of the window width.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.image.tmuxShowOnlyInActiveWindow

Auto show/hide images in the correct Tmux window (needs visual-activity off).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.windowOverlapClearEnabled

Toggles images when windows are overlapped.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.windowOverlapClearFtIgnore

Toggles images when windows are overlapped.

Plugin default: ["cmp_menu" "cmp_docs" ""]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.image.integrations.markdown.enabled

Whether to enable the markdown integration.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.markdown.clearInInsertMode

Clears the image when entering insert mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.markdown.downloadRemoteImages

Whether to download remote images.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.markdown.filetypes

Markdown extensions (ie. quarto) can go here.

Plugin default: ["markdown" "vimwiki"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.image.integrations.markdown.onlyRenderImageAtCursor

Whether to limit rendering to the image at the current cursor position.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.neorg.enabled

Whether to enable the markdown integration.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.neorg.clearInInsertMode

Clears the image when entering insert mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.neorg.downloadRemoteImages

Whether to download remote images.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.neorg.filetypes

Markdown extensions (ie. quarto) can go here.

Plugin default: ["norg"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.image.integrations.neorg.onlyRenderImageAtCursor

Whether to limit rendering to the image at the current cursor position.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.syslang.enabled

Whether to enable the markdown integration.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.syslang.clearInInsertMode

Clears the image when entering insert mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.syslang.downloadRemoteImages

Whether to download remote images.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.image.integrations.syslang.filetypes

Markdown extensions (ie. quarto) can go here.

Plugin default: ["syslang"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.image.integrations.syslang.onlyRenderImageAtCursor

Whether to limit rendering to the image at the current cursor position.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

improved-search

Url: https://github.com/backdround/improved-search.nvim/

Maintainers: Gaetan Lepage

plugins.improved-search.enable

Whether to enable improved-search.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.improved-search.package

Which package to use for the improved-search plugin.

Type: package

Default: <derivation vimplugin-improved-search.nvim-2023-12-21>

Declared by:

plugins.improved-search.keymaps

Keymap definitions for search functions

See here for the list of available callbacks.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "stable_next";
    key = "n";
    mode = [
      "n"
      "x"
      "o"
    ];
  }
  {
    action = "stable_previous";
    key = "N";
    mode = [
      "n"
      "x"
      "o"
    ];
  }
  {
    action = "current_word";
    key = "!";
    mode = "n";
    options = {
      desc = "Search current word without moving";
    };
  }
  {
    action = "in_place";
    key = "!";
    mode = "x";
  }
  {
    action = "forward";
    key = "*";
    mode = "x";
  }
  {
    action = "backward";
    key = "#";
    mode = "x";
  }
  {
    action = "in_place";
    key = "|";
    mode = "n";
  }
]

Declared by:

plugins.improved-search.keymaps.*.action

The action to execute.

See here for the list of available callbacks.

Type: one of “stable_next”, “stable_previous”, “current_word”, “current_word_strict”, “in_place”, “in_place_strict”, “forward”, “forward_strict”, “backward”, “backward_strict” or raw lua code

Example: "in_place"

Declared by:

plugins.improved-search.keymaps.*.key

The key to map.

Type: string

Example: "!"

Declared by:

plugins.improved-search.keymaps.*.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: ""

Example:

[
  "n"
  "v"
]

Declared by:

plugins.improved-search.keymaps.*.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.improved-search.keymaps.*.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.inc-rename.enable

Whether to enable inc-rename, a plugin previewing LSP renaming.

Type: boolean

Default: false

Example: true

Declared by:

plugins.inc-rename.package

Which package to use for the inc-rename plugin.

Type: package

Default: <derivation vimplugin-inc-rename.nvim-2024-05-13>

Declared by:

plugins.inc-rename.cmdName

the name of the command

Plugin default: "IncRename"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.inc-rename.hlGroup

the highlight group used for highlighting the identifier’s new name

Plugin default: "Substitute"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.inc-rename.inputBufferType

the type of the external input buffer to use

Plugin default: null

Type: null or value “dressing” (singular enum)

Default: null

Declared by:

plugins.inc-rename.postHook

callback to run after renaming, receives the result table (from LSP handler) as an argument

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.inc-rename.previewEmptyName

whether an empty new name should be previewed; if false the command preview will be cancelled instead

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.inc-rename.showMessage

whether to display a Renamed m instances in n files message after a rename operation

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

indent-blankline

Url: https://github.com/lukas-reineke/indent-blankline.nvim/

Maintainers: Gaetan Lepage

plugins.indent-blankline.enable

Whether to enable indent-blankline.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.indent-blankline.package

Which package to use for the indent-blankline.nvim plugin.

Type: package

Default: <derivation vimplugin-indent-blankline.nvim-2024-03-14>

Declared by:

plugins.indent-blankline.settings

Options provided to the require('indent-blankline').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  exclude = {
    buftypes = [
      "terminal"
      "quickfix"
    ];
    filetypes = [
      ""
      "checkhealth"
      "help"
      "lspinfo"
      "packer"
      "TelescopePrompt"
      "TelescopeResults"
      "yaml"
    ];
  };
  indent = {
    char = "│";
  };
  scope = {
    show_end = false;
    show_exact_scope = true;
    show_start = false;
  };
}

Declared by:

plugins.indent-blankline.settings.debounce

Sets the amount indent-blankline debounces refreshes in milliseconds.

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.exclude.buftypes

List of buftypes for which indent-blankline is disabled.

Plugin default:

[
  "terminal"
  "nofile"
  "quickfix"
  "prompt"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.indent-blankline.settings.exclude.filetypes

List of filetypes for which indent-blankline is disabled.

Plugin default:

[
  "lspinfo"
  "packer"
  "checkhealth"
  "help"
  "man"
  "gitcommit"
  "TelescopePrompt"
  "TelescopeResults"
  "\'\'"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.indent-blankline.settings.indent.char

Character, or list of characters, that get used to display the indentation guide. Each character has to have a display width of 0 or 1.

Plugin default: ▎

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.indent.highlight

Highlight group, or list of highlight groups, that get applied to the indentation guide.

Default: |hl-IblIndent|

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.indent.priority

Virtual text priority for the indentation guide.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.indent.smart_indent_cap

Caps the number of indentation levels by looking at the surrounding code.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.indent.tab_char

Character, or list of characters, that get used to display the indentation guide for tabs. Each character has to have a display width of 0 or 1.

Default: uses |lcs-tab| if |'list'| is set, otherwise, uses |ibl.config.indent.char|.

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.scope.enabled

Enables or disables scope.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.char

Character, or list of characters, that get used to display the scope indentation guide.

Each character has to have a display width of 0 or 1.

Default: indent.char

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.scope.highlight

Highlight group, or list of highlight groups, that get applied to the scope.

Default: |hl-IblScope|

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.scope.injected_languages

Checks for the current scope in injected treesitter languages. This also influences if the scope gets excluded or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.priority

Virtual text priority for the scope.

Plugin default: 1024

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.show_end

Shows an underline on the last line of the scope.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.show_exact_scope

Shows an underline on the first line of the scope starting at the exact start of the scope (even if this is to the right of the indent guide) and an underline on the last line of the scope ending at the exact end of the scope.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.show_start

Shows an underline on the first line of the scope.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.scope.exclude.language

List of treesitter languages for which scope is disabled.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.indent-blankline.settings.scope.exclude.node_type

Map of language to a list of node types which should not be used as scope.

Use * as a wildcard for all languages.

Plugin default:

{
  "*" = ["source_file" "program"];
  lua = ["chunk"];
  python = ["module"];
}

Type: null or (attribute set of ((list of string) or raw lua code))

Default: null

Declared by:

plugins.indent-blankline.settings.scope.include.node_type

Map of language to a list of node types which can be used as scope.

  • Use * as the language to act as a wildcard for all languages.
  • Use * as a node type to act as a wildcard for all node types.

Plugin default: {}

Type: null or (attribute set of ((list of string) or raw lua code))

Default: null

Declared by:

plugins.indent-blankline.settings.viewport_buffer.max

Maximum number of lines above and below of what is currently visible in the window for which indentation guides will be generated.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.viewport_buffer.min

Minimum number of lines above and below of what is currently visible in the window for which indentation guides will be generated.

Plugin default: 30

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.indent-blankline.settings.whitespace.highlight

Highlight group, or list of highlight groups, that get applied to the whitespace.

Default: |hl-IblWhitespace|

Type: null or string or list of string

Default: null

Declared by:

plugins.indent-blankline.settings.whitespace.remove_blankline_trail

Removes trailing whitespace on blanklines.

Turn this off if you want to add background color to the whitespace highlight group.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

indent-o-matic

Url: https://github.com/Darazaki/indent-o-matic/

Maintainers: Alison Jenkins

plugins.indent-o-matic.enable

Whether to enable indent-o-matic.

Type: boolean

Default: false

Example: true

Declared by:

plugins.indent-o-matic.package

Which package to use for the indent-o-matic plugin.

Type: package

Default: <derivation vimplugin-indent-o-matic-2023-06-03>

Declared by:

plugins.indent-o-matic.settings

Options provided to the require('indent-o-matic').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  max_lines = 2048;
  skip_multiline = false;
  standard_widths = [
    2
    4
    8
  ];
}

Declared by:

plugins.indent-o-matic.settings.max_lines

Number of lines without indentation before giving up (use -1 for infinite)

Plugin default: 2048

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.indent-o-matic.settings.skip_multiline

Skip multi-line comments and strings (more accurate detection but less performant)

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.indent-o-matic.settings.standard_widths

Space indentations that should be detected

Plugin default: [2 4 8]

Type: null or (list of (unsigned integer, meaning >=0, or raw lua code))

Default: null

Declared by:

instant

Url: https://github.com/jbyuki/instant.nvim/

Maintainers: Gaetan Lepage

plugins.instant.enable

Whether to enable instant.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.instant.package

Which package to use for the instant plugin.

Type: package

Default: <derivation vimplugin-instant.nvim-2022-06-25>

Declared by:

plugins.instant.settings

The configuration options for instant without the instant_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal instant_foo_bar=1
  • hello = "world" -> :setglobal instant_hello="world"
  • some_toggle = true -> :setglobal instant_some_toggle
  • other_toggle = false -> :setglobal noinstant_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  cursor_hl_group_default = "Cursor";
  cursor_hl_group_user1 = "Cursor";
  cursor_hl_group_user2 = "Cursor";
  cursor_hl_group_user3 = "Cursor";
  cursor_hl_group_user4 = "Cursor";
  name_hl_group_default = "CursorLineNr";
  name_hl_group_user1 = "CursorLineNr";
  name_hl_group_user2 = "CursorLineNr";
  name_hl_group_user3 = "CursorLineNr";
  name_hl_group_user4 = "CursorLineNr";
  onlyCwd = true;
  username = "Joe";
}

Declared by:

plugins.instant.settings.cursor_hl_group_default

Cursor highlight group for any other userr.

Plugin default: "Cursor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.cursor_hl_group_user1

Cursor highlight group for user 1.

Plugin default: "Cursor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.cursor_hl_group_user2

Cursor highlight group for user 2.

Plugin default: "Cursor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.cursor_hl_group_user3

Cursor highlight group for user 3.

Plugin default: "Cursor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.cursor_hl_group_user4

Cursor highlight group for user 4.

Plugin default: "Cursor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.name_hl_group_default

Virtual text highlight group for any other user.

Plugin default: "CursorLineNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.name_hl_group_user1

Virtual text highlight group for user 1.

Plugin default: "CursorLineNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.name_hl_group_user2

Virtual text highlight group for user 2.

Plugin default: "CursorLineNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.name_hl_group_user3

Virtual text highlight group for user 3.

Plugin default: "CursorLineNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.name_hl_group_user4

Virtual text highlight group for user 4.

Plugin default: "CursorLineNr"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.instant.settings.only_cwd

Choose whether to share files only in the current working directory in session mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.instant.settings.username

Username. Explicitly set to null if you do not want this option to be set.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.intellitab.enable

Whether to enable intellitab.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.intellitab.package

Which package to use for the intellitab.nvim plugin.

Type: package

Default: <derivation vimplugin-intellitab.nvim-2024-02-05>

Declared by:

julia-cell

Url: https://github.com/mroavi/vim-julia-cell/

Maintainers: Gaetan Lepage

plugins.julia-cell.enable

Whether to enable vim-julia-cell.

Type: boolean

Default: false

Example: true

Declared by:

plugins.julia-cell.package

Which package to use for the julia-cell plugin.

Type: package

Default: <derivation vimplugin-vim-julia-cell-2020-08-04>

Declared by:

plugins.julia-cell.keymaps.clear

Keymap for clearing the REPL.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.executeCell

Keymap for executing the current code cell.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.executeCellJump

Keymap for executing the current code cell and jumping to the next cell.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.nextCell

Keymap for jumping to the next cell header.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.prevCell

Keymap for jumping to the previous cell header.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.run

Keymap for running the entire file.

Type: null or string

Default: null

Declared by:

plugins.julia-cell.keymaps.silent

Whether julia-cell keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.julia-cell.settings

The configuration options for julia-cell without the julia_cell_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal julia_cell_foo_bar=1
  • hello = "world" -> :setglobal julia_cell_hello="world"
  • some_toggle = true -> :setglobal julia_cell_some_toggle
  • other_toggle = false -> :setglobal nojulia_cell_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.julia-cell.settings.delimit_cells_by

Specifies if cells are delimited by ‘marks’ or ‘tags’.

Plugin default: "marks"

Type: null or one of “marks”, “tags” or raw lua code

Default: null

Declared by:

plugins.julia-cell.settings.tag

Specifies the tag format.

Plugin default: "##"

Type: null or string or raw lua code

Default: null

Declared by:

jupytext

Url: https://github.com/GCBallesteros/jupytext.nvim/

Maintainers: Gaetan Lepage

plugins.jupytext.enable

Whether to enable jupytext.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.jupytext.package

Which package to use for the jupytext.nvim plugin.

Type: package

Default: <derivation vimplugin-jupytext.nvim-2024-04-05>

Declared by:

plugins.jupytext.settings

Options provided to the require('jupytext').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  custom_language_formatting = {
    python = {
      extension = "md";
      force_ft = "markdown";
      style = "markdown";
    };
  };
  force_ft = null;
  output_extension = "auto";
  style = "light";
}

Declared by:

plugins.jupytext.settings.custom_language_formatting

By default we use the auto mode of jupytext. This will create a script with the correct extension for each language. However, this can be overridden in a per language basis if you want to. For this you can set this option.

For example, to convert python files to quarto markdown:

  {
    python = {
      extension = "qmd";
      style = "quarto";
      force_ft = "quarto";
    };
  }

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.jupytext.settings.force_ft

Default filetype. Don’t change unless you know what you are doing.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.jupytext.settings.output_extension

By default, the extension of the plain text file is automatically selected by jupytext. This can be modified by changing the extension from auto to any other file extension supported by Jupytext. This is most useful to those using Quarto or Markdown. Analogously, we can provide a default filetype that will be given to the new buffer by using force_ft. Again, this is only really useful to users of Quarto.

Plugin default: "auto"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.jupytext.settings.style

The jupytext style to use.

Plugin default: "hydrogen"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lastplace.enable

Whether to enable lastplace.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lastplace.package

Which package to use for the lastplace plugin.

Type: package

Default: <derivation vimplugin-nvim-lastplace-2023-07-27>

Declared by:

plugins.lastplace.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lastplace.ignoreBuftype

The list of buffer types to ignore by lastplace.

Plugin default: ["quickfix" "nofix" "help"]

Type: null or (list of string)

Default: null

Declared by:

plugins.lastplace.ignoreFiletype

The list of file types to ignore by lastplace.

Plugin default: ["gitcommit" "gitrebase" "svn" "hgcommit"]

Type: null or (list of string)

Default: null

Declared by:

plugins.lastplace.openFolds

Whether closed folds are automatically opened when jumping to the last edit position.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lazy.enable

Whether to enable lazy.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lazy.plugins

List of plugins

Type: list of (package or (submodule))

Default: [ ]

Declared by:

lazygit

Url: https://github.com/kdheepak/lazygit.nvim/

Maintainers: Andres Bermeo Marinelli

plugins.lazygit.enable

Whether to enable lazygit.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lazygit.package

Which package to use for the lazygit plugin.

Type: package

Default: <derivation vimplugin-lazygit.nvim-2024-05-13>

Declared by:

plugins.lazygit.gitPackage

Which package to use for git. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation git-2.44.1>

Declared by:

plugins.lazygit.lazygitPackage

Which package to use for lazygit. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation lazygit-0.42.0>

Declared by:

plugins.lazygit.settings

The configuration options for lazygit without the lazygit_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal lazygit_foo_bar=1
  • hello = "world" -> :setglobal lazygit_hello="world"
  • some_toggle = true -> :setglobal lazygit_some_toggle
  • other_toggle = false -> :setglobal nolazygit_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  config_file_path = [ ];
  floating_window_border_chars = [
    "╭"
    "─"
    "╮"
    "│"
    "╯"
    "─"
    "╰"
    "│"
  ];
  floating_window_scaling_factor = 0.9;
  floating_window_use_plenary = false;
  floating_window_winblend = 0;
  use_custom_config_file_path = false;
  use_neovim_remote = true;
}

Declared by:

plugins.lazygit.settings.config_file_path

Custom config file path or list of custom config file paths.

Plugin default: []

Type: null or string or list of string

Default: null

Declared by:

plugins.lazygit.settings.floating_window_border_chars

Customize lazygit popup window border characters.

Plugin default: ["╭" "─" "╮" "│" "╯" "─" "╰" "│"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lazygit.settings.floating_window_scaling_factor

Set the scaling factor for floating window.

Plugin default: 0.9

Type: null or (nonnegative integer or floating point number, meaning >=0)

Default: null

Declared by:

plugins.lazygit.settings.floating_window_use_plenary

Whether to use plenary.nvim to manage floating window if available.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lazygit.settings.floating_window_winblend

Set the transparency of the floating window.

Plugin default: 0

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.lazygit.settings.use_custom_config_file_path

Config file path is evaluated if this value is true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lazygit.settings.use_neovim_remote

Whether to use neovim remote. Will fallback to false if neovim-remote is not installed.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.enable

Whether to enable lean-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lean.package

Which package to use for the lean-nvim plugin.

Type: package

Default: <derivation vimplugin-lean.nvim-2024-04-09>

Declared by:

plugins.lean.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lean.leanPackage

Which package to use for lean. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation lean4-4.7.0>

Declared by:

plugins.lean.mappings

Whether to enable suggested mappings.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.abbreviations.enable

Whether to enable expanding of unicode abbreviations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.abbreviations.extra

Additional abbreviations.

Example:

  {
    # Add a \wknight abbreviation to insert ♘
    #
    # Note that the backslash is implied, and that you of
    # course may also use a snippet engine directly to do
    # this if so desired.
    wknight = "♘";
  }


_Plugin default:_ `{}`

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lean.abbreviations.leader

Change if you don’t like the backslash. (comma is a popular choice on French keyboards)

Plugin default: "\\"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lean.ft.default

The default filetype for Lean files.

Plugin default: "lean"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lean.ft.nomodifiable

A list of patterns which will be used to protect any matching Lean file paths from being accidentally modified (by marking the buffer as nomodifiable).

By default, this list includes the Lean standard libraries, as well as files within dependency directories (e.g. _target) Set this to an empty table to disable.

Type: null or (list of string)

Default: null

Declared by:

plugins.lean.infoview.autoopen

Automatically open an infoview on entering a Lean buffer? Should be a function that will be called anytime a new Lean file is opened. Return true to open an infoview, otherwise false. Setting this to true is the same as function() return true end, i.e. autoopen for any Lean file, or setting it to false is the same as function() return false end, i.e. never autoopen.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.autopause

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.height

Set infoview windows’ starting height. Windows are opened horizontally or vertically depending on spacing.

Plugin default: 20

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.lean.infoview.horizontalPosition

Put the infoview on the top or bottom when horizontal.

Plugin default: "bottom"

Type: null or one of “top”, “bottom” or raw lua code

Default: null

Declared by:

plugins.lean.infoview.indicators

Show indicators for pin locations when entering an infoview window. "auto" = only when there are multiple pins.

Plugin default: "auto"

Type: null or one of “always”, “never”, “auto” or raw lua code

Default: null

Declared by:

plugins.lean.infoview.mappings

Mappings.

Plugin default:

{
  K = "click";
  "<CR>" = "click";
  gd = "go_to_def";
  gD = "go_to_decl";
  gy = "go_to_type";
  I = "mouse_enter";
  i = "mouse_leave";
  "<Esc>" = "clear_all";
  C = "clear_all";
  "<LocalLeader><Tab>" = "goto_last_window";
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lean.infoview.separateTab

Always open the infoview window in a separate tabpage. Might be useful if you are using a screen reader and don’t want too many dynamic updates in the terminal at the same time. Note that height and width will be ignored in this case.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.showNoInfoMessage

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.showProcessing

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.useWidgets

Whether to use widgets.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.width

Set infoview windows’ starting width. Windows are opened horizontally or vertically depending on spacing.

Plugin default: 50

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.lean.infoview.lean3.mouseEvents

Setting this to true will simulate mouse events in the Lean 3 infoview, this is buggy at the moment so you can use the I/i keybindings to manually trigger these.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.infoview.lean3.showFilter

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.lsp

LSP settings.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.lean.lsp.enable

Whether to enable the Lean language server(s) ?

Set to false to disable, otherwise should be a table of options to pass to leanls. See https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#leanls for details.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.lsp.init_options

The options to configure the lean language server. See Lean.Lsp.InitializationOptions for details.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lean.lsp.on_attach

The LSP handler.

Type: null or string

Default: null

Declared by:

plugins.lean.lsp3

Legacy Lean3 LSP settings.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.lean.lsp3.enable

Whether to enable the legacy Lean 3 language server ?

Set to false to disable, otherwise should be a table of options to pass to lean3ls. See https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#lean3ls for details.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.lsp3.on_attach

The LSP handler.

Type: null or string

Default: null

Declared by:

plugins.lean.progressBars.enable

Whether to enable the progress bars.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.progressBars.priority

Use a different priority for the signs.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lean.stderr.enable

Redirect Lean’s stderr messages somewhere (to a buffer by default).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lean.stderr.height

Height of the window.

Plugin default: 5

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.lean.stderr.onLines

A callback which will be called with (multi-line) stderr output.

e.g., use:

  onLines = "function(lines) vim.notify(lines) end";

if you want to redirect stderr to vim.notify. The default implementation will redirect to a dedicated stderr window.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.leap.enable

Whether to enable leap.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.leap.package

Which package to use for the leap.nvim plugin.

Type: package

Default: <derivation vimplugin-leap.nvim-2024-05-14>

Declared by:

plugins.leap.addDefaultMappings

Whether to enable the default mappings.

Type: boolean

Default: true

Declared by:

plugins.leap.caseSensitive

Whether to consider case in search patterns.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.leap.equivalenceClasses

A character will match any other in its equivalence class. The sets can either be defined as strings or tables.

Example:

  [
    "\r\n"
    ")]}>"
    "([{<"
    [ "\"" "'" "`" ]
  ]

Note: Make sure to have a set containing \n if you want to be able to target characters at the end of the line.

Note: Non-mutual aliases are not possible in Leap, for the same reason that supporting |smartcase| is not possible: we would need to show two different labels, corresponding to two different futures, at the same time.

Plugin default: [" \t\r\n"]

Type: null or (list of (string or list of string))

Default: null

Declared by:

plugins.leap.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.leap.highlightUnlabeledPhaseOneTargets

Whether to highlight unlabeled (i.e., directly reachable) matches after the first input character.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.leap.labels

Target labels to be used when there are more matches than labels in |leap.opts.safe_labels| plus one.

Setting the list to [] forces autojump to always be on (except for Operator-pending mode, where it makes no sense). In this case, do not forget to set special_keys.next_group to something “safe” too.

Plugin default:

[
  "s" "f" "n" "j" "k" "l" "h" "o" "d" "w" "e" "m" "b" "u" "y" "v" "r" "g" "t" "c" "x" "/"
  "z" "S" "F" "N" "J" "K" "L" "H" "O" "D" "W" "E" "M" "B" "U" "Y" "V" "R" "G" "T" "C" "X"
  "?" "Z"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.leap.maxHighlightedTraversalTargets

Number of targets to be highlighted after the cursor in |leap-traversal| mode (when there are no labels at all).

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.leap.maxPhaseOneTargets

By default, the plugin shows labels and/or highlights matches right after the first input character. This option disables ahead-of-time displaying of target beacons beyond a certain number of phase one targets (to mitigate visual noise in extreme cases). Setting it to 0 disables two-phase processing altogether.

Type: null or signed integer

Default: null

Declared by:

plugins.leap.safeLabels

When the number of matches does not exceed the number of these “safe” labels plus one, the plugin jumps to the first match automatically after entering the pattern. Obviously, for this purpose you should choose keys that are unlikely to be used right after a jump!

Setting the list to [] effectively disables the autojump feature.

Note: Operator-pending mode ignores this, since we need to be able to select the actual target before executing the operation.

Plugin default: ["s" "f" "n" "u" "t" "/" "S" "F" "N" "L" "H" "M" "U" "G" "T" "?" "Z"]

Type: null or (list of string)

Default: null

Declared by:

plugins.leap.substituteChars

The keys in this attrs will be substituted in labels and highlighted matches by the given characters. This way special (e.g. whitespace) characters can be made visible in matches, or even be used as labels.

Example: {"\r" = "¬";}

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.leap.specialKeys.multiAccept

Key captured by the plugin at runtime to accept the selection in |leap-multiselect| mode.

Plugin default: "<enter>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.leap.specialKeys.multiRevert

Key captured by the plugin at runtime to deselect the last selected target in |leap-multiselect| mode.

Plugin default: "<backspace>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.leap.specialKeys.nextGroup

Key captured by the plugin at runtime to switch to the next group of matches, when there are more matches than available labels.

Plugin default: "<space>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.leap.specialKeys.nextTarget

Key captured by the plugin at runtime to jump to the next match in traversal mode (|leap-traversal|)

Plugin default: "<enter>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.leap.specialKeys.prevGroup

Key captured by the plugin at runtime to switch to the previous group of matches, when there are more matches than available labels.

Plugin default: "<tab>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.leap.specialKeys.prevTarget

Key captured by the plugin at runtime to jump to the previous match in traversal mode (|leap-traversal|)

Plugin default: "<tab>"

Type: null or string or raw lua code

Default: null

Declared by:

ledger

Url: https://github.com/ledger/vim-ledger/

Maintainers: Gaetan Lepage

plugins.ledger.enable

Whether to enable vim-ledger.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ledger.package

Which package to use for the ledger plugin.

Type: package

Default: <derivation vimplugin-vim-ledger-2024-05-07>

Declared by:

plugins.ledger.ledgerPackage

Which package to use for ledger. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation ledger-3.3.2>

Declared by:

plugins.ledger.settings

The configuration options for ledger without the ledger_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal ledger_foo_bar=1
  • hello = "world" -> :setglobal ledger_hello="world"
  • some_toggle = true -> :setglobal ledger_some_toggle
  • other_toggle = false -> :setglobal noledger_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  detailed_first = true;
  fillstring = " ";
  fold_blanks = false;
  maxwidth = 80;
}

Declared by:

plugins.ledger.settings.accounts_cmd

To use a custom external system command to generate a list of account names for completion, set the following. If bin is set, this will default to running that command with arguments to parse the current file using the accounts subcommand (works with ledger or hledger), otherwise it will parse the postings in the current file itself.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.align_at

Specify at which column decimal separators should be aligned.

Plugin default: 60

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.ledger.settings.align_commodity

Align on the commodity location instead of the amount

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.align_last

Specify alignment on first or last matching separator.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.bin

Path to the ledger executable.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.cleared_string

Text of the output of the |:Balance| command.

Plugin default: "Cleared: "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.commodity_before

Flag that tells whether the commodity should be prepended or appended to the amount.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.commodity_sep

String to be put between the commodity and the amount:

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.commodity_spell

Flag that enable the spelling of the amount.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.date_format

Format of transaction date.

Plugin default: "%Y/%m/%d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.decimal_sep

Decimal separator.

Plugin default: "."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.default_commodity

Default commodity used by ledger#align_amount_at_cursor().

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.descriptions_cmd

To use a custom external system command to generate a list of descriptions for completion, set the following. If bin is set, this will default to running that command with arguments to parse the current file using the descriptions subcommand (works with ledger or hledger), otherwise it will parse the transactions in the current file itself.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.detailed_first

If you want the account completion to be sorted by level of detail/depth instead of alphabetical, set this option to true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.extra_options

Additional default options for the ledger executable.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.fillstring

String that will be used to fill the space between account name and amount in the foldtext. Set this to get some kind of lines or visual aid.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.fold_blanks

By default vim will fold ledger transactions, leaving surrounding blank lines unfolded. You can use this option to hide blank lines following a transaction.

A value of false will disable folding of blank lines, true will allow folding of a single blank line between transactions; any larger value will enable folding unconditionally.

Note that only lines containing no trailing spaces are considered for folding. You can take advantage of this to disable this feature on a case-by-case basis.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.is_hledger

Whether to use ledger or hledger specific features. Setting this value is optional and in most coses will be guessed correctly based on bin, but in the event it isn’t guessed correctly or you want to use different syntax features even with your default tooling setup for the other engine this flag can be set to override the value.

Type: null or boolean

Default: null

Declared by:

plugins.ledger.settings.main

The file to be used to generate reports. The default is to use the current file.

Plugin default: "%"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.maxwidth

Number of columns that will be used to display the foldtext. Set this when you think that the amount is too far off to the right. When maxwidth is zero, the amount will be displayed at the far right side of the screen.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.ledger.settings.pending_string

Text of the output of the |:Balance| command.

Plugin default: "Cleared or pending: "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_hide_file

Flag to show or hide filenames in the quickfix window:

Filenames in the quickfix window are hidden by default. Set this to 1 is you want filenames to be visible.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_reconcile_format

Format of the reconcile quickfix window (see |:Reconcile|). The format is specified using the standard Ledger syntax for --format.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_register_format

Format of quickfix register reports (see |:Register|). The format is specified using the standard Ledger syntax for --format.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_size

Size of the quickfix window.

This is the number of lines of a horizontal quickfix window, or the number of columns of a vertical quickfix window.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_vertical

Position of the quickfix/location list. Set to true to open the quickfix window in a vertical split.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.target_string

Text of the output of the |:Balance| command.

Plugin default: "Difference from target: "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.use_location_list

Flag that tells whether a location list or a quickfix list should be used: The default is to use the quickfix window. Set to true to use a location list.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ledger.settings.winpos

Position of a report buffer.

Use b for bottom, t for top, l for left, r for right. Use uppercase letters if you want the window to always occupy the full width or height.

Plugin default: "B"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lightline.enable

Whether to enable lightline.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lightline.package

Which package to use for the lightline plugin.

Type: package

Default: <derivation vimplugin-lightline.vim-2024-01-13>

Declared by:

plugins.lightline.colorscheme

The colorscheme to use for lightline. Defaults to .colorscheme.

Type: null or string

Default: null

Example: "gruvbox"

Declared by:

plugins.lightline.component

Lightline component definitions. Uses ‘statusline’ syntax. Consult :h ‘statusline’ for a list of what’s available.

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lightline.componentFunction

A list of function component definitions.

You should define the functions themselves in extraConfig

Type: null or (attribute set of string)

Default: null

Example:

''
  plugins.lightline = {
    enable = true;
    componentFunction = {
      readonly = "LightlineReadonly";
    };
  
    extraConfig = '''
      function! LightlineReadonly()
        return &readonly && &filetype !=# 'help' ? 'RO' : '''
      endfunction
    ''';
  };
''

Declared by:

plugins.lightline.modeMap

Mode name mappings

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lightline.active

This option has no description.

Type: null or (submodule)

Default: null

Declared by:

plugins.lightline.active.left

List of components that will show up on the left side of the bar

Type: null or (list of list of string) or raw lua code

Default: null

Declared by:

plugins.lightline.active.right

List of components that will show up on the right side of the bar

Type: null or (list of list of string) or raw lua code

Default: null

Declared by:

plugins.lightline.inactive

This option has no description.

Type: null or (submodule)

Default: null

Declared by:

plugins.lightline.inactive.left

List of components that will show up on the left side of the bar

Type: null or (list of list of string) or raw lua code

Default: null

Declared by:

plugins.lightline.inactive.right

List of components that will show up on the right side of the bar

Type: null or (list of list of string) or raw lua code

Default: null

Declared by:

plugins.lint.enable

Whether to enable nvim-lint.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lint.package

Which package to use for the nvim-lint plugin.

Type: package

Default: <derivation vimplugin-nvim-lint-2024-05-16>

Declared by:

plugins.lint.customLinters

Configure the linters you want to run per file type. It can be both an attrs or a string containing the lua code that returns the appropriate table.

Type: attribute set of (string or (attribute set))

Default: { }

Example: { }

Declared by:

plugins.lint.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lint.lintersByFt

Configure the linters you want to run per file type.

Default:

  {
    text = ["vale"];
    json = ["jsonlint"];
    markdown = ["vale"];
    rst = ["vale"];
    ruby = ["ruby"];
    janet = ["janet"];
    inko = ["inko"];
    clojure = ["clj-kondo"];
    dockerfile = ["hadolint"];
    terraform = ["tflint"];
  }

Type: attribute set of list of string

Default: { }

Example:

{
  markdown = [
    "vale"
  ];
}

Declared by:

plugins.lint.autoCmd

The configuration for the linting autocommand. You can disable it by setting this option to null.

Type: null or (submodule)

Default:

{
  callback = {
    __raw = ''
      function()
        require('lint').try_lint()
      end
    '';
  };
  event = "BufWritePost";
}

Declared by:

plugins.lint.autoCmd.buffer

Buffer number for buffer local autocommands |autocmd-buflocal|. Cannot be used with pattern.

Type: null or signed integer

Default: null

Declared by:

plugins.lint.autoCmd.callback

What action to perform for linting

Type: null or string or raw lua code

Default:

{
  __raw = ''
    function()
      require('lint').try_lint()
    end
  '';
}

Declared by:

plugins.lint.autoCmd.command

Vim command to execute on event. Cannot be used with callback.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lint.autoCmd.desc

A textual description of this autocommand.

Type: null or string

Default: null

Declared by:

plugins.lint.autoCmd.description

DEPRECATED, please use desc.

Type: null or string

Default: null

Declared by:

plugins.lint.autoCmd.event

The event or events that should trigger linting.

Type: null or string or list of string

Default: "BufWritePost"

Declared by:

plugins.lint.autoCmd.group

The autocommand group name or id to match against.

Type: null or string or signed integer

Default: null

Declared by:

plugins.lint.autoCmd.nested

Run nested autocommands.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lint.autoCmd.once

Run the autocommand only once.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lint.autoCmd.pattern

Pattern or patterns to match literally against.

Type: null or string or list of string

Default: null

Declared by:

plugins.lint.linters

Customize the existing linters by overriding some of their properties.

Type: attribute set of (attribute set)

Default: { }

Example:

{
  phpcs = {
    args = [
      "-q"
      "--report=json"
      "-"
    ];
  };
}

Declared by:

plugins.lint.linters.<name>.append_fname

Automatically append the file name to args if stdin = false Whether this parser supports content input via stdin. In that case the filename is automatically added to the arguments.

Default: true

Type: null or boolean

Default: null

Example: false

Declared by:

plugins.lint.linters.<name>.args

List of arguments. Can contain functions with zero arguments that will be evaluated once the linter is used.

Default: []

Type: null or (list of (string or raw lua code))

Default: null

Example: null

Declared by:

plugins.lint.linters.<name>.cmd

The command to call the linter

Type: null or string

Default: null

Example: "linter_cmd"

Declared by:

plugins.lint.linters.<name>.env

Custom environment table to use with the external process. Note that this replaces the entire environment, it is not additive.

Type: null or (attribute set of string)

Default: null

Example:

{
  FOO = "bar";
}

Declared by:

plugins.lint.linters.<name>.ignore_exitcode

Whether the linter exiting with a code !=0 should be considered normal.

Default: false

Type: null or boolean

Default: null

Example: true

Declared by:

plugins.lint.linters.<name>.parser

The code for your parser function.

Type: null or lua function string

Default: null

Example:

''
  require('lint.parser').from_pattern(pattern, groups, severity_map, defaults, opts)
''

Declared by:

plugins.lint.linters.<name>.stdin

Whether this parser supports content input via stdin. In that case the filename is automatically added to the arguments.

Default: true

Type: null or boolean

Default: null

Example: false

Declared by:

plugins.lint.linters.<name>.stream

configure the stream to which the linter outputs the linting result.

Default: "stdout"

Type: null or one of “stdout”, “stderr”, “both”

Default: null

Example: "stderr"

Declared by:

plugins.lsp.enable

Whether to enable neovim’s built-in LSP.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.capabilities

Lua code that modifies inplace the capabilities table.

Type: strings concatenated with “\n”

Default: ""

Declared by:

plugins.lsp.onAttach

A lua function to be run when a new LSP buffer is attached. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Default: ""

Declared by:

plugins.lsp.postConfig

Code to be run after loading the LSP. This is an internal option

Type: strings concatenated with “\n”

Default: ""

Declared by:

plugins.lsp.preConfig

Code to be run before loading the LSP. Useful for requiring plugins

Type: strings concatenated with “\n”

Default: ""

Declared by:

plugins.lsp.setupWrappers

Code to be run to wrap the setup args. Takes in an argument containing the previous results, and returns a new string of code.

Type: list of function that evaluates to a(n) string

Default: [ ]

Declared by:

plugins.lsp.keymaps.diagnostic

Mappings for vim.diagnostic.<action> functions to be added when an LSP is attached.

Type: attribute set of (string or (attribute set))

Default: { }

Example:

{
  "<leader>j" = "goto_next";
  "<leader>k" = "goto_prev";
}

Declared by:

plugins.lsp.keymaps.lspBuf

Mappings for vim.lsp.buf.<action> functions to be added when an LSP it attached.

Type: attribute set of (string or (attribute set))

Default: { }

Example:

{
  K = "hover";
  gD = "references";
  gd = "definition";
  gi = "implementation";
  gt = "type_definition";
}

Declared by:

plugins.lsp.keymaps.silent

Whether nvim-lsp keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.lsp.keymaps.extra

Extra keymaps to register when an LSP is attached. This can be used to customise LSP behaviour, for example with “telescope” or the “Lspsaga” plugin, as seen in the examples.

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    action = "<CMD>LspStop<Enter>";
    key = "<leader>lx";
  }
  {
    action = "<CMD>LspStart<Enter>";
    key = "<leader>ls";
  }
  {
    action = "<CMD>LspRestart<Enter>";
    key = "<leader>lr";
  }
  {
    action = {
      __raw = "require('telescope.builtin').lsp_definitions()";
    };
    key = "gd";
  }
  {
    action = "<CMD>Lspsaga hover_doc<Enter>";
    key = "K";
  }
]

Declared by:

plugins.lsp.keymaps.extra.*.action

The action to execute.

Type: string or raw lua code

Declared by:

plugins.lsp.keymaps.extra.*.key

The key to map.

Type: string

Example: "<C-m>"

Declared by:

plugins.lsp.keymaps.extra.*.mode

One or several modes. Use the short-names ("n", "v", …). See :h map-modes to learn more.

Type: one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x” or list of (one of “c”, “i”, “!”, “l”, “n”, “”, “o”, “s”, “t”, “v”, “x”)

Default: ""

Example:

[
  "n"
  "v"
]

Declared by:

plugins.lsp.keymaps.extra.*.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.keymaps.extra.*.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ansiblels.enable

Whether to enable ansiblels for Ansible.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ansiblels.package

Which package to use for ansiblels.

Type: null or package

Default: <derivation ansible-language-server-1.2.1>

Declared by:

plugins.lsp.servers.ansiblels.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ansiblels.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/2ff5g7vqy47j4k055f19bkcmf0cq18qq-ansible-language-server-1.2.1/bin/ansible-language-server"
  "--stdio"
]

Declared by:

plugins.lsp.servers.ansiblels.extraOptions

Extra options for the ansiblels language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ansiblels.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ansiblels.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ansiblels.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ansiblels.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ansiblels.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ansiblels.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ast-grep.enable

Whether to enable ast-grep(sg) is a fast and polyglot tool for code structural search, lint, rewriting at large scale. ast-grep LSP only works in projects that have sgconfig.y[a]ml in their root directories. .

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ast-grep.package

Which package to use for ast-grep.

Type: null or package

Default: <derivation ast-grep-0.22.3>

Declared by:

plugins.lsp.servers.ast-grep.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ast-grep.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ast-grep.extraOptions

Extra options for the ast-grep language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ast-grep.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ast-grep.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ast-grep.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ast-grep.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ast-grep.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ast-grep.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.astro.enable

Whether to enable astrols for Astro.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.astro.package

Which package to use for astro.

Type: null or package

Default: <derivation _at_astrojs_slash_language-server-2.8.3>

Declared by:

plugins.lsp.servers.astro.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.astro.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/wjwswp0lvcrqadbkimi202vv610fp5g6-_at_astrojs_slash_language-server-2.8.3/bin/astro-ls"
  "--stdio"
]

Declared by:

plugins.lsp.servers.astro.extraOptions

Extra options for the astro language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.astro.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.astro.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.astro.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.astro.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.astro.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.astro.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.bashls.enable

Whether to enable bashls for bash.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.bashls.package

Which package to use for bashls.

Type: null or package

Default: <derivation bash-language-server-5.1.2>

Declared by:

plugins.lsp.servers.bashls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.bashls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.bashls.extraOptions

Extra options for the bashls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.bashls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.bashls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.bashls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.bashls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.bashls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.bashls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.beancount.enable

Whether to enable beancount-language-server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.beancount.package

Which package to use for beancount.

Type: null or package

Default: <derivation beancount-language-server-1.3.4>

Declared by:

plugins.lsp.servers.beancount.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.beancount.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.beancount.extraOptions

Extra options for the beancount language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.beancount.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.beancount.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.beancount.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.beancount.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.beancount.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.beancount.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.biome.enable

Whether to enable Biome, Toolchain of the Web.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.biome.package

Which package to use for biome.

Type: null or package

Default: <derivation biome-1.7.3>

Declared by:

plugins.lsp.servers.biome.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.biome.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.biome.extraOptions

Extra options for the biome language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.biome.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.biome.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.biome.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.biome.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.biome.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.biome.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ccls.enable

Whether to enable ccls for C/C++.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ccls.package

Which package to use for ccls.

Type: null or package

Default: <derivation ccls-0.20240202>

Declared by:

plugins.lsp.servers.ccls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.extraOptions

Extra options for the ccls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ccls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ccls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ccls.initOptions.compilationDatabaseDirectory

If not empty, look for compile_commands.json in it, otherwise the file is retrieved in the project root.

Useful when using out-of-tree builds with the compilation database being generated in the build directory.

Example: "out/release"

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.cache.directory

If your project is /a/b, cache directories will be created at /a/b/.ccls-cache/@a@b/ (files under the project root) /a/b/.ccls-cache/@@a@b/ (files outside the project root, e.g. /usr/include/stdio.h).

If the path name is longer than the system limit, set cache.hierarchicalPath to true. The cache files will be stored in a hierarchical manner: /a/b/.ccls-cache/a/b/. Be careful if you specify an absolute path as files indexed by different projects may conflict.

This can also be an absolute path. Because the project path is encoded with @, cache directories of different projects will not conflict.

When ccls is started, it will try loading cache files if they are not stale (compile command line matches and timestamps of main source and its #include (direct and transitive) dependencies do not change).

If the argument is an empty string, the cache will be stored only in memory. Use this if you don’t want to write cache files.

Example: "/tmp/ccls-cache"

Plugin default: ".ccls-cache"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.cache.format

Specify the format of the cached index files. Binary is a compact binary serialization format.

If you would like to inspect the contents of the cache you can change this to "json" then use a JSON formatter such as jq . < /tmp/ccls/@tmp@c/a.cc.json to display it.

Plugin default: "binary"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.cache.retainInMemory

Change to 0 if you want to save memory, but having multiple ccls processes operating in the same directory may corrupt ccls’s in-memory representation of the index.

After this number of loads, keep a copy of file index in memory (which increases memory usage). During incremental updates, the removed file index will be taken from the in-memory copy, instead of the on-disk file.

Every index action is counted: the initial load, a save action.

  • 0: never retain
  • 1: retain after initial load
  • 2: retain after 2 loads (initial load+first save)

Plugin default: 1

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.clang.excludeArgs

Excluded arguments for compile_commands.json entries.

If your compiler is not Clang and it supports arguments which Clang doesn’t understand, then you can remove those arguments when indexing.

Example: ["-frounding-math"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.clang.extraArgs

Additional arguments for compile_commands.json entries.

Example: ["-frounding-math"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.clang.pathMappings

A list of src>dest path conversions used to remap the paths of files in the project. This can be used to move a project to a new location without re-indexing.

If cache files were built with project root /tmp/remote/proj, and you want to reuse them with a different project root /tmp/host/proj then copy the cache:

rsync -a /tmp/ccls/@tmp@remote@proj/ /tmp/ccls/@tmp@host@proj/ # files under project root
rsync -a /tmp/ccls/@@tmp@remote@proj/ /tmp/ccls/@@tmp@host@proj/ # files outside of project root

Then set this option to ["/remote/>/host/"].

When ccls indexes /tmp/host/proj/a.cc, the cache file /tmp/ccls/@tmp@remote@proj/a.cc.blob will be reused. When a.cc is saved (re-indexed), the newly generated a.cc.blob will not contain /tmp/remote paths any more.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.clang.resourceDir

The clang resource directory (something like .../lib/clang/9.0.0) is hard-coded into ccls at compile time. You should be able to find <resourceDir>/include/stddef.h. Set this option to a non-empty string to override the hard-coded value.

Use the path provided as the Clang resource directory rather the default.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.client.snippetSupport

client.snippetSupport and completion.placeholder (default: true) decide the completion style.

  • client.snippetSupport: false => foo

  • client.snippetSupport: true

    • completion.placeholder: false => foo($1)$0 bar<$1>()$0
    • completion.placeholder: true => foo($\{1:int a}, ${2:int b})$0 bar<${1:typename T}>()$0`

If the client announces that it does not support snippets, client.snippetSupport will be forced to false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.completion.detailedLabel

When this option is enabled, label and detailed are re-purposed:

  • label: detailed function signature, e.g. foo(int a, int b) -> bool
  • detailed: the name of the parent context, e.g. in S s; s.<complete>, the parent context is S.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.completion.filterAndSort

ccls filters and sorts completions to try to be nicer to clients that can’t handle big numbers of completion candidates. This behaviour can be disabled by specifying false for the option.

This option is useful for LSP clients that implement their own filtering and sorting logic.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.completion.placeholder

client.snippetSupport and completion.placeholder (default: true) decide the completion style.

  • client.snippetSupport: false => foo

  • client.snippetSupport: true

    • completion.placeholder: false => foo($1)$0 bar<$1>()$0
    • completion.placeholder: true => foo($\{1:int a}, ${2:int b})$0 bar<${1:typename T}>()$0`

If the client announces that it does not support snippets, client.snippetSupport will be forced to false.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.diagnostics.onChange

Time (in milliseconds) to wait before computing diagnostics for textDocument/didChange. After receiving a textDocument/didChange, wait up to this long before reporting diagnostics. Changes during this period of time only lead to one computation.

Diagnostics require parsing the file. If 1000 makes you feel slow, consider setting this to 1.

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.diagnostics.onOpen

Time (in milliseconds) to wait before computing diagnostics for textDocument/didOpen. How long to wait before diagnostics are emitted when a document is opened.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.diagnostics.onSave

Time (in milliseconds) to wait before computing diagnostics for textDocument/didSave. How long to wait before diagnostics are emitted after a document is saved.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.comments

ccls can index the contents of comments associated with functions/types/variables (macros are not handled). This value controls how comments are indexed:

  • 0: don’t index comments
  • 1: index Doxygen comment markers
  • 2: use -fparse-all-comments and recognize plain // /* */ in addition to Doxygen comment markers

Plugin default: 2

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.initialBlacklist

A list of regular expressions matching files that should not be indexed when the ccls server starts up, but will still be indexed if a client opens them. If there are areas of the project that you have no interest in indexing you can use this to avoid it unless you visit those files.

This can also be set to match all files, which is helpful in avoiding massive parsing operations when performing quick edits on large projects.

Be aware that you will not have access to full cross-referencing information in this situation.

If index.initialWhitelist is also specified, the whitelist takes precedence.

Example: ["."] (matches all files)

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.multiVersion

Index a file only once (0), or in each translation unit that includes it (1).

The default is sensible for common usage: it reduces memory footprint. If both a.cc and b.cc include a.h, there is only one indexed version of a.h.

But for dependent name lookup, or references in headers that may change depending on other macros, etc, you may want to index a file multiple times to get every possible cross reference. In that case set the option to 1 but be aware that it may increase index file sizes significantly.

Also consider using index.multiVersionBlacklist to exclude system headers.

Plugin default: 0

Type: null or one of 0, 1 or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.multiVersionBlacklist

A list of regular expressions matching files that should not be indexed via multi-version if index.multiVersion is set to 1.

Commonly this is used to avoid indexing system headers multiple times as this is seldom useful.

Example: ["^/usr/include"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.onChange

If false, a file is re-indexed when saved, updating the global index incrementally.

If set to true, a document is re-indexed for every (unsaved) change. Performance may suffer, but it is convenient for playground projects. Generally this is best used in conjunction with empty cache.directory to avoid writing cache files to disk.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.threads

How many threads to start when indexing a project. 0 means use std::thread::hardware_concurrency() (the number of cores the system has). If you want to reduce peak CPU and memory usage, set it to a small integer.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.initOptions.index.trackDependency

Determine whether a file should be re-indexed when any of its dependencies changes timestamp.

If a.h has been changed, when you open a.cc which includes a.h then if trackDependency is:

  • 0: no re-indexing unless a.cc itself changes timestamp.
  • 2: the index of a.cc is considered stale and it should be re-indexed.
  • 1: before the initial load, the behavior of 2 is used, otherwise the behavior of 0 is used.

Plugin default: 2

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ccls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ccls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ccls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.clangd.enable

Whether to enable clangd LSP for C/C++.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.clangd.package

Which package to use for clangd.

Type: null or package

Default: <derivation clang-tools-17.0.6>

Declared by:

plugins.lsp.servers.clangd.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.clangd.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.clangd.extraOptions

Extra options for the clangd language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.clangd.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.clangd.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.clangd.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.clangd.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.clangd.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.clangd.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.clojure-lsp.enable

Whether to enable clojure-lsp for Clojure.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.clojure-lsp.package

Which package to use for clojure-lsp.

Type: null or package

Default: <derivation clojure-lsp-2023.08.06-00.28.06>

Declared by:

plugins.lsp.servers.clojure-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.clojure-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.clojure-lsp.extraOptions

Extra options for the clojure-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.clojure-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.clojure-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.clojure-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.clojure-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.clojure-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.clojure-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.cmake.enable

Whether to enable cmake language server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.cmake.package

Which package to use for cmake.

Type: null or package

Default: <derivation cmake-language-server-0.1.10>

Declared by:

plugins.lsp.servers.cmake.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.cmake.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.cmake.extraOptions

Extra options for the cmake language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.cmake.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.cmake.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.cmake.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.cmake.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.cmake.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.cmake.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.csharp-ls.enable

Whether to enable csharp-ls for C#.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.csharp-ls.package

Which package to use for csharp-ls.

Type: null or package

Default: <derivation csharp-ls-0.13.0>

Declared by:

plugins.lsp.servers.csharp-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.csharp-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.csharp-ls.extraOptions

Extra options for the csharp-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.csharp-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.csharp-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.csharp-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.csharp-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.csharp-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.csharp-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.cssls.enable

Whether to enable cssls for CSS.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.cssls.package

Which package to use for cssls.

Type: null or package

Default: <derivation vscode-langservers-extracted-4.10.0>

Declared by:

plugins.lsp.servers.cssls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.cssls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/zcmg8r49snrsvrcd7rcadyv9kqcy8s81-vscode-langservers-extracted-4.10.0/bin/vscode-css-language-server"
  "--stdio"
]

Declared by:

plugins.lsp.servers.cssls.extraOptions

Extra options for the cssls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.cssls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.cssls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.cssls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.cssls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.cssls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.cssls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.dagger.enable

Whether to enable dagger for Cuelang.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.dagger.package

Which package to use for dagger.

Type: null or package

Default: <derivation cuelsp-0.3.4>

Declared by:

plugins.lsp.servers.dagger.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.dagger.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dagger.extraOptions

Extra options for the dagger language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.dagger.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dagger.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.dagger.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.dagger.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.dagger.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.dagger.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.dartls.enable

Whether to enable dart language-server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.dartls.package

Which package to use for dartls.

Type: null or package

Default: <derivation dart-3.3.4>

Declared by:

plugins.lsp.servers.dartls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.dartls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dartls.extraOptions

Extra options for the dartls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.dartls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dartls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.dartls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.dartls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.dartls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.dartls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.dartls.settings.enableSdkFormatter

When set to false, prevents registration (or unregisters) the SDK formatter. When set to true or not supplied, will register/reregister the SDK formatter

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.enableSnippets

Whether to include code snippets (such as class, stful, switch) in code completion. When unspecified, snippets will be included.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.analysisExcludedFolders

An array of paths (absolute or relative to each workspace folder) that should be excluded from analysis.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.completeFunctionCalls

When set to true, completes functions/methods with their required parameters.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.documentation

The typekind of dartdocs to include in Hovers, Code Completion, Signature Help and other similar requests. If not set, defaults to "full".

Type: null or one of “none”, “summary”, “full”

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.includeDependenciesInWorkspaceSymbols

Whether to include symbols from dependencies and Dart/Flutter SDKs in Workspace Symbol results. If not set, defaults to true.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.lineLength

The number of characters the formatter should wrap code at. If unspecified, code will be wrapped at 80 characters.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.renameFilesWithClasses

When set to “always”, will include edits to rename files when classes are renamed if the filename matches the class name (but in snake_form). When set to “prompt”, a prompt will be shown on each class rename asking to confirm the file rename. Otherwise, files will not be renamed. Renames are performed using LSP’s ResourceOperation edits - that means the rename is simply included in the resulting WorkspaceEdit and must be handled by the client.

Type: null or one of “always”, “prompt”

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.showTodos

Whether to generate diagnostics for TODO comments. If unspecified, diagnostics will not be generated.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.dartls.settings.updateImportsOnRename

Whether to update imports and other directives when files are renamed. When unspecified, imports will be updated if the client supports willRenameFiles requests.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.denols.enable

Whether to enable denols for Deno.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.denols.package

Which package to use for denols.

Type: null or package

Default: <derivation deno-1.44.3>

Declared by:

plugins.lsp.servers.denols.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.denols.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.denols.extraOptions

Extra options for the denols language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.denols.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.denols.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.denols.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.denols.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.denols.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.denols.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.dhall-lsp-server.enable

Whether to enable dhall-lsp-server for Dhall.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.dhall-lsp-server.package

Which package to use for dhall-lsp-server.

Type: null or package

Default: <derivation dhall-lsp-server-unstable-2024-02-19>

Declared by:

plugins.lsp.servers.dhall-lsp-server.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.dhall-lsp-server.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dhall-lsp-server.extraOptions

Extra options for the dhall-lsp-server language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.dhall-lsp-server.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dhall-lsp-server.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.dhall-lsp-server.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.dhall-lsp-server.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.dhall-lsp-server.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.dhall-lsp-server.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.digestif.enable

Whether to enable digestif for LaTeX.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.digestif.package

Which package to use for digestif.

Type: null or package

Default: <derivation lua5.4-digestif-0.5.1-1>

Declared by:

plugins.lsp.servers.digestif.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.digestif.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.digestif.extraOptions

Extra options for the digestif language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.digestif.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.digestif.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.digestif.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.digestif.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.digestif.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.digestif.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.docker-compose-language-service.enable

Whether to enable docker-compose-language-service for Docker Compose.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.docker-compose-language-service.package

Which package to use for docker-compose-language-service.

Type: null or package

Default: <derivation docker-compose-language-service-0.2.0>

Declared by:

plugins.lsp.servers.docker-compose-language-service.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.docker-compose-language-service.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.docker-compose-language-service.extraOptions

Extra options for the docker-compose-language-service language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.docker-compose-language-service.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.docker-compose-language-service.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.docker-compose-language-service.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.docker-compose-language-service.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.docker-compose-language-service.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.docker-compose-language-service.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.dockerls.enable

Whether to enable dockerls for Dockerfile.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.dockerls.package

Which package to use for dockerls.

Type: null or package

Default: <derivation dockerfile-language-server-nodejs-0.11.0>

Declared by:

plugins.lsp.servers.dockerls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.dockerls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/5b4jaz0zwp6by6v5qsfj6ipv4wy52m84-dockerfile-language-server-nodejs-0.11.0/bin/docker-langserver"
  "--stdio"
]

Declared by:

plugins.lsp.servers.dockerls.extraOptions

Extra options for the dockerls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.dockerls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.dockerls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.dockerls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.dockerls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.dockerls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.dockerls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.efm.enable

Whether to enable efm-langserver for misc tools.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.efm.package

Which package to use for efm.

Type: null or package

Default: <derivation efm-langserver-0.0.53>

Declared by:

plugins.lsp.servers.efm.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.efm.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.efm.extraOptions

Extra options for the efm language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.efm.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.efm.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.efm.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.efm.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.efm.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.efm.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.elixirls.enable

Whether to enable Enable elixirls…

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.elixirls.package

Which package to use for elixirls.

Type: null or package

Default: <derivation elixir-ls-0.21.1>

Declared by:

plugins.lsp.servers.elixirls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.elixirls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/ylm01iyq9mkkissdxh0v11bxhgf0j0y2-elixir-ls-0.21.1/bin/elixir-ls"
]

Declared by:

plugins.lsp.servers.elixirls.extraOptions

Extra options for the elixirls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.elixirls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.elixirls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.elixirls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.elixirls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.elixirls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.elixirls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.elmls.enable

Whether to enable elmls for Elm.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.elmls.package

Which package to use for elmls.

Type: null or package

Default: <derivation _at_elm-tooling_slash_elm-language-server-2.8.0>

Declared by:

plugins.lsp.servers.elmls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.elmls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.elmls.extraOptions

Extra options for the elmls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.elmls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.elmls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.elmls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.elmls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.elmls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.elmls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.emmet-ls.enable

Whether to enable emmet_ls, emmet support based on LSP.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.emmet-ls.package

Which package to use for emmet-ls.

Type: null or package

Default: <derivation emmet-ls-0.4.1>

Declared by:

plugins.lsp.servers.emmet-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.emmet-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.emmet-ls.extraOptions

Extra options for the emmet-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.emmet-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.emmet-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.emmet-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.emmet-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.emmet-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.emmet-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.eslint.enable

Whether to enable Enable eslint…

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.eslint.package

Which package to use for eslint.

Type: null or package

Default: <derivation vscode-langservers-extracted-4.10.0>

Declared by:

plugins.lsp.servers.eslint.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.eslint.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/zcmg8r49snrsvrcd7rcadyv9kqcy8s81-vscode-langservers-extracted-4.10.0/bin/vscode-eslint-language-server"
  "--stdio"
]

Declared by:

plugins.lsp.servers.eslint.extraOptions

Extra options for the eslint language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.eslint.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.eslint.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.eslint.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.eslint.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.eslint.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.eslint.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.fortls.enable

Whether to enable fortls for Fortran.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.fortls.package

Which package to use for fortls.

Type: null or package

Default: <derivation fortls-3.0.0>

Declared by:

plugins.lsp.servers.fortls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.fortls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/z1v12v6hv9afcpksk4l373xjb3m801qx-fortls-3.0.0/bin/fortls"
  "--hover_signature"
  "--hover_language=fortran"
  "--use_signature_help"
]

Declared by:

plugins.lsp.servers.fortls.extraOptions

Extra options for the fortls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.fortls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.fortls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.fortls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.fortls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.fortls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.fortls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.fsautocomplete.enable

Whether to enable fsautocomplete for F#.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.fsautocomplete.package

Which package to use for fsautocomplete.

Type: null or package

Default: <derivation fsautocomplete-0.72.3>

Declared by:

plugins.lsp.servers.fsautocomplete.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.fsautocomplete.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.fsautocomplete.extraOptions

Extra options for the fsautocomplete language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.fsautocomplete.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.fsautocomplete.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.fsautocomplete.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.fsautocomplete.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.fsautocomplete.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.fsautocomplete.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.futhark-lsp.enable

Whether to enable futhark-lsp for Futhark.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.futhark-lsp.package

Which package to use for futhark-lsp.

Type: null or package

Default: <derivation futhark-0.25.16>

Declared by:

plugins.lsp.servers.futhark-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.futhark-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.futhark-lsp.extraOptions

Extra options for the futhark-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.futhark-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.futhark-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.futhark-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.futhark-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.futhark-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.futhark-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.gdscript.enable

Whether to enable gdscript for Godot.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.gdscript.package

Which package to use for gdscript.

Type: null or package

Default: null

Declared by:

plugins.lsp.servers.gdscript.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.gdscript.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gdscript.extraOptions

Extra options for the gdscript language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.gdscript.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gdscript.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.gdscript.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.gdscript.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.gdscript.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.gdscript.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.gleam.enable

Whether to enable gleam for gleam.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.gleam.package

Which package to use for gleam.

Type: null or package

Default: <derivation gleam-1.1.0>

Declared by:

plugins.lsp.servers.gleam.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.gleam.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gleam.extraOptions

Extra options for the gleam language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.gleam.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gleam.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.gleam.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.gleam.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.gleam.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.gleam.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.golangci-lint-ls.enable

Whether to enable golangci-lint-ls for Go.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.golangci-lint-ls.package

Which package to use for golangci-lint-ls.

Type: null or package

Default: <derivation golangci-lint-langserver-0.0.9>

Declared by:

plugins.lsp.servers.golangci-lint-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.golangci-lint-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.golangci-lint-ls.extraOptions

Extra options for the golangci-lint-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.golangci-lint-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.golangci-lint-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.golangci-lint-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.golangci-lint-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.golangci-lint-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.golangci-lint-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.gopls.enable

Whether to enable gopls for Go.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.gopls.package

Which package to use for gopls.

Type: null or package

Default: <derivation gopls-0.15.3>

Declared by:

plugins.lsp.servers.gopls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.gopls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gopls.extraOptions

Extra options for the gopls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.gopls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.gopls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.gopls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.gopls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.gopls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.gopls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.graphql.enable

Whether to enable graphql for GraphQL.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.graphql.package

Which package to use for graphql.

Type: null or package

Default: <derivation graphql-language-service-cli-3.3.33>

Declared by:

plugins.lsp.servers.graphql.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.graphql.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.graphql.extraOptions

Extra options for the graphql language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.graphql.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.graphql.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.graphql.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.graphql.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.graphql.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.graphql.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.helm-ls.enable

Whether to enable helm_ls for Helm.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.helm-ls.package

Which package to use for helm-ls.

Type: null or package

Default: <derivation helm-ls-0.0.17>

Declared by:

plugins.lsp.servers.helm-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.helm-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.helm-ls.extraOptions

Extra options for the helm-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.helm-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.helm-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.helm-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.helm-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.helm-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.helm-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.hls.enable

Whether to enable haskell language server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.hls.package

Which package to use for hls.

Type: null or package

Default: <derivation haskell-language-server-2.8.0.0>

Declared by:

plugins.lsp.servers.hls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.hls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "haskell-language-server-wrapper"
  "--lsp"
]

Declared by:

plugins.lsp.servers.hls.extraOptions

Extra options for the hls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.hls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.hls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.hls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.hls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.hls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.hls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.html.enable

Whether to enable HTML language server from vscode-langservers-extracted.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.html.package

Which package to use for html.

Type: null or package

Default: <derivation vscode-langservers-extracted-4.10.0>

Declared by:

plugins.lsp.servers.html.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.html.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/zcmg8r49snrsvrcd7rcadyv9kqcy8s81-vscode-langservers-extracted-4.10.0/bin/vscode-html-language-server"
  "--stdio"
]

Declared by:

plugins.lsp.servers.html.extraOptions

Extra options for the html language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.html.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.html.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.html.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.html.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.html.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.html.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.htmx.enable

Whether to enable htmx for HTMX.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.htmx.package

Which package to use for htmx.

Type: null or package

Default: <derivation htmx-lsp-0.1.0>

Declared by:

plugins.lsp.servers.htmx.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.htmx.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.htmx.extraOptions

Extra options for the htmx language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.htmx.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.htmx.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.htmx.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.htmx.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.htmx.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.htmx.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.intelephense.enable

Whether to enable intelephense for PHP.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.intelephense.package

Which package to use for intelephense.

Type: null or package

Default: <derivation intelephense-1.10.2>

Declared by:

plugins.lsp.servers.intelephense.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.intelephense.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.intelephense.extraOptions

Extra options for the intelephense language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.intelephense.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.intelephense.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.intelephense.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.intelephense.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.intelephense.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.intelephense.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.java-language-server.enable

Whether to enable Java language server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.java-language-server.package

Which package to use for java-language-server.

Type: null or package

Default: <derivation java-language-server-0.2.46>

Declared by:

plugins.lsp.servers.java-language-server.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.java-language-server.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/1ligmiar9hq4hkzbq2as2r57anwl3i23-java-language-server-0.2.46/bin/java-language-server"
]

Declared by:

plugins.lsp.servers.java-language-server.extraOptions

Extra options for the java-language-server language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.java-language-server.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.java-language-server.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.java-language-server.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.java-language-server.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.java-language-server.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.java-language-server.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.jsonls.enable

Whether to enable jsonls for JSON.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.jsonls.package

Which package to use for jsonls.

Type: null or package

Default: <derivation vscode-langservers-extracted-4.10.0>

Declared by:

plugins.lsp.servers.jsonls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.jsonls.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/zcmg8r49snrsvrcd7rcadyv9kqcy8s81-vscode-langservers-extracted-4.10.0/bin/vscode-json-language-server"
  "--stdio"
]

Declared by:

plugins.lsp.servers.jsonls.extraOptions

Extra options for the jsonls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.jsonls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.jsonls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.jsonls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.jsonls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.jsonls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.jsonls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.julials.enable

Whether to enable julials for Julia.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.julials.package

Which package to use for julials.

Type: null or package

Default: null

Declared by:

plugins.lsp.servers.julials.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.julials.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.julials.extraOptions

Extra options for the julials language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.julials.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.julials.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.julials.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.julials.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.julials.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.julials.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.kotlin-language-server.enable

Whether to enable Kotlin language server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.kotlin-language-server.package

Which package to use for kotlin-language-server.

Type: null or package

Default: <derivation kotlin-language-server-1.3.9>

Declared by:

plugins.lsp.servers.kotlin-language-server.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.kotlin-language-server.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.kotlin-language-server.extraOptions

Extra options for the kotlin-language-server language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.kotlin-language-server.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.kotlin-language-server.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.kotlin-language-server.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.kotlin-language-server.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.kotlin-language-server.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.kotlin-language-server.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.leanls.enable

Whether to enable leanls for Lean.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.leanls.package

Which package to use for leanls.

Type: null or package

Default: <derivation lean4-4.7.0>

Declared by:

plugins.lsp.servers.leanls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.leanls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.leanls.extraOptions

Extra options for the leanls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.leanls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.leanls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.leanls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.leanls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.leanls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.leanls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.lemminx.enable

Whether to enable lemminx for XML.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.lemminx.package

Which package to use for lemminx.

Type: null or package

Default: <derivation lemminx-0.27.0>

Declared by:

plugins.lsp.servers.lemminx.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lemminx.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lemminx.extraOptions

Extra options for the lemminx language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.lemminx.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lemminx.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.lemminx.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.lemminx.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.lemminx.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.lemminx.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.lexical.enable

Whether to enable lexical for Elixir.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.lexical.package

Which package to use for lexical.

Type: null or package

Default: <derivation lexical-0.6.1>

Declared by:

plugins.lsp.servers.lexical.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lexical.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lexical.extraOptions

Extra options for the lexical language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.lexical.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lexical.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.lexical.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.lexical.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.lexical.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.lexical.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ltex.enable

Whether to enable ltex-ls for LanguageTool.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ltex.package

Which package to use for ltex.

Type: null or package

Default: <derivation ltex-ls-16.0.0>

Declared by:

plugins.lsp.servers.ltex.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ltex.extraOptions

Extra options for the ltex language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ltex.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ltex.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ltex.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ltex.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ltex.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ltex.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ltex.settings.enabled

Controls whether the extension is enabled. Allows disabling LanguageTool on specific workspaces or for specific code language modes (i.e., file types).

Either supply a boolean value stating whether LTEX is enabled for all supported markup languages or disabled for all of them, or supply a list of code language identifiers for which LTEX should be enabled (note that extensions can define additional code language identifiers).

All supported markup languages are listed in the default value of this setting. In addition, LTEX can check comments in many popular programming languages like C++ or Java, if you add the corresponding code language identifiers to this setting. If you add an unsupported code language mode, LTEX will check corresponding files as plain text without any parsing.

The activation events are unaffected by this setting. This means that the extension will be activated whenever a file with a supported code language mode is opened. For unsupported code language modes, you may need to activate the extension explicitly by executing the LTeX: Activate Extension command.

Examples:

  • true
  • false
  • [“latex” “markdown”]

Plugin default:

[
  "bibtex"
  "context"
  "context.tex"
  "html"
  "latex"
  "markdown"
  "org"
  "restructuredtext"
  "rsweave"
]

Type: null or boolean or list of (string or raw lua code) or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.enabledRules

Lists of rules that should be enabled (if disabled by default by LanguageTool). This setting is language-specific, so use an attrs of the format

  {
    "<LANGUAGE1>" = [
      "<WORD1>"
      "<WORD2>"
      ...
    ];
    "<LANGUAGE2>" = [
      "<WORD1>"
      "<WORD2>"
    ];
    ...
  };

where <LANGUAGE> denotes the language code in settings.language and <RULE> the ID of the LanguageTool rule.

This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional rules will be enabled.

Example:

  {
    "en-GB" = [
      "PASSIVE_VOICE"
      "OXFORD_SPELLING_NOUNS"
      ":/path/to/externalFile.txt"
    ];
  }

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.checkFrequency

Controls when documents should be checked.

Possible values:

  • “edit”: Documents are checked when they are opened or edited (on every keystroke), or when the settings change.
  • “save”: Documents are checked when they are opened or saved, or when the settings change.
  • “manual”: Documents are not checked automatically, except when the settings change. Use commands such as LTeX: Check Current Document to manually trigger checks.

Plugin default: "edit"

Type: null or one of “edit”, “save”, “manual” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.clearDiagnosticsWhenClosingFile

If set to true, diagnostics of a file are cleared when the file is closed.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.completionEnabled

Controls whether completion is enabled (also known as auto-completion, quick suggestions, and IntelliSense).

If this setting is enabled, then a list of words is displayed that complete the currently typed word (whenever the editor sends a completion request).

In VS Code, completion is enabled by default while typing (via editor.quickSuggestions). Therefore, this setting is disabled by default, as constantly displaying completion lists might annoy the user. It is recommended to enable this setting.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.configurationTarget

Controls which settings.json or external setting file (see documentation) to update when using one of the quick fixes.

Plugin default:

{
  dictionary = "workspaceFolderExternalFile";
  disabledRules = "workspaceFolderExternalFile";
  hiddenFalsePositives = "workspaceFolderExternalFile";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.diagnosticSeverity

Severity of the diagnostics corresponding to the grammar and spelling errors.

Controls how and where the diagnostics appear. The possible severities are “error”, “warning”, “information”, and “hint”.

This setting can either be a string with the severity to use for all diagnostics, or an attrs with rule-dependent severities. If an attrs is used, each key is the ID of a LanguageTool rule and each value is one of the possible severities. In this case, the severity of other rules, which don’t match any of the keys, has to be specified with the special key “default”.

Examples:

  • "information"
  • {PASSIVE_VOICE = "hint"; default = "information";}

Plugin default: information

Type: null or string or attribute set of (string or raw lua code) or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.dictionary

Lists of additional words that should not be counted as spelling errors. This setting is language-specific, so use an attrs of the format

  {
    "<LANGUAGE1>" = [
      "<WORD1>"
      "<WORD2>"
      ...
    ];
    "<LANGUAGE2>" = [
      "<WORD1>"
      "<WORD2>"
    ];
    ...
  };

where <LANGUAGE> denotes the language code in settings.language.

This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional spelling errors will be ignored.

Example:

{
  "en-US" = [
    "adaptivity"
    "precomputed"
    "subproblem"
  ];
  "de-DE" = [
    "B-Splines"
    ":/path/to/externalFile.txt"
  ];
}

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.disabledRules

Lists of rules that should be disabled (if enabled by default by LanguageTool). This setting is language-specific, so use an attrs of the format

  {
    "<LANGUAGE1>" = [
      "<WORD1>"
      "<WORD2>"
      ...
    ];
    "<LANGUAGE2>" = [
      "<WORD1>"
      "<WORD2>"
    ];
    ...
  };

where <LANGUAGE> denotes the language code in settings.language and <RULE> the ID of the LanguageTool rule.

This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional rules will be disabled.

Example:

{
  "en-US" = [
    "EN_QUOTES"
    "UPPERCASE_SENTENCE_START"
    ":/path/to/externalFile.txt"
  ];
}

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.fields

List of BibTEX fields whose values are to be checked in BibTEX files.

This setting is an attrs with the field names as keys (not restricted to classical BibTEX fields) and booleans as values, where true means that the field value should be checked and false means that the field value should be ignored.

Some common fields are already ignored, even if you set this setting to an empty attrs.

Example:

  {
    maintitle = false;
    seealso = true;
  }

Plugin default: { }

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.hiddenFalsePositives

Lists of false-positive diagnostics to hide (by hiding all diagnostics of a specific rule within a specific sentence). This setting is language-specific, so use an attrs of the format

  {
    "<LANGUAGE1>" = [
      "<JSON1>"
      "<JSON2>"
      ...
    ];
    "<LANGUAGE2>" = [
      "<JSON1>"
      "<JSON2>"
    ];
    ...
  };

where <LANGUAGE> denotes the language code in settings.language and <JSON> is a JSON string containing information about the rule and sentence.

Although it is possible to manually edit this setting, the intended way is the Hide false positive quick fix.

The JSON string currently has the form {"rule": "<RULE>", "sentence": "<SENTENCE>"}, where <RULE> is the ID of the LanguageTool rule and <SENTENCE> is a Java-compatible regular expression. All occurrences of the given rule are hidden in sentences (as determined by the LanguageTool tokenizer) that match the regular expression. See the documentation for details.

This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. If this list is very large, performance may suffer.

Example:

  {
    "en-US" = [ ":/path/to/externalFile.txt" ];
  }

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.language

The language (e.g., “en-US”) LanguageTool should check against. Use a specific variant like “en-US” or “de-DE” instead of the generic language code like “en” or “de” to obtain spelling corrections (in addition to grammar corrections).

When using the language code “auto”, LTEX will try to detect the language of the document. This is not recommended, as only generic languages like “en” or “de” will be detected and thus no spelling errors will be reported.

Possible values:

  • “auto”: Automatic language detection (not recommended)
  • “ar”: Arabic
  • “ast-ES”: Asturian
  • “be-BY”: Belarusian
  • “br-FR”: Breton
  • “ca-ES”: Catalan
  • “ca-ES-valencia”: Catalan (Valencian)
  • “da-DK”: Danish
  • “de”: German
  • “de-AT”: German (Austria)
  • “de-CH”: German (Swiss)
  • “de-DE”: German (Germany)
  • “de-DE-x-simple-language”: Simple German
  • “el-GR”: Greek
  • “en”: English
  • “en-AU”: English (Australian)
  • “en-CA”: English (Canadian)
  • “en-GB”: English (GB)
  • “en-NZ”: English (New Zealand)
  • “en-US”: English (US)
  • “en-ZA”: English (South African)
  • “eo”: Esperanto
  • “es”: Spanish
  • “es-AR”: Spanish (voseo)
  • “fa”: Persian
  • “fr”: French
  • “ga-IE”: Irish
  • “gl-ES”: Galician
  • “it”: Italian
  • “ja-JP”: Japanese
  • “km-KH”: Khmer
  • “nl”: Dutch
  • “nl-BE”: Dutch (Belgium)
  • “pl-PL”: Polish
  • “pt”: Portuguese
  • “pt-AO”: Portuguese (Angola preAO)
  • “pt-BR”: Portuguese (Brazil)
  • “pt-MZ”: Portuguese (Moçambique preAO)
  • “pt-PT”: Portuguese (Portugal)
  • “ro-RO”: Romanian
  • “ru-RU”: Russian
  • “sk-SK”: Slovak
  • “sl-SI”: Slovenian
  • “sv”: Swedish
  • “ta-IN”: Tamil
  • “tl-PH”: Tagalog
  • “uk-UA”: Ukrainian
  • “zh-CN”: Chinese

Plugin default: "en-US"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.languageToolHttpServerUri

If set to a non-empty string, LTEX will not use the bundled, built-in version of LanguageTool. Instead, LTEX will connect to an external LanguageTool HTTP server. Set this setting to the root URI of the server, and do not append v2/check or similar.

Note that in this mode, the settings settings.additionalRules.languageModel, settings.additionalRules.neuralNetworkModel, and settings.additionalRules.word2VecModel will not take any effect.

Example: "http://localhost:8081/"

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.sentenceCacheSize

Size of the LanguageTool ResultCache in sentences (must be a positive integer).

If only a small portion of the text changed (e.g., a single key press in the editor), LanguageTool uses the cache to avoid rechecking the complete text. LanguageTool internally splits the text into sentences, and sentences that have already been checked are skipped.

Decreasing this might decrease RAM usage of the Java process. If you set this too small, checking time may increase significantly.

Changes require restarting LTEX to take effect.

Plugin default: 2000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.statusBarItem

If set to true, an item about the status of LTEX is shown permanently in the status bar.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.additionalRules.enablePickyRules

Enable LanguageTool rules that are marked as picky and that are disabled by default, e.g., rules about passive voice, sentence length, etc., at the cost of more false positives.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.additionalRules.languageModel

Optional path to a directory with rules of a language model with n-gram occurrence counts. Set this setting to the parent directory that contains subdirectories for languages (e.g., en).

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.additionalRules.motherTongue

Optional mother tongue of the user (e.g., “de-DE”).

If set, additional rules will be checked to detect false friends. Picky rules may need to be enabled in order to see an effect (see settings.additionalRules.enablePickyRules). False friend detection improves if a language model is supplied (see settings.additionalRules.languageModel).

Possible values:

  • “”: No mother tongue
  • “ar”: Arabic
  • “ast-ES”: Asturian
  • “be-BY”: Belarusian
  • “br-FR”: Breton
  • “ca-ES”: Catalan
  • “ca-ES-valencia”: Catalan (Valencian)
  • “da-DK”: Danish
  • “de”: German
  • “de-AT”: German (Austria)
  • “de-CH”: German (Swiss)
  • “de-DE”: German (Germany)
  • “de-DE-x-simple-language”: Simple German
  • “el-GR”: Greek
  • “en”: English
  • “en-AU”: English (Australian)
  • “en-CA”: English (Canadian)
  • “en-GB”: English (GB)
  • “en-NZ”: English (New Zealand)
  • “en-US”: English (US)
  • “en-ZA”: English (South African)
  • “eo”: Esperanto
  • “es”: Spanish
  • “es-AR”: Spanish (voseo)
  • “fa”: Persian
  • “fr”: French
  • “ga-IE”: Irish
  • “gl-ES”: Galician
  • “it”: Italian
  • “ja-JP”: Japanese
  • “km-KH”: Khmer
  • “nl”: Dutch
  • “nl-BE”: Dutch (Belgium)
  • “pl-PL”: Polish
  • “pt”: Portuguese
  • “pt-AO”: Portuguese (Angola preAO)
  • “pt-BR”: Portuguese (Brazil)
  • “pt-MZ”: Portuguese (Moçambique preAO)
  • “pt-PT”: Portuguese (Portugal)
  • “ro-RO”: Romanian
  • “ru-RU”: Russian
  • “sk-SK”: Slovak
  • “sl-SI”: Slovenian
  • “sv”: Swedish
  • “ta-IN”: Tamil
  • “tl-PH”: Tagalog
  • “uk-UA”: Ukrainian
  • “zh-CN”: Chinese

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.additionalRules.neuralNetworkModel

Optional path to a directory with rules of a pretrained neural network model.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.additionalRules.word2VecModel

Optional path to a directory with rules of a word2vec language model.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.java.initialHeapSize

Initial size of the Java heap memory in megabytes (corresponds to Java’s -Xms option, must be a positive integer).

Decreasing this might decrease RAM usage of the Java process.

Changes require restarting LTEX to take effect.

Plugin default: 64

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.java.maximumHeapSize

Maximum size of the Java heap memory in megabytes (corresponds to Java’s -Xmx option, must be a positive integer).

Decreasing this might decrease RAM usage of the Java process. If you set this too small, the Java process may exceed the heap size, in which case an OutOfMemoryError is thrown.

Changes require restarting LTEX to take effect.

Plugin default: 512

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.java.path

If set to an empty string, LTEX uses a Java distribution that is bundled with ltex-ls. You can point this setting to an existing Java installation on your computer to use that installation instead.

Use the same path as you would use for the JAVA_HOME environment variable (it usually contains bin and lib subdirectories, amongst others).

Changes require restarting LTEX to take effect.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.languageToolOrg.apiKey

API key for Premium API access. Only relevant if settings.languageToolHttpServerUri is set.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.languageToolOrg.username

Username/email as used to log in at languagetool.org for Premium API access. Only relevant if settings.languageToolHttpServerUri is set.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.latex.commands

List of LATEX commands to be handled by the LATEX parser, listed together with empty arguments (e.g., "ref{}", "\documentclass[]{}").

This setting is an attrs with the commands as keys and corresponding actions as values.

If you edit the settings.json file directly, don’t forget to escape the initial backslash by replacing it with two backslashes.

Many common commands are already handled by default, even if you set this setting to an empty attrs.

Example:

  {
    "\\label{}" = "ignore";
    "\\documentclass[]{}" = "ignore";
    "\\cite{}" = "dummy";
    "\\cite[]{}" = "dummy";
  }

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.latex.environments

List of names of LATEX environments to be handled by the LATEX parser.

This setting is an attrs with the environment names as keys and corresponding actions as values.

Some environments are already handled by default, even if you set this setting to an empty attrs.

Example:

  {
    lstlisting = "ignore";
    verbatim = "ignore";
  }

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.ltex-ls.logLevel

Logging level (verbosity) of the ltex-ls server log.

The levels in descending order are “severe”, “warning”, “info”, “config”, “fine”, “finer”, and “finest”. All messages that have the specified log level or a higher level are logged.

ltex-ls does not use all log levels.

Possible values:

  • “severe”: Minimum verbosity. Only log severe errors.
  • “warning”: Very low verbosity. Only log severe errors and warnings.
  • “info”: Low verbosity. Additionally, log startup and shutdown messages.
  • “config”: Medium verbosity. Additionally, log configuration messages.
  • “fine”: Medium to high verbosity (default). Additionally, log when LanguageTool is called or LanguageTool has to be reinitialized due to changed settings.
  • “finer”: High verbosity. Log additional debugging information such as full texts to be checked.
  • “finest”: Maximum verbosity. Log all available debugging information.

Plugin default: "fine"

Type: null or one of “severe”, “warning”, “info”, “config”, “fine”, “finer”, “finest” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.ltex-ls.path

If set to an empty string, LTEX automatically downloads ltex-ls from GitHub, stores it in the folder of the extension, and uses it for the checking process. You can point this setting to an ltex-ls release you downloaded by yourself.

Use the path to the root directory of ltex-ls (it contains bin and lib subdirectories).

Changes require restarting LTEX to take effect.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.markdown.nodes

List of Markdown node types to be handled by the Markdown parser.

This setting is an attrs with the node types as keys and corresponding actions as values.

The Markdown parser constructs an AST (abstract syntax tree) for the Markdown document, in which all leaves have node type Text. The possible node types are listed in the documentation of flexmark-java.

Some common node types are already handled by default, even if you set this setting to an empty attrs.

Example:

  {
    CodeBlock = "ignore";
    FencedCodeBlock = "ignore";
    AutoLink = "dummy";
    Code = "dummy";
  }

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.ltex.settings.trace.server

Debug setting to log the communication between language client and server.

When reporting issues, set this to “verbose”. Append the relevant part to the GitHub issue.

Changes require restarting LTEX to take effect.

Possible values:

  • “off”: Don’t log any of the communication between language client and server.
  • “messages”: Log the type of requests and responses between language client and server.
  • “verbose”: Log the type and contents of requests and responses between language client and server.

Plugin default: "off"

Type: null or one of “off”, “messages”, “verbose” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.enable

Whether to enable lua-ls for Lua.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.lua-ls.package

Which package to use for lua-ls.

Type: null or package

Default: <derivation lua-language-server-3.9.1>

Declared by:

plugins.lsp.servers.lua-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lua-ls.extraOptions

Extra options for the lua-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.lua-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.lua-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.lua-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.lua-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.lua-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.lua-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.lua-ls.settings.addonManager.enable

Set the on/off state of the addon manager. Disabling the addon manager prevents it from registering its command.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.enable

Enable/disable completion. Completion works like any autocompletion you already know of. It helps you type less and get more done.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.autoRequire

When the input looks like a file name, automatically require the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.callSnippet

  • "Disable" - Only show function name
  • "Both" - Show function name and snippet
  • "Replace" - Only show the call snippet

Whether to show call snippets or not. When disabled, only the function name will be completed. When enabled, a “more complete” snippet will be offered.

Plugin default: "Disable"

Type: null or one of “Disable”, “Both”, “Replace” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.displayContext

When a snippet is being suggested, this setting will set the amount of lines around the snippet to preview to help you better understand its usage.

Setting to 0 will disable this feature.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.keywordSnippet

  • "Disable" - Only completes the keyword
  • "Both" - Offers a completion for the keyword and snippet
  • "Replace" - Only shows a snippet

Whether to show a snippet for key words like if, while, etc. When disabled, only the keyword will be completed. When enabled, a “more complete” snippet will be offered.

Plugin default: "Replace"

Type: null or one of “Disable”, “Both”, “Replace” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.postfix

The character to use for triggering a “postfix suggestion”. A postfix allows you to write some code and then trigger a snippet after (post) to “fix” the code you have written. This can save some time as instead of typing table.insert(myTable, ), you can just type myTable@.

Plugin default: "@"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.requireSeparator

The separator to use when require-ing a file.

Plugin default: "."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.showParams

Display a function’s parameters in the list of completions. When a function has multiple definitions, they will be displayed separately.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.showWord

  • "Enable" - Always show contextual words in completion suggestions
  • "Fallback" - Only show contextual words when smart suggestions based on semantics cannot be provided
  • "Disable" - Never show contextual words

Show “contextual words” that have to do with Lua but are not suggested based on their usefulness in the current semantic context.

Plugin default: "Fallback"

Type: null or one of “Enable”, “Fallback”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.completion.workspaceWord

Whether words from other files in the workspace should be suggested as “contextual words”. This can be useful for completing similar strings. completion.showWord must not be disabled for this to have an effect.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.enable

Whether all diagnostics should be enabled or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.disable

Disable certain diagnostics globally. For example, if you want all warnings for lowercase-global to be disabled, the value for diagnostics.disable would be ["lowercase-global"].

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.disableScheme

Disable diagnosis of Lua files that have the set schemes.

Plugin default:

[
  "git"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.globals

An array of variable names that will be declared as global.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.groupFileStatus

Set the file status required for each diagnostic group. This setting is an Object of key-value pairs where the key is the name of the diagnostic group and the value is the state that a file must be in in order for the diagnostic group to apply.

Valid state values:

  • "Any" - Any loaded file (workspace, library, etc.) will use this diagnostic group
  • "Opened" - Only opened files will use this diagnostic group
  • "None" - This diagnostic group will be disabled
  • "Fallback" - The diagnostics in this group are controlled individually by diagnostics.neededFileStatus

Plugin default:

{
  ambiguity = "Fallback";
  await = "Fallback";
  codestyle = "Fallback";
  duplicate = "Fallback";
  global = "Fallback";
  luadoc = "Fallback";
  redefined = "Fallback";
  strict = "Fallback";
  strong = "Fallback";
  type-check = "Fallback";
  unbalanced = "Fallback";
  unused = "Fallback";
}

Type: null or (attribute set of (one of “Any”, “Opened”, “None”, “Fallback” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.groupSeverity

Maps diagnostic groups to severity levels.

Valid severity values:

  • "Error" - An error will be raised
  • "Warning" - A warning will be raised
  • "Information" - An information or note will be raised
  • "Hint" - The affected code will be “hinted” at
  • "Fallback" - The diagnostics in this group will be controlled individually by diagnostics.severity

Plugin default:

{
  ambiguity = "Fallback";
  await = "Fallback";
  codestyle = "Fallback";
  duplicate = "Fallback";
  global = "Fallback";
  luadoc = "Fallback";
  redefined = "Fallback";
  strict = "Fallback";
  strong = "Fallback";
  type-check = "Fallback";
  unbalanced = "Fallback";
  unused = "Fallback";
}

Type: null or (attribute set of (one of “Error”, “Warning”, “Information”, “Hint”, “Fallback” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.ignoredFiles

Set how files that have been ignored should be diagnosed.

  • "Enable" - Always diagnose ignored files… kind of defeats the purpose of ignoring them.
  • "Opened" - Only diagnose ignored files when they are open
  • "Disable" - Ignored files are fully ignored

Plugin default: "Opened"

Type: null or one of “Enable”, “Opened”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.libraryFiles

Set how files loaded with workspace.library are diagnosed.

  • "Enable" - Always diagnose library files
  • "Opened" - Only diagnose library files when they are open
  • "Disable" - Never diagnose library files

Plugin default: "Opened"

Type: null or one of “Enable”, “Opened”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.neededFileStatus

Maps diagnostic groups to file states.

Valid states:

  • "Any" - Any loaded file (workspace, library, etc.) will use this diagnostic group
  • "Opened" - Only opened files will use this diagnostic group
  • "None" - This diagnostic group will be disabled
  • "Any!" - Like "Any" but overrides diagnostics.groupFileStatus
  • "Opened!" - Like "Opened" but overrides diagnostics.groupFileStatus
  • "None!" - Like "None" but overrides diagnostics.groupFileStatus

Plugin default:

{
  ambiguity-1 = "Any";
  assign-type-mismatch = "Opened";
  await-in-sync = "None";
  cast-local-type = "Opened";
  cast-type-mismatch = "Any";
  circle-doc-class = "Any";
  close-non-object = "Any";
  code-after-break = "Opened";
  codestyle-check = "None";
  count-down-loop = "Any";
  deprecated = "Any";
  different-requires = "Any";
  discard-returns = "Any";
  doc-field-no-class = "Any";
  duplicate-doc-alias = "Any";
  duplicate-doc-field = "Any";
  duplicate-doc-param = "Any";
  duplicate-index = "Any";
  duplicate-set-field = "Any";
  empty-block = "Opened";
  global-in-nil-env = "Any";
  lowercase-global = "Any";
  missing-parameter = "Any";
  missing-return = "Any";
  missing-return-value = "Any";
  need-check-nil = "Opened";
  newfield-call = "Any";
  newline-call = "Any";
  no-unknown = "None";
  not-yieldable = "None";
  param-type-mismatch = "Opened";
  redefined-local = "Opened";
  redundant-parameter = "Any";
  redundant-return = "Opened";
  redundant-return-value = "Any";
  redundant-value = "Any";
  return-type-mismatch = "Opened";
  spell-check = "None";
  trailing-space = "Opened";
  unbalanced-assignments = "Any";
  undefined-doc-class = "Any";
  undefined-doc-name = "Any";
  undefined-doc-param = "Any";
  undefined-env-child = "Any";
  undefined-field = "Opened";
  undefined-global = "Any";
  unknown-cast-variable = "Any";
  unknown-diag-code = "Any";
  unknown-operator = "Any";
  unreachable-code = "Opened";
  unused-function = "Opened";
  unused-label = "Opened";
  unused-local = "Opened";
  unused-vararg = "Opened";
}

Type: null or (attribute set of (one of “Any”, “Opened”, “None”, “Any!”, “Opened!”, “None!” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.severity

Maps diagnostic groups to severity levels.

  • "Error" - An error will be raised
  • "Warning" - A warning will be raised
  • "Information" - An information or note will be raised
  • "Hint" - The affected code will be “hinted” at
  • "Error!" - Like "Error" but overrides diagnostics.groupSeverity
  • "Warning!" -Like "Warning" but overrides diagnostics.groupSeverity
  • "Information!" - Like "Information" but overrides diagnostics.groupSeverity
  • "Hint!" - Like "Hint" but overrides diagnostics.groupSeverity

Plugin default:

{
  ambiguity-1 = "Warning";
  assign-type-mismatch = "Warning";
  await-in-sync = "Warning";
  cast-local-type = "Warning";
  cast-type-mismatch = "Warning";
  circle-doc-class = "Warning";
  close-non-object = "Warning";
  code-after-break = "Hint";
  codestyle-check = "Warning";
  count-down-loop = "Warning";
  deprecated = "Warning";
  different-requires = "Warning";
  discard-returns = "Warning";
  doc-field-no-class = "Warning";
  duplicate-doc-alias = "Warning";
  duplicate-doc-field = "Warning";
  duplicate-doc-param = "Warning";
  duplicate-index = "Warning";
  duplicate-set-field = "Warning";
  empty-block = "Hint";
  global-in-nil-env = "Warning";
  lowercase-global = "Information";
  missing-parameter = "Warning";
  missing-return = "Warning";
  missing-return-value = "Warning";
  need-check-nil = "Warning";
  newfield-call = "Warning";
  newline-call = "Warning";
  no-unknown = "Warning";
  not-yieldable = "Warning";
  param-type-mismatch = "Warning";
  redefined-local = "Hint";
  redundant-parameter = "Warning";
  redundant-return = "Hint";
  redundant-return-value = "Warning";
  redundant-value = "Warning";
  return-type-mismatch = "Warning";
  spell-check = "Information";
  trailing-space = "Hint";
  unbalanced-assignments = "Warning";
  undefined-doc-class = "Warning";
  undefined-doc-name = "Warning";
  undefined-doc-param = "Warning";
  undefined-env-child = "Information";
  undefined-field = "Warning";
  undefined-global = "Warning";
  unknown-cast-variable = "Warning";
  unknown-diag-code = "Warning";
  unknown-operator = "Warning";
  unreachable-code = "Hint";
  unused-function = "Hint";
  unused-label = "Hint";
  unused-local = "Hint";
  unused-vararg = "Hint";
}

Type: null or (attribute set of (one of “Error”, “Warning”, “Information”, “Hint”, “Error!”, “Warning!”, “Information!”, “Hint!” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.unusedLocalExclude

Define variable names that will not be reported as an unused local by unused-local.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.workspaceDelay

Define the delay between diagnoses of the workspace in milliseconds. Every time a file is edited, created, deleted, etc. the workspace will be re-diagnosed in the background after this delay. Setting to a negative number will disable workspace diagnostics.

Plugin default: 3000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.workspaceEvent

Set when the workspace diagnostics should be analyzed. It can be performed after each change, after a save, or never automatically triggered.

Valid events:

  • "OnChange"
  • "OnSave"
  • "None"

Plugin default: "OnSave"

Type: null or one of “OnChange”, “OnSave”, “None” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.diagnostics.workspaceRate

Define the rate at which the workspace will be diagnosed as a percentage. 100 is 100% speed so the workspace will be diagnosed as fast as possible. The rate can be lowered to reduce CPU usage, but the diagnosis speed will also become slower. The currently opened file will always be diagnosed at 100% speed, regardless of this setting.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.doc.packageName

The pattern used for matching field names as a package-private field. Fields that match any of the patterns provided will be package-private.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.doc.privateName

The pattern used for matching field names as a private field. Fields that match any of the patterns provided will be private to that class.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.doc.protectedName

The pattern used for matching field names as a protected field. Fields that match any of the patterns provided will be private to that class and its child classes.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.format.enable

Whether the built-in formatted should be enabled or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.format.defaultConfig

The default configuration for the formatter. If there is a .editorconfig in the workspace, it will take priority. Read more on the formatter’s GitHub page.

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.enable

Whether inline hints should be enabled or not.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.arrayIndex

  • "Enable" - Show hint in all tables
  • "Auto" - Only show hint when there is more than 3 items or the table is mixed (indexes and keys)
  • "Disable" - Disable array index hints

Plugin default: "Auto"

Type: null or one of “Enable”, “Auto”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.await

If a function has been defined as @async, display an await hint when it is being called.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.paramName

Whether parameter names should be hinted when typing out a function call.

  • "All" - All parameters are hinted
  • "Literal" - Only literal type parameters are hinted
  • "Disable" - No parameter hints are shown

Plugin default: "All"

Type: null or one of “All”, “Literal”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.paramType

Show a hint for parameter types at a function definition. Requires the parameters to be defined with @param.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.semicolon

Whether to show a hint to add a semicolon to the end of a statement.

  • "All" - Show on every line
  • "SameLine" - Show between two statements on one line
  • "Disable" - Never hint a semicolon

Plugin default: "SameLine"

Type: null or one of “All”, “SameLine”, “Disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hint.setType

Show a hint to display the type being applied at assignment operations.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.enable

Whether to enable hover tooltips or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.enumsLimit

When a value has multiple possible types, hovering it will display them. This setting limits how many will be displayed in the tooltip before they are truncated.

Plugin default: 5

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.expandAlias

When hovering a value with an @alias for its type, should the alias be expanded into its values. When enabled, ---@alias myType boolean|number appears as boolean|number, otherwise it will appear as myType.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.previewFields

When a table is hovered, its fields will be displayed in the tooltip. This setting limits how many fields can be seen in the tooltip. Setting to 0 will disable this feature.

Plugin default: 50

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.viewNumber

Enable hovering a non-decimal value to see its numeric value.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.viewString

Enable hovering a string that contains an escape character to see its true string value. For example, hovering "\x48" will display "H".

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.hover.viewStringMax

The maximum number of characters that can be previewed by hovering a string before it is truncated.

Plugin default: 1000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.misc.executablePath

Manually specify the path for the Lua Language Server executable file.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.misc.parameters

Command line parameters to be passed along to the server exe when starting through Visual Studio Code.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.builtin

Set whether each of the builtin Lua libraries is available in the current runtime environment.

Valid library options:

  • "basic"
  • "bit"
  • "bit32"
  • "builtin"
  • "coroutine"
  • "debug"
  • "ffi"
  • "io"
  • "jit"
  • "math"
  • "os"
  • "package"
  • "string"
  • "table"
  • "table.clear"
  • "table.new"
  • "utf8"

Valid status values:

  • "default" - The library will be enabled if it is a part of the current runtime.version.
  • "enable" - Always enable this library
  • "disable" - Always disable this library

Plugin default:

{
  basic = "default";
  bit = "default";
  bit32 = "default";
  builtin = "default";
  coroutine = "default";
  debug = "default";
  ffi = "default";
  io = "default";
  jit = "default";
  math = "default";
  os = "default";
  package = "default";
  string = "default";
  table = "default";
  "table.clear" = "default";
  "table.new" = "default";
  utf8 = "default";
}

Type: null or (attribute set of (one of “default”, “enable”, “disable” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.fileEncoding

  • "utf8"
  • "ansi" (only available on Windows)
  • "utf16le"
  • "utf16be"

Plugin default: "utf8"

Type: null or one of “utf8”, “ansi”, “utf16le”, “utf16be” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.meta

Specify the template that should be used for naming the folders that contain the generated definitions for the various Lua versions, languages, and encodings.

Plugin default: "\${version} \${language} \${encoding}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.nonstandardSymbol

Add support for non-standard symbols. Make sure to double check that your runtime environment actually supports the symbols you are permitting as standard Lua does not.

Plugin default: [ ]

Type: null or (list of (one of “//”, “/**/”, “`”, “+=”, “-=”, “*=”, “/=”, “%=”, “^=”, “//=”, “|=”, “&=”, “<<=”, “>>=”, “||”, “&&”, “!”, “!=”, “continue” or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.path

Defines the paths to use when using require. For example, setting to ?/start.lua will search for <workspace>/myFile/start.lua from the loaded files when doing require"myFile". If runtime.pathStrict is false, <workspace>/**/myFile/start.lua will also be searched. To load files that are not in the current workspace, they will first need to be loaded using workspace.library.

Plugin default:

[
  "?.lua"
  "?/init.lua"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.pathStrict

When enabled, runtime.path will only search the first level of directories. See the description of runtime.path for more info.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.plugin

The path to the plugin to use. Blank by default for security reasons.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.pluginArgs

Additional arguments that will be passed to the active plugin.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.special

Special variables can be set to be treated as other variables. For example, specifying "include" : "require" will result in include being treated like require.

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.unicodeName

Whether unicode characters should be allowed in variable names or not.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.runtime.version

The Lua runtime version to use in this environment.

Plugin default: "Lua 5.4"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.semantic.enable

Whether semantic colouring should be enabled. You may need to set editor.semanticHighlighting.enabled to true in order for this setting to take effect.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.semantic.annotation

Whether semantic colouring should be enabled for type annotations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.semantic.keyword

Whether the server should provide semantic colouring of keywords, literals, and operators. You should only need to enable this setting if your editor is unable to highlight Lua’s syntax.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.semantic.variable

Whether the server should provide semantic colouring of variables, fields, and parameters.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.signatureHelp.enable

The signatureHelp group contains settings for helping understand signatures.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.spell.dict

A custom dictionary of words that you know are spelt correctly but are being reported as incorrect. Adding words to this dictionary will make them exempt from spell checking.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.telemetry.enable

The language server comes with opt-in telemetry to help improve the language server. It would be greatly appreciated if you enable this setting. Read the privacy policy before enabling.

Plugin default: null

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.type.castNumberToInteger

Whether casting a number to an integer is allowed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.type.weakNilCheck

Whether it is permitted to assign a union type that contains nil to a variable that does not permit it. When false, the following will throw an error because number|nil cannot be assigned to number.

  ---@alias unionType number|nil

  ---@type number
  local num

  ---@cast num unionType

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.type.weakUnionCheck

Whether it is permitted to assign a union type which only has one matching type to a variable. When false, the following will throw an error because string|boolean cannot be assigned to string.

  ---@alias unionType string|boolean

  ---@type string
  local str = false

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.window.progressBar

Show a progress bar in the bottom status bar that shows how the workspace loading is progressing.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.window.statusBar

Show a Lua 😺 entry in the bottom status bar that can be clicked to manually perform a workspace diagnosis.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.checkThirdParty

Whether third party libraries can be automatically detected and applied. Third party libraries can set up the environment to be as close as possible to your target runtime environment. See meta/3rd to view what third party libraries are currently supported.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.ignoreDir

An array of paths that will be ignored and not included in the workspace diagnosis. Uses .gitignore grammar. Can be a file or directory.

Plugin default:

[
  ".vscode"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.ignoreSubmodules

Whether git submodules should be ignored and not included in the workspace diagnosis.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.library

An array of abosolute or workspace-relative paths that will be added to the workspace diagnosis - meaning you will get completion and context from these library files. Can be a file or directory. Files included here will have some features disabled such as renaming fields to prevent accidentally renaming your library files. Read more on the Libraries page.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.maxPreload

The maximum amount of files that can be diagnosed. More files will require more RAM.

Plugin default: 5000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.preloadFileSize

Files larger than this value (in KB) will be skipped when loading for workspace diagnosis.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.supportScheme

Lua file schemes to enable the language server for.

Plugin default:

[
  "file"
  "untitled"
  "git"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.useGitIgnore

Whether files that are in .gitignore should be ignored by the language server when performing workspace diagnosis.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.lua-ls.settings.workspace.userThirdParty

An array of paths to custom third party libraries. This path should point to a directory where all of your custom libraries are, not just to one of the libraries. If the below is your file structure, this setting should be "myLuaLibraries" - of course this should be an absolute path though.

📦 myLuaLibraries/
    ├── 📂 myCustomLibrary/
    │   ├── 📂 library/
    │   └── 📜 config.lua
    └── 📂 anotherCustomLibrary/
        ├── 📂 library/
        └── 📜 config.lua

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.marksman.enable

Whether to enable marksman for Markdown.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.marksman.package

Which package to use for marksman.

Type: null or package

Default: <derivation marksman-2023-12-09>

Declared by:

plugins.lsp.servers.marksman.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.marksman.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.marksman.extraOptions

Extra options for the marksman language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.marksman.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.marksman.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.marksman.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.marksman.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.marksman.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.marksman.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.metals.enable

Whether to enable metals for Scala.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.metals.package

Which package to use for metals.

Type: null or package

Default: <derivation metals-1.3.1>

Declared by:

plugins.lsp.servers.metals.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.metals.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.metals.extraOptions

Extra options for the metals language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.metals.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.metals.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.metals.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.metals.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.metals.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.metals.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.nginx-language-server.enable

Whether to enable nginx-language-server for nginx.conf.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.nginx-language-server.package

Which package to use for nginx-language-server.

Type: null or package

Default: <derivation nginx-language-server-0.8.0>

Declared by:

plugins.lsp.servers.nginx-language-server.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nginx-language-server.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nginx-language-server.extraOptions

Extra options for the nginx-language-server language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.nginx-language-server.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nginx-language-server.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.nginx-language-server.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.nginx-language-server.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.nginx-language-server.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.nginx-language-server.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.nil-ls.enable

Whether to enable nil for Nix.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.nil-ls.package

Which package to use for nil-ls.

Type: null or package

Default: <derivation nil-2023-08-09>

Declared by:

plugins.lsp.servers.nil-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nil-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nil-ls.extraOptions

Extra options for the nil-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.nil-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nil-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.nil-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.nil-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.nil-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.nil-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.nil-ls.settings.diagnostics.excludedFiles

Files to exclude from showing diagnostics. Useful for generated files.

It accepts an array of paths. Relative paths are joint to the workspace root. Glob patterns are currently not supported.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Example:

[
  "Cargo.nix"
]

Declared by:

plugins.lsp.servers.nil-ls.settings.diagnostics.ignored

Ignored diagnostic kinds. The kind identifier is a snake_cased_string usually shown together with the diagnostic message.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.nil-ls.settings.formatting.command

External formatting command, complete with required arguments.

It should accept file content from stdin and print the formatted code to stdout.

Plugin default: null

Type: null or (list of (string or raw lua code))

Default: null

Example:

[
  "nixpkgs-fmt"
]

Declared by:

plugins.lsp.servers.nil-ls.settings.nix.binary

The path to the nix binary.

Plugin default: "nix"

Type: null or string or raw lua code

Default: null

Example: "/run/current-system/sw/bin/nix"

Declared by:

plugins.lsp.servers.nil-ls.settings.nix.maxMemoryMB

The heap memory limit in MiB for nix evaluation.

Currently it only applies to flake evaluation when autoEvalInputs is enabled, and only works for Linux. Other nix invocations may be also applied in the future. null means no limit.

As a reference, nix flake show --legacy nixpkgs usually requires about 2GiB memory.

Plugin default: 2560

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Example: 1024

Declared by:

plugins.lsp.servers.nil-ls.settings.nix.flake.autoArchive

Auto-archiving behavior which may use network.

  • null: Ask every time.
  • true: Automatically run nix flake archive when necessary.
  • false: Do not archive. Only load inputs that are already on disk.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nil-ls.settings.nix.flake.autoEvalInputs

Whether to auto-eval flake inputs. The evaluation result is used to improve completion, but may cost lots of time and/or memory.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nil-ls.settings.nix.flake.nixpkgsInputName

The input name of nixpkgs for NixOS options evaluation.

The options hierarchy is used to improve completion, but may cost lots of time and/or memory.

If this value is null or is not found in the workspace flake’s inputs, NixOS options are not evaluated.

Plugin default: "nixpkgs"

Type: null or string or raw lua code

Default: null

Example: "nixos"

Declared by:

plugins.lsp.servers.nimls.enable

Whether to enable nimls for Nim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.nimls.package

Which package to use for nimls.

Type: null or package

Default: <derivation nimlsp-0.4.6>

Declared by:

plugins.lsp.servers.nimls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nimls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nimls.extraOptions

Extra options for the nimls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.nimls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nimls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.nimls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.nimls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.nimls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.nimls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.nixd.enable

Whether to enable nixd for Nix.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.nixd.package

Which package to use for nixd.

Type: null or package

Default: <derivation nixd-2.1.2>

Declared by:

plugins.lsp.servers.nixd.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nixd.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nixd.extraOptions

Extra options for the nixd language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.nixd.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nixd.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.nixd.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.nixd.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.nixd.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.nixd.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.nixd.settings.nixpkgs

This expression will be interpreted as “nixpkgs” toplevel Nixd provides package, lib completion/information from it.

Type: null or (submodule) or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nixd.settings.options

Tell the language server your desired option set, for completion. This is lazily evaluated.

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.nixd.settings.formatting.command

Which command you would like to do formatting. Explicitly set to ["nixpkgs-fmt"] will automatically add pkgs.nixpkgs-fmt to the nixvim environment.

Plugin default: [ "nixpkgs-fmt" ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.nushell.enable

Whether to enable Nushell language server.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.nushell.package

Which package to use for nushell.

Type: null or package

Default: <derivation nushell-0.93.0>

Declared by:

plugins.lsp.servers.nushell.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.nushell.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/j0055k1rv5hi78pnx7ymnsrgjdv14ypi-nushell-0.93.0/bin/nu"
  "--lsp"
]

Declared by:

plugins.lsp.servers.nushell.extraOptions

Extra options for the nushell language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.nushell.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.nushell.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.nushell.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.nushell.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.nushell.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.nushell.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ocamllsp.enable

Whether to enable ocamllsp for OCaml.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ocamllsp.package

Which package to use for ocamllsp.

Type: null or package

Default: <derivation ocaml5.1.1-ocaml-lsp-server-1.17.0>

Declared by:

plugins.lsp.servers.ocamllsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ocamllsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ocamllsp.extraOptions

Extra options for the ocamllsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ocamllsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ocamllsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ocamllsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ocamllsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ocamllsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ocamllsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ols.enable

Whether to enable ols for the Odin programming language.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ols.package

Which package to use for ols.

Type: null or package

Default: <derivation ols-0-unstable-2024-05-11>

Declared by:

plugins.lsp.servers.ols.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ols.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ols.extraOptions

Extra options for the ols language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ols.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ols.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ols.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ols.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ols.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ols.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.omnisharp.enable

Whether to enable OmniSharp language server for C#.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.omnisharp.package

Which package to use for omnisharp.

Type: null or package

Default: <derivation omnisharp-roslyn-1.39.11>

Declared by:

plugins.lsp.servers.omnisharp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.cmd

This option has no description.

Type: null or (list of string)

Default:

[
  "/nix/store/d026mgq5i3p00gmf8v2w19wjvw2xx89j-omnisharp-roslyn-1.39.11/bin/OmniSharp"
]

Declared by:

plugins.lsp.servers.omnisharp.extraOptions

Extra options for the omnisharp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.omnisharp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.omnisharp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.omnisharp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.omnisharp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.omnisharp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.omnisharp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.omnisharp.settings.enableEditorConfigSupport

Enables support for reading code style, naming convention and analyzer settings from .editorconfig.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.enableImportCompletion

Enables support for showing unimported types and unimported extension methods in completion lists. When committed, the appropriate using directive will be added at the top of the current file. This option can have a negative impact on initial completion responsiveness, particularly for the first few completion sessions after opening a solution.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.enableMsBuildLoadProjectsOnDemand

If true, MSBuild project system will only load projects for files that were opened in the editor. This setting is useful for big C# codebases and allows for faster initialization of code navigation features only for projects that are relevant to code that is being edited. With this setting enabled OmniSharp may load fewer projects and may thus display incomplete reference lists for symbols.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.enableRoslynAnalyzers

If true, MSBuild project system will only load projects for files that were opened in the editor. This setting is useful for big C# codebases and allows for faster initialization of code navigation features only for projects that are relevant to code that is being edited. With this setting enabled OmniSharp may load fewer projects and may thus display incomplete reference lists for symbols.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.analyzeOpenDocumentsOnly

Only run analyzers against open files when ‘enableRoslynAnalyzers’ is true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.organizeImportsOnFormat

Specifies whether ‘using’ directives should be grouped and sorted during document formatting.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.omnisharp.settings.sdkIncludePrereleases

Specifies whether to include preview versions of the .NET SDK when determining which version to use for project loading.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.perlpls.enable

Whether to enable PLS for Perl.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.perlpls.package

Which package to use for perlpls.

Type: null or package

Default: <derivation perl5.38.2-PLS-0.905>

Declared by:

plugins.lsp.servers.perlpls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.perlpls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.perlpls.extraOptions

Extra options for the perlpls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.perlpls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.perlpls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.perlpls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.perlpls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.perlpls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.perlpls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.pest-ls.enable

Whether to enable pest_ls for pest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.pest-ls.package

Which package to use for pest-ls.

Type: null or package

Default: <derivation pest-ide-tools-0.3.9>

Declared by:

plugins.lsp.servers.pest-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pest-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pest-ls.extraOptions

Extra options for the pest-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.pest-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pest-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.pest-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.pest-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.pest-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.pest-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.phpactor.enable

Whether to enable phpactor for PHP.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.phpactor.package

Which package to use for phpactor.

Type: null or package

Default: <derivation phpactor-2024.03.09.0>

Declared by:

plugins.lsp.servers.phpactor.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.phpactor.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.phpactor.extraOptions

Extra options for the phpactor language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.phpactor.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.phpactor.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.phpactor.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.phpactor.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.phpactor.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.phpactor.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.prismals.enable

Whether to enable prismals for Prisma.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.prismals.package

Which package to use for prismals.

Type: null or package

Default: <derivation _at_prisma_slash_language-server-5.11.0>

Declared by:

plugins.lsp.servers.prismals.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.prismals.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.prismals.extraOptions

Extra options for the prismals language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.prismals.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.prismals.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.prismals.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.prismals.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.prismals.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.prismals.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.prolog-ls.enable

Whether to enable prolog_ls for SWI-Prolog.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.prolog-ls.package

Which package to use for prolog-ls.

Type: null or package

Default: <derivation swi-prolog-9.1.21>

Declared by:

plugins.lsp.servers.prolog-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.prolog-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.prolog-ls.extraOptions

Extra options for the prolog-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.prolog-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.prolog-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.prolog-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.prolog-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.prolog-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.prolog-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.purescriptls.enable

Whether to enable purescriptls for PureScript.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.purescriptls.package

Which package to use for purescriptls.

Type: null or package

Default: <derivation purescript-language-server-0.18.0>

Declared by:

plugins.lsp.servers.purescriptls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.purescriptls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.purescriptls.extraOptions

Extra options for the purescriptls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.purescriptls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.purescriptls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.purescriptls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.purescriptls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.purescriptls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.purescriptls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.pylsp.enable

Whether to enable pylsp for Python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.pylsp.package

Which package to use for pylsp.

Type: null or package

Default: <derivation python3.11-python-lsp-server-1.11.0>

Declared by:

plugins.lsp.servers.pylsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.extraOptions

Extra options for the pylsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.pylsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.pylsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.pylsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.pylsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.pylsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.pylsp.settings.configurationSources

List of configuration sources to use.

Type: null or one of “pycodestyle”, “flake8”

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.autopep8.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (autopep8).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.black.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (python-lsp-black).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.black.cache_config

Whether to enable black configuration caching.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.black.line_length

An integer that maps to black’s max-line-length setting. Defaults to 88 (same as black’s default). This can also be set through black’s configuration files, which should be preferred for multi-user projects.

Plugin default: 88

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.black.preview

Enable or disable black’s --preview setting.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (flake8).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.config

Path to the config file that will be the authoritative config source.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.exclude

List of files or directories to exclude.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.executable

Path to the flake8 executable.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.filename

Only check for filenames matching the patterns in this list.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.hangClosing

Hang closing bracket instead of matching indentation of opening bracket’s line.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.ignore

List of errors and warnings to ignore (or skip).

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.indentSize

Set indentation spaces.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.maxComplexity

Maximum allowed complexity threshold.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.maxLineLength

Maximum allowed line length for the entirety of this run.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.perFileIgnores

A pairing of filenames and violation codes that defines which violations to ignore in a particular file.

For example: ["file_path.py:W305,W304"].

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.flake8.select

List of errors and warnings to enable.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.isort.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pyls-isort).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi.auto_import_modules

List of module names for jedi.settings.auto_import_modules.

Plugin default: [ "numpy" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi.environment

Define environment for jedi.Script and Jedi.names.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi.extra_paths

Define extra paths for jedi.Script.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.cache_for

Modules for which labels and snippets should be cached.

Plugin default: [ "pandas" "numpy" "tensorflow" "matplotlib" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.eager

Resolve documentation and detail eagerly.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.fuzzy

Enable fuzzy when requesting autocomplete.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_class_objects

Adds class objects as a separate completion item.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_function_objects

Adds function objects as a separate completion item.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_params

Auto-completes methods and classes with tabstops for each parameter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.resolve_at_most

How many labels and snippets (at most) should be resolved.

Plugin default: 25

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_builtin_definitions

Follow builtin and extension definitions to stubs.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_builtin_imports

If follow_imports is true will decide if it follow builtin imports.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_imports

The goto call will follow imports.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_hover.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_references.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_signature_help.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.all_scopes

If true lists the names of all scopes instead of only the module namespace.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.include_import_symbols

If true includes symbols imported from other libraries.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.mccabe.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (mccabe).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.mccabe.threshold

The minimum threshold that triggers warnings about cyclomatic complexity.

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.memestra.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pyls-memestra).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.preload.enabled

Enable or disable the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.preload.modules

List of modules to import on startup.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pycodestyle).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.exclude

Exclude files or directories which match these patterns.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.filename

When parsing directories, only check filenames matching these patterns.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.hangClosing

Hang closing bracket instead of matching indentation of opening bracket’s line.

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.ignore

Ignore errors and warnings.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.indentSize

Set indentation spaces.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.maxLineLength

Set maximum allowed line length.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.ropeFolder

Select errors and warnings.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pydocstyle).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.addIgnore

Ignore errors and warnings in addition to the specified convention.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.addSelect

Select errors and warnings in addition to the specified convention.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.convention

Choose the basic list of checked errors by specifying an existing convention.

Type: null or one of “pep257”, “numpy”, “google”, “None”

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.ignore

Ignore errors and warnings.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.match

Check only files that exactly match the given regular expression; default is to match files that don’t start with ‘test_’ but end with ‘.py’.

Plugin default: "(?!test_).*\\.py"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.matchDir

Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot.

Plugin default: "[^\\.].*"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.select

Select errors and warnings.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pyflakes.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pyflakes).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylint.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pylint).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylint.args

Arguments to pass to pylint.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylint.executable

Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pylsp-mypy).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.config_sub_paths

Specifies sub paths under which the mypy configuration file may be found. For each directory searched for the mypy config file, this also searches the sub paths specified here.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.dmypy

Executes via dmypy run rather than mypy. This uses the dmypy daemon and may dramatically improve the responsiveness of the pylsp server, however this currently does not work in live_mode. Enabling this disables live_mode, even for conflicting configs.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.dmypy_status_file

Specifies which status file dmypy should use. This modifies the --status-file option passed to dmypy given dmypy is active.

Plugin default: ".dmypy.json"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.live_mode

Provides type checking as you type. This writes to a tempfile every time a check is done. Turning off live_mode means you must save your changes for mypy diagnostics to update correctly.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.overrides

Specifies a list of alternate or supplemental command-line options. This modifies the options passed to mypy or the mypy-specific ones passed to dmypy run. When present, the special boolean member true is replaced with the command-line options that would’ve been passed had overrides not been specified. Later options take precedence, which allows for replacing or negating individual default options (see mypy.main:process_options and mypy --help | grep inverse).

Plugin default: [true]

Type: null or (list of (boolean or string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.report_progress

Report basic progress to the LSP client. With this option, pylsp-mypy will report when mypy is running, given your editor supports LSP progress reporting. For small files this might produce annoying flashing in your editor, especially in with live_mode. For large projects, enabling this can be helpful to assure yourself whether mypy is still running.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.strict

Refers to the strict option of mypy. This option often is too strict to be useful.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.rope.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (pylsp-rope).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.rope_autoimport.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (rope).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.rope_autoimport.memory

Make the autoimport database memory only. Drastically increases startup time.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.rope_completion.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (rope).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.rope_completion.eager

Resolve documentation and detail eagerly.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (python-lsp-ruff).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.config

Path to optional pyproject.toml file.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.exclude

Exclude files from being checked by ruff.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.executable

Path to the ruff executable. Assumed to be in PATH by default.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.extendIgnore

Same as ignore, but append to existing ignores.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.extendSelect

Same as select, but append to existing error codes.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.format

List of error codes to fix during formatting. The default is [“I”], any additional codes are appended to this list.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.ignore

Error codes to ignore.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.lineLength

Set the line-length for length checks.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.perFileIgnores

File-specific error codes to be ignored.

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.select

List of error codes to enable.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.yapf.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (yapf).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.rope.extensionModules

Builtin and c-extension modules that are allowed to be imported and inspected by rope.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.rope.ropeFolder

The name of the folder in which rope stores project configurations and data. Pass null for not using such a folder at all.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylyzer.enable

Whether to enable pylyzer for Python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.pylyzer.package

Which package to use for pylyzer.

Type: null or package

Default: <derivation pylyzer-0.0.54>

Declared by:

plugins.lsp.servers.pylyzer.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pylyzer.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylyzer.extraOptions

Extra options for the pylyzer language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.pylyzer.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pylyzer.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.pylyzer.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.pylyzer.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.pylyzer.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.pylyzer.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.pyright.enable

Whether to enable pyright for Python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.pyright.package

Which package to use for pyright.

Type: null or package

Default: <derivation pyright-1.1.362>

Declared by:

plugins.lsp.servers.pyright.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.pyright.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pyright.extraOptions

Extra options for the pyright language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.pyright.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.pyright.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.pyright.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.pyright.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.pyright.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.pyright.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.r-language-server.enable

Whether to enable languageserver for R.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.r-language-server.package

Which package to use for r-language-server.

Type: null or package

Default: <derivation r-languageserver-0.3.16>

Declared by:

plugins.lsp.servers.r-language-server.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.r-language-server.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.r-language-server.extraOptions

Extra options for the r-language-server language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.r-language-server.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.r-language-server.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.r-language-server.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.r-language-server.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.r-language-server.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.r-language-server.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.rnix-lsp.enable

Whether to enable rnix LSP for Nix.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.rnix-lsp.package

Which package to use for rnix-lsp.

Type: null or package

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.extraOptions

Extra options for the rnix-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.rnix-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.rnix-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.rnix-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.rnix-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ruby-lsp.enable

Whether to enable ruby-lsp for Ruby.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ruby-lsp.package

Which package to use for ruby-lsp.

Type: null or package

Default: <derivation ruby3.1-ruby-lsp-0.15.0>

Declared by:

plugins.lsp.servers.ruby-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ruby-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruby-lsp.extraOptions

Extra options for the ruby-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ruby-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruby-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ruby-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ruby-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ruby-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ruby-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ruff.enable

Whether to enable Official ruff language server (Rust) for Python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ruff.package

Which package to use for ruff.

Type: null or package

Default: <derivation ruff-0.4.4>

Declared by:

plugins.lsp.servers.ruff.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ruff.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruff.extraOptions

Extra options for the ruff language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ruff.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruff.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ruff.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ruff.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ruff.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ruff.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.ruff-lsp.enable

Whether to enable ruff-lsp, for Python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.ruff-lsp.package

Which package to use for ruff-lsp.

Type: null or package

Default: <derivation python3.11-ruff-lsp-0.0.53>

Declared by:

plugins.lsp.servers.ruff-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.ruff-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruff-lsp.extraOptions

Extra options for the ruff-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.ruff-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.ruff-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.ruff-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.ruff-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.ruff-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.ruff-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.rust-analyzer.enable

Whether to enable rust-analyzer for Rust.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.rust-analyzer.package

Which package to use for rust-analyzer.

Type: null or package

Default: <derivation rust-analyzer-2024-04-29>

Declared by:

plugins.lsp.servers.rust-analyzer.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.cargoPackage

Which package to use for cargo.

Type: package

Default: <derivation cargo-1.77.2>

Declared by:

plugins.lsp.servers.rust-analyzer.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.extraOptions

Extra options for the rust-analyzer language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.rust-analyzer.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.installCargo

Whether to install cargo.

Type: null or boolean

Default: null

Example: true

Declared by:

plugins.lsp.servers.rust-analyzer.installRustc

Whether to install rustc.

Type: null or boolean

Default: null

Example: true

Declared by:

plugins.lsp.servers.rust-analyzer.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.rustcPackage

Which package to use for rustc.

Type: package

Default: <derivation rustc-wrapper-1.77.2>

Declared by:

plugins.lsp.servers.rust-analyzer.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.rust-analyzer.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.rust-analyzer.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.rust-analyzer.settings.checkOnSave

Run the check command for diagnostics on save.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.linkedProjects

Disable project auto-discovery in favor of explicitly specified set of projects.

Elements must be paths pointing to Cargo.toml, rust-project.json, .rs files (which will be treated as standalone files) or JSON objects in rust-project.json format.

default:

[ ]

Type: null or (list of (string or attribute set of anything))

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.numThreads

How many worker threads in the main loop. The default null means to pick automatically.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.assist.emitMustUse

Whether to insert #[must_use] when generating as_ methods for enum variants.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.assist.expressionFillDefault

Placeholder expression to use for missing expressions in assists.

Values:

  • todo: Fill missing expressions with the todo macro
  • default: Fill missing expressions with reasonable defaults, new or default constructors.
"todo"

Type: null or one of “todo”, “default”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cachePriming.enable

Warm up caches on project load.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cachePriming.numThreads

How many worker threads to handle priming caches. The default 0 means to pick automatically.

default:

0

Type: null or integer or floating point number between 0 and 255 (both inclusive)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.allTargets

Pass --all-targets to cargo invocation.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.autoreload

Automatically refresh project info via cargo metadata on Cargo.toml or .cargo/config.toml changes.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.cfgs

List of cfg options to enable with the given values.

default:

{
  debug_assertions = null;
  miri = null;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.extraArgs

Extra arguments that are passed to every cargo invocation.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.extraEnv

Extra environment variables that will be set when running cargo, rustc or other commands within the workspace. Useful for setting RUSTFLAGS.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.features

List of features to activate.

Set this to "all" to pass --all-features to cargo.

default:

[ ]

Type: null or value “all” (singular enum) or list of string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.noDefaultFeatures

Whether to pass --no-default-features to cargo.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.sysroot

Relative path to the sysroot, or “discover” to try to automatically find it via “rustc --print sysroot”.

Unsetting this disables sysroot loading.

This option does not take effect until rust-analyzer is restarted.

default:

"discover"

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.sysrootQueryMetadata

Whether to run cargo metadata on the sysroot library allowing rust-analyzer to analyze third-party dependencies of the standard libraries.

This will cause cargo to create a lockfile in your sysroot directory. rust-analyzer will attempt to clean up afterwards, but nevertheless requires the location to be writable to.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.sysrootSrc

Relative path to the sysroot library sources. If left unset, this will default to {cargo.sysroot}/lib/rustlib/src/rust/library.

This option does not take effect until rust-analyzer is restarted.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.target

Compilation target override (target triple).

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.targetDir

Optional path to a rust-analyzer specific target directory. This prevents rust-analyzer’s cargo check and initial build-script and proc-macro building from locking the Cargo.lock at the expense of duplicating build artifacts.

Set to true to use a subdirectory of the existing target directory or set to a path relative to the workspace to use that path.

default:

null

Type: null or null or boolean or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.enable

Run build scripts (build.rs) for more precise code analysis.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.invocationLocation

Specifies the working directory for running build scripts.

  • “workspace”: run build scripts for a workspace in the workspace’s root directory. This is incompatible with #rust-analyzer.cargo.buildScripts.invocationStrategy# set to once.
  • “root”: run build scripts in the project’s root directory. This config only has an effect when #rust-analyzer.cargo.buildScripts.overrideCommand# is set.

Values:

  • workspace: The command will be executed in the corresponding workspace root.
  • root: The command will be executed in the project root.
"workspace"

Type: null or one of “workspace”, “root”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.invocationStrategy

Specifies the invocation strategy to use when running the build scripts command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when #rust-analyzer.cargo.buildScripts.overrideCommand# is set.

Values:

  • per_workspace: The command will be executed for each workspace.
  • once: The command will be executed once.
"per_workspace"

Type: null or one of “per_workspace”, “once”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.overrideCommand

Override the command rust-analyzer uses to run build scripts and build procedural macros. The command is required to output json and should therefore include --message-format=json or a similar option.

If there are multiple linked projects/workspaces, this command is invoked for each of them, with the working directory being the workspace root (i.e., the folder containing the Cargo.toml). This can be overwritten by changing #rust-analyzer.cargo.buildScripts.invocationStrategy# and #rust-analyzer.cargo.buildScripts.invocationLocation#.

By default, a cargo invocation will be constructed for the configured targets and features, with the following base command line:

cargo check --quiet --workspace --message-format=json --all-targets

.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.rebuildOnSave

Rerun proc-macros building/build-scripts running when proc-macro or build-script sources change and are saved.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.useRustcWrapper

Use RUSTC_WRAPPER=rust-analyzer when running build scripts to avoid checking unnecessary things.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.allTargets

Check all targets and tests (--all-targets). Defaults to #rust-analyzer.cargo.allTargets#.

default:

null

Type: null or null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.command

Cargo command to use for cargo check.

default:

"check"

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.extraArgs

Extra arguments for cargo check.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.extraEnv

Extra environment variables that will be set when running cargo check. Extends #rust-analyzer.cargo.extraEnv#.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.features

List of features to activate. Defaults to #rust-analyzer.cargo.features#.

Set to "all" to pass --all-features to Cargo.

default:

null

Type: null or value “all” (singular enum) or list of string or null

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.ignore

List of cargo check (or other command specified in check.command) diagnostics to ignore.

For example for cargo check: dead_code, unused_imports, unused_variables,…

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.invocationLocation

Specifies the working directory for running checks.

  • “workspace”: run checks for workspaces in the corresponding workspaces’ root directories. This falls back to “root” if #rust-analyzer.check.invocationStrategy# is set to once.
  • “root”: run checks in the project’s root directory. This config only has an effect when #rust-analyzer.check.overrideCommand# is set.

Values:

  • workspace: The command will be executed in the corresponding workspace root.
  • root: The command will be executed in the project root.
"workspace"

Type: null or one of “workspace”, “root”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.invocationStrategy

Specifies the invocation strategy to use when running the check command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when #rust-analyzer.check.overrideCommand# is set.

Values:

  • per_workspace: The command will be executed for each workspace.
  • once: The command will be executed once.
"per_workspace"

Type: null or one of “per_workspace”, “once”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.noDefaultFeatures

Whether to pass --no-default-features to Cargo. Defaults to #rust-analyzer.cargo.noDefaultFeatures#.

default:

null

Type: null or null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.overrideCommand

Override the command rust-analyzer uses instead of cargo check for diagnostics on save. The command is required to output json and should therefore include --message-format=json or a similar option (if your client supports the colorDiagnosticOutput experimental capability, you can use --message-format=json-diagnostic-rendered-ansi).

If you’re changing this because you’re using some tool wrapping Cargo, you might also want to change #rust-analyzer.cargo.buildScripts.overrideCommand#.

If there are multiple linked projects/workspaces, this command is invoked for each of them, with the working directory being the workspace root (i.e., the folder containing the Cargo.toml). This can be overwritten by changing #rust-analyzer.check.invocationStrategy# and #rust-analyzer.check.invocationLocation#.

If $saved_file is part of the command, rust-analyzer will pass the absolute path of the saved file to the provided command. This is intended to be used with non-Cargo build systems. Note that $saved_file is experimental and may be removed in the futureg.

An example command would be:

cargo check --workspace --message-format=json --all-targets

.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.targets

Check for specific targets. Defaults to #rust-analyzer.cargo.target# if empty.

Can be a single target, e.g. "x86_64-unknown-linux-gnu" or a list of targets, e.g. ["aarch64-apple-darwin", "x86_64-apple-darwin"].

Aliased as "checkOnSave.targets".

default:

null

Type: null or null or string or list of string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.check.workspace

Whether --workspace should be passed to cargo check. If false, -p <package> will be passed instead.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.limit

Maximum number of completions to return. If None, the limit is infinite.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.autoimport.enable

Toggles the additional completions that automatically add imports when completed. Note that your client must specify the additionalTextEdits LSP client capability to truly have this feature enabled.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.autoself.enable

Toggles the additional completions that automatically show method calls and field accesses with self prefixed to them when inside a method.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.callable.snippets

Whether to add parenthesis and argument snippets when completing function.

Values:

  • fill_arguments: Add call parentheses and pre-fill arguments.
  • add_parentheses: Add call parentheses.
  • none: Do no snippet completions for callables.
"fill_arguments"

Type: null or one of “fill_arguments”, “add_parentheses”, “none”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.fullFunctionSignatures.enable

Whether to show full function/method signatures in completion docs.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.postfix.enable

Whether to show postfix snippets like dbg, if, not, etc.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.privateEditable.enable

Enables completions of private items and fields that are defined in the current workspace even if they are not visible at the current position.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.snippets.custom

Custom completion snippets.

default:

{
  "Arc::new" = {
    body = "Arc::new(\${receiver})";
    description = "Put the expression into an `Arc`";
    postfix = "arc";
    requires = "std::sync::Arc";
    scope = "expr";
  };
  "Box::pin" = {
    body = "Box::pin(\${receiver})";
    description = "Put the expression into a pinned `Box`";
    postfix = "pinbox";
    requires = "std::boxed::Box";
    scope = "expr";
  };
  Err = {
    body = "Err(\${receiver})";
    description = "Wrap the expression in a `Result::Err`";
    postfix = "err";
    scope = "expr";
  };
  Ok = {
    body = "Ok(\${receiver})";
    description = "Wrap the expression in a `Result::Ok`";
    postfix = "ok";
    scope = "expr";
  };
  "Rc::new" = {
    body = "Rc::new(\${receiver})";
    description = "Put the expression into an `Rc`";
    postfix = "rc";
    requires = "std::rc::Rc";
    scope = "expr";
  };
  Some = {
    body = "Some(\${receiver})";
    description = "Wrap the expression in an `Option::Some`";
    postfix = "some";
    scope = "expr";
  };
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.completion.termSearch.enable

Whether to enable term search based snippets like Some(foo.bar().baz()).

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.enable

Whether to show native rust-analyzer diagnostics.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.disabled

List of rust-analyzer diagnostics to disable.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.remapPrefix

Map of prefixes to be substituted when parsing diagnostic file paths. This should be the reverse mapping of what is passed to rustc as --remap-path-prefix.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.warningsAsHint

List of warnings that should be displayed with hint severity.

The warnings will be indicated by faded text or three dots in code and will not show up in the Problems Panel.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.warningsAsInfo

List of warnings that should be displayed with info severity.

The warnings will be indicated by a blue squiggly underline in code and a blue icon in the Problems Panel.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.experimental.enable

Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.diagnostics.styleLints.enable

Whether to run additional style lints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.files.excludeDirs

These directories will be ignored by rust-analyzer. They are relative to the workspace root, and globs are not supported. You may also need to add the folders to Code’s files.watcherExclude.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.files.watcher

Controls file watching implementation.

Values:

  • client: Use the client (editor) to watch files for changes
  • server: Use server-side file watching
"client"

Type: null or one of “client”, “server”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.highlightRelated.breakPoints.enable

Enables highlighting of related references while the cursor is on break, loop, while, or for keywords.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.highlightRelated.closureCaptures.enable

Enables highlighting of all captures of a closure while the cursor is on the | or move keyword of a closure.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.highlightRelated.exitPoints.enable

Enables highlighting of all exit points while the cursor is on any return, ?, fn, or return type arrow (->).

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.highlightRelated.references.enable

Enables highlighting of related references while the cursor is on any identifier.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.highlightRelated.yieldPoints.enable

Enables highlighting of all break points for a loop or block context while the cursor is on any async or await keywords.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.enable

Whether to show HoverActions in Rust files.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.debug.enable

Whether to show Debug action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.gotoTypeDef.enable

Whether to show Go to Type Definition action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.implementations.enable

Whether to show Implementations action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.references.enable

Whether to show References action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.actions.run.enable

Whether to show Run action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.documentation.enable

Whether to show documentation on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.documentation.keywords.enable

Whether to show keyword hover popups. Only applies when #rust-analyzer.hover.documentation.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.links.enable

Use markdown syntax for links on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.memoryLayout.enable

Whether to show memory layout data on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.memoryLayout.alignment

How to render the align information in a memory layout hover.

default:

"hexadecimal"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.memoryLayout.niches

How to render the niche information in a memory layout hover.

default:

false

Type: null or null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.memoryLayout.offset

How to render the offset information in a memory layout hover.

default:

"hexadecimal"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.memoryLayout.size

How to render the size information in a memory layout hover.

default:

"both"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.show.enumVariants

How many variants of an enum to display when hovering on. Show none if empty.

default:

5

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.show.fields

How many fields of a struct, variant or union to display when hovering on. Show none if empty.

default:

5

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.hover.show.traitAssocItems

How many associated items of a trait to display when hovering a trait.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.preferNoStd

Prefer to unconditionally use imports of the core and alloc crate, over the std crate.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.preferPrelude

Whether to prefer import paths containing a prelude module.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.prefix

The path structure for newly inserted paths to use.

Values:

  • plain: Insert import paths relative to the current module, using up to one super prefix if the parent module contains the requested item.
  • self: Insert import paths relative to the current module, using up to one super prefix if the parent module contains the requested item. Prefixes self in front of the path if it starts with a module.
  • crate: Force import paths to be absolute by always starting them with crate or the extern crate name they come from.
"plain"

Type: null or one of “plain”, “self”, “crate”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.granularity.enforce

Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.granularity.group

How imports should be grouped into use statements.

Values:

  • preserve: Do not change the granularity of any imports and preserve the original structure written by the developer.
  • crate: Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.
  • module: Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.
  • item: Flatten imports so that each has its own use statement.
  • one: Merge all imports into a single use statement as long as they have the same visibility and attributes.
"crate"

Type: null or one of “preserve”, “crate”, “module”, “item”, “one”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.group.enable

Group inserted imports by the following order. Groups are separated by newlines.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.imports.merge.glob

Whether to allow import insertion to merge new imports into single path glob imports like use std::fmt::*;.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.closureStyle

Closure notation in type and chaining inlay hints.

Values:

  • impl_fn: impl_fn: impl FnMut(i32, u64) -> i8
  • rust_analyzer: rust_analyzer: |i32, u64| -> i8
  • with_id: with_id: {closure#14352}, where that id is the unique number of the closure in r-a internals
  • hide: hide: Shows ... for every closure type
"impl_fn"

Type: null or one of “impl_fn”, “rust_analyzer”, “with_id”, “hide”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.maxLength

Maximum length for inlay hints. Set to null to have an unlimited length.

default:

25

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.renderColons

Whether to render leading colons for type hints, and trailing colons for parameter hints.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.bindingModeHints.enable

Whether to show inlay type hints for binding modes.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.chainingHints.enable

Whether to show inlay type hints for method chains.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.closingBraceHints.enable

Whether to show inlay hints after a closing } to indicate what item it belongs to.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.closingBraceHints.minLines

Minimum number of lines required before the } until the hint is shown (set to 0 or 1 to always show them).

default:

25

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.closureCaptureHints.enable

Whether to show inlay hints for closure captures.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.closureReturnTypeHints.enable

Whether to show inlay type hints for return types of closures.

Values:

  • always: Always show type hints for return types of closures.
  • never: Never show type hints for return types of closures.
  • with_block: Only show type hints for return types of closures with blocks.
"never"

Type: null or one of “always”, “never”, “with_block”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.discriminantHints.enable

Whether to show enum variant discriminant hints.

Values:

  • always: Always show all discriminant hints.
  • never: Never show discriminant hints.
  • fieldless: Only show discriminant hints on fieldless enum variants.
"never"

Type: null or one of “always”, “never”, “fieldless”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.enable

Whether to show inlay hints for type adjustments.

Values:

  • always: Always show all adjustment hints.
  • never: Never show adjustment hints.
  • reborrow: Only show auto borrow and dereference adjustment hints.
"never"

Type: null or one of “always”, “never”, “reborrow”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe

Whether to hide inlay hints for type adjustments outside of unsafe blocks.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.mode

Whether to show inlay hints as postfix ops (.* instead of *, etc).

Values:

  • prefix: Always show adjustment hints as prefix (*expr).
  • postfix: Always show adjustment hints as postfix (expr.*).
  • prefer_prefix: Show prefix or postfix depending on which uses less parenthesis, preferring prefix.
  • prefer_postfix: Show prefix or postfix depending on which uses less parenthesis, preferring postfix.
"prefix"

Type: null or one of “prefix”, “postfix”, “prefer_prefix”, “prefer_postfix”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.implicitDrops.enable

Whether to show implicit drop hints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.lifetimeElisionHints.enable

Whether to show inlay type hints for elided lifetimes in function signatures.

Values:

  • always: Always show lifetime elision hints.
  • never: Never show lifetime elision hints.
  • skip_trivial: Only show lifetime elision hints if a return type is involved.
"never"

Type: null or one of “always”, “never”, “skip_trivial”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.lifetimeElisionHints.useParameterNames

Whether to prefer using parameter names as the name for elided lifetime hints if possible.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.parameterHints.enable

Whether to show function parameter name inlay hints at the call site.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.rangeExclusiveHints.enable

Whether to show exclusive range inlay hints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.reborrowHints.enable

Whether to show inlay hints for compiler inserted reborrows. This setting is deprecated in favor of #rust-analyzer.inlayHints.expressionAdjustmentHints.enable#.

Values:

  • always: Always show reborrow hints.
  • never: Never show reborrow hints.
  • mutable: Only show mutable reborrow hints.
"never"

Type: null or one of “always”, “never”, “mutable”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.enable

Whether to show inlay type hints for variables.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.hideClosureInitialization

Whether to hide inlay type hints for let statements that initialize to a closure. Only applies to closures with blocks, same as #rust-analyzer.inlayHints.closureReturnTypeHints.enable#.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.hideNamedConstructor

Whether to hide inlay type hints for constructors.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.interpret.tests

Enables the experimental support for interpreting tests.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.joinLines.joinAssignments

Join lines merges consecutive declaration and initialization of an assignment.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.joinLines.joinElseIf

Join lines inserts else between consecutive ifs.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.joinLines.removeTrailingComma

Join lines removes trailing commas.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.joinLines.unwrapTrivialBlock

Join lines unwraps trivial blocks.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.enable

Whether to show CodeLens in Rust files.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.forceCustomCommands

Internal config: use custom client-side commands even when the client doesn’t set the corresponding capability.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.location

Where to render annotations.

Values:

  • above_name: Render annotations above the name of the item.
  • above_whole_item: Render annotations above the whole item, including documentation comments and attributes.
"above_name"

Type: null or one of “above_name”, “above_whole_item”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.debug.enable

Whether to show Debug lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.implementations.enable

Whether to show Implementations lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.references.adt.enable

Whether to show References lens for Struct, Enum, and Union. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.references.enumVariant.enable

Whether to show References lens for Enum Variants. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.references.method.enable

Whether to show Method References lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.references.trait.enable

Whether to show References lens for Trait. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lens.run.enable

Whether to show Run lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lru.capacity

Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.lru.query.capacities

Sets the LRU capacity of the specified queries.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.notifications.cargoTomlNotFound

Whether to show can't find Cargo.toml error message.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.notifications.unindexedProject

Whether to send an UnindexedProject notification to the client.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.procMacro.enable

Enable support for procedural macros, implies #rust-analyzer.cargo.buildScripts.enable#.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.procMacro.ignored

These proc-macros will be ignored when trying to expand them.

This config takes a map of crate names with the exported proc-macro names to ignore as values.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.procMacro.server

Internal config, path to proc-macro server executable.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.procMacro.attributes.enable

Expand attribute macros. Requires #rust-analyzer.procMacro.enable# to be set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.references.excludeImports

Exclude imports from find-all-references.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.references.excludeTests

Exclude tests from find-all-references.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.runnables.command

Command to be executed instead of ‘cargo’ for runnables.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.runnables.extraArgs

Additional arguments to be passed to cargo for runnables such as tests or binaries. For example, it may be --release.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.runnables.extraTestBinaryArgs

Additional arguments to be passed through Cargo to launched tests, benchmarks, or doc-tests.

Unless the launched target uses a custom test harness, they will end up being interpreted as options to rustc’s built-in test harness (“libtest”).

default:

[
  "--show-output"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.rustc.source

Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or “discover” to try to automatically find it if the rustc-dev component is installed.

Any project which uses rust-analyzer with the rustcPrivate crates must set [package.metadata.rust-analyzer] rustc_private=true to use it.

This option does not take effect until rust-analyzer is restarted.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.rustfmt.extraArgs

Additional arguments to rustfmt.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.rustfmt.overrideCommand

Advanced option, fully override the command rust-analyzer uses for formatting. This should be the equivalent of rustfmt here, and not that of cargo fmt. The file contents will be passed on the standard input and the formatted result will be read from the standard output.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.rustfmt.rangeFormatting.enable

Enables the use of rustfmt’s unstable range formatting command for the textDocument/rangeFormatting request. The rustfmt option is unstable and only available on a nightly build.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.nonStandardTokens

Whether the server is allowed to emit non-standard tokens and modifiers.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.doc.comment.inject.enable

Inject additional highlighting into doc comments.

When enabled, rust-analyzer will highlight rust source in doc comments as well as intra doc links.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.operator.enable

Use semantic tokens for operators.

When disabled, rust-analyzer will emit semantic tokens only for operator tokens when they are tagged with modifiers.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.operator.specialization.enable

Use specialized semantic tokens for operators.

When enabled, rust-analyzer will emit special token types for operator tokens instead of the generic operator token type.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.enable

Use semantic tokens for punctuation.

When disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when they are tagged with modifiers or have a special role.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.separate.macro.bang

When enabled, rust-analyzer will emit a punctuation semantic token for the ! of macro calls.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.specialization.enable

Use specialized semantic tokens for punctuation.

When enabled, rust-analyzer will emit special token types for punctuation tokens instead of the generic punctuation token type.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.strings.enable

Use semantic tokens for strings.

In some editors (e.g. vscode) semantic tokens override other highlighting grammars. By disabling semantic tokens for strings, other grammars can be used to highlight their contents.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.signatureInfo.detail

Show full signature of the callable. Only shows parameters if disabled.

Values:

  • full: Show the entire signature.
  • parameters: Show only the parameters.
"full"

Type: null or one of “full”, “parameters”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.signatureInfo.documentation.enable

Show documentation.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.typing.autoClosingAngleBrackets.enable

Whether to insert closing angle brackets when typing an opening angle bracket of a generic argument list.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.kind

Workspace symbol search kind.

Values:

  • only_types: Search for types only.
  • all_symbols: Search for all symbols kinds.
"only_types"

Type: null or one of “only_types”, “all_symbols”

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.limit

Limits the number of items returned from a workspace symbol search (Defaults to 128). Some clients like vs-code issue new searches on result filtering and don’t require all results to be returned in the initial search. Other clients requires all results upfront and might require a higher limit.

default:

128

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.scope

Workspace symbol search scope.

Values:

  • workspace: Search in current workspace only.
  • workspace_and_dependencies: Search in current workspace and dependencies.
"workspace"

Type: null or one of “workspace”, “workspace_and_dependencies”

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.enable

Whether to enable slint_lsp for Slint GUI language.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.slint-lsp.package

Which package to use for slint-lsp.

Type: null or package

Default: <derivation slint-lsp-1.5.1>

Declared by:

plugins.lsp.servers.slint-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.extraOptions

Extra options for the slint-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.slint-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.slint-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.slint-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.slint-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.solargraph.enable

Whether to enable solargraph for Ruby.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.solargraph.package

Which package to use for solargraph.

Type: null or package

Default: <derivation ruby3.1-solargraph-0.50.0>

Declared by:

plugins.lsp.servers.solargraph.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.solargraph.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.solargraph.extraOptions

Extra options for the solargraph language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.solargraph.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.solargraph.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.solargraph.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.solargraph.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.solargraph.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.solargraph.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.sourcekit.enable

Whether to enable sourcekit language server for Swift and C/C++/Objective-C.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.sourcekit.package

Which package to use for sourcekit.

Type: null or package

Default: <derivation sourcekit-lsp-5.8>

Declared by:

plugins.lsp.servers.sourcekit.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.sourcekit.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.sourcekit.extraOptions

Extra options for the sourcekit language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.sourcekit.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.sourcekit.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.sourcekit.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.sourcekit.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.sourcekit.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.sourcekit.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.sqls.enable

Whether to enable sqls for SQL.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.sqls.package

Which package to use for sqls.

Type: null or package

Default: <derivation sqls-0.2.28>

Declared by:

plugins.lsp.servers.sqls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.sqls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.sqls.extraOptions

Extra options for the sqls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.sqls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.sqls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.sqls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.sqls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.sqls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.sqls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.svelte.enable

Whether to enable svelte language server for Svelte.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.svelte.package

Which package to use for svelte.

Type: null or package

Default: <derivation svelte-language-server-0.16.5>

Declared by:

plugins.lsp.servers.svelte.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.svelte.extraOptions

Extra options for the svelte language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.svelte.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.svelte.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.svelte.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.enable

Enable the CSS plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.globals

Which css files should be checked for global variables (--global-var: value;). These variables are added to the css completions. String of comma-separated file paths or globs relative to workspace root.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.colorPresentations.enable

Enable color picker for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.completions.enable

Enable completions for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.completions.emmet

Enable emmet auto completions for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.diagnostics.enable

Enable diagnostic messages for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.documentColors.enable

Enable document colors for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.documentSymbols.enable

Enable document symbols for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.hover.enable

Enable hover info for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.css.selectionRange.enable

Enable selection range for CSS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.enable

Enable the HTML plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.completions.enable

Enable completions for HTML.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.completions.emmet

Enable emmet auto completions for HTML.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.documentSymbols.enable

Enable document symbols for HTML.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.hover.enable

Enable hover info for HTML.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.linkedEditing.enable

Enable Linked Editing for HTML.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.html.tagComplete.enable

Enable tag auto closing.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.enable

Enable the Svelte plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.compilerWarnings

Svelte compiler warning codes to ignore or to treat as errors. Example:

{
  css-unused-selector = "ignore";
  unused-export-let = "error";
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.defaultScriptLanguage

The default language to use when generating new script tags in Svelte.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.codeActions.enable

Enable code actions for Svelte.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.completions.enable

Enable completions for TypeScript. Enable autocompletion for Svelte (for tags like #if/#each).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.diagnostics.enable

Enable diagnostic messages for Svelte.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.enable

Enable formatting for Svelte (includes css & js) using prettier-plugin-svelte.

You can set some formatting options through this extension. They will be ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.printWidth

Maximum line width after which code is tried to be broken up.

This is a Prettier core option. If you have the Prettier extension installed, this option is ignored and the corresponding option of that extension is used instead. This option is also ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: 80

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.singleQuote

Use single quotes instead of double quotes, where possible.

This is a Prettier core option. If you have the Prettier extension installed, this option is ignored and the corresponding option of that extension is used instead. This option is also ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.svelteAllowShorthand

Option to enable/disable component attribute shorthand if attribute name and expression are the same.

This option is ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.svelteBracketNewLine

Put the > of a multiline element on a new line.

This option is ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.svelteIndentScriptAndStyle

Whether or not to indent code inside <script> and <style> tags.

This option is ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.svelteSortOrder

Format: join the keys options, scripts, markup, styles with a - in the order you want.

This option is ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: "options-scripts-markup-styles"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.format.config.svelteStrictMode

More strict HTML syntax.

This option is ignored if there’s any kind of configuration file, for example a .prettierrc file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.hover.enable

Enable hover info for Svelte (for tags like #if/#each).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.rename.enable

Enable rename/move Svelte files functionality.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.svelte.selectionRange.enable

Enable selection range for Svelte.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.enable

Enable the TypeScript plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.codeActions.enable

Enable code actions for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.completions.enable

Enable completions for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.diagnostics.enable

Enable diagnostic messages for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.documentSymbols.enable

Enable document symbols for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.hover.enable

Enable hover info for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.selectionRange.enable

Enable selection range for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.semanticTokens.enable

Enable semantic tokens (semantic highlight) for TypeScript.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.initOptions.svelte.plugin.typescript.signatureHelp.enable

Enable signature help (parameter hints) for JS/TS.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.svelte.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.svelte.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.svelte.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.tailwindcss.enable

Whether to enable tailwindcss language server for tailwindcss.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.tailwindcss.package

Which package to use for tailwindcss.

Type: null or package

Default: <derivation tailwindcss-language-server-0.0.16>

Declared by:

plugins.lsp.servers.tailwindcss.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tailwindcss.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tailwindcss.extraOptions

Extra options for the tailwindcss language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.tailwindcss.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tailwindcss.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.tailwindcss.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.tailwindcss.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.tailwindcss.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.tailwindcss.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.taplo.enable

Whether to enable taplo for TOML.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.taplo.package

Which package to use for taplo.

Type: null or package

Default: <derivation taplo-0.9.0>

Declared by:

plugins.lsp.servers.taplo.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.taplo.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.taplo.extraOptions

Extra options for the taplo language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.taplo.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.taplo.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.taplo.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.taplo.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.taplo.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.taplo.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.templ.enable

Whether to enable templ language server for the templ HTML templating language.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.templ.package

Which package to use for templ.

Type: null or package

Default: <derivation templ-0.2.697>

Declared by:

plugins.lsp.servers.templ.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.templ.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.templ.extraOptions

Extra options for the templ language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.templ.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.templ.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.templ.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.templ.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.templ.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.templ.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.terraformls.enable

Whether to enable terraform-ls for terraform.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.terraformls.package

Which package to use for terraformls.

Type: null or package

Default: <derivation terraform-ls-0.33.1>

Declared by:

plugins.lsp.servers.terraformls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.terraformls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.terraformls.extraOptions

Extra options for the terraformls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.terraformls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.terraformls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.terraformls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.terraformls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.terraformls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.terraformls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.texlab.enable

Whether to enable texlab language server for LaTeX.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.texlab.package

Which package to use for texlab.

Type: null or package

Default: <derivation texlab-5.16.0>

Declared by:

plugins.lsp.servers.texlab.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.texlab.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.texlab.extraOptions

Extra options for the texlab language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.texlab.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.texlab.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.texlab.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.texlab.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.texlab.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.texlab.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.tinymist.enable

Whether to enable tinymist for Typst.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.tinymist.package

Which package to use for tinymist.

Type: null or package

Default: <derivation tinymist-0.11.9>

Declared by:

plugins.lsp.servers.tinymist.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tinymist.extraOptions

Extra options for the tinymist language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.tinymist.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tinymist.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.tinymist.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.tinymist.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.tinymist.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.tinymist.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.tinymist.settings.compileStatus

In VSCode, enable compile status meaning that the extension will show the compilation status in the status bar.

Since neovim and helix don’t have a such feature, it is disabled by default at the language server level.

Plugin default: "enable"

Type: null or one of “enable”, “disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.exportPdf

The extension can export PDFs of your Typst files. This setting controls whether this feature is enabled and how often it runs.

  • auto: Select best solution automatically. (Recommended)
  • never: Never export PDFs, you will manually run typst.
  • onSave: Export PDFs when you save a file.
  • onType: Export PDFs as you type in a file.
  • onDocumentHasTitle: Export PDFs when a document has a title (and save a file), which is useful to filter out template files.

Plugin default: "auto"

Type: null or one of “auto”, “never”, “onSave”, “onType”, “onDocumentHasTitle” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.fontPaths

Font paths, which doesn’t allow for dynamic configuration. Note: you can use vscode variables in the path, e.g. $\{workspaceFolder}/fonts.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.formatterMode

The extension can format Typst files using typstfmt or typstyle.

  • disable: Formatter is not activated.
  • typstyle: Use typstyle formatter.
  • typstfmt: Use typstfmt formatter.

Plugin default: "disable"

Type: null or one of “disable”, “typstyle”, “typstfmt” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.formatterPrintWidth

Set the print width for the formatter, which is a soft limit of characters per line. See the definition of Print Width.

Note: this has lower priority than the formatter’s specific configurations.

Plugin default: 120

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.outputPath

The path pattern to store Typst artifacts, you can use $root or $dir or $name to do magic configuration, e.g. $dir/$name (default) and $root/target/$dir/$name.

Plugin default: "$dir/$name"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.rootPath

Configure the root for absolute paths in typst.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.semanticTokens

Enable or disable semantic tokens (LSP syntax highlighting).

  • enable: Use semantic tokens for syntax highlighting
  • disable: Do not use semantic tokens for syntax highlighting

Plugin default: "enable"

Type: null or one of “enable”, “disable” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.serverPath

The extension can use a local tinymist executable instead of the one bundled with the extension. This setting controls the path to the executable.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.systemFonts

A flag that determines whether to load system fonts for Typst compiler, which is useful for ensuring reproducible compilation. If set to null or not set, the extension will use the default behavior of the Typst compiler.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings."trace.server"

Traces the communication between VS Code and the language server.

Plugin default: "off"

Type: null or one of “off”, “messages”, “verbose” or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tinymist.settings.typstExtraArgs

You can pass any arguments as you like, and we will try to follow behaviors of the same version of typst-cli.

Note: the arguments may be overridden by other settings. For example, --font-path will be overridden by tinymist.fontPaths.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.lsp.servers.tsserver.enable

Whether to enable tsserver for TypeScript.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.tsserver.package

Which package to use for tsserver.

Type: null or package

Default: <derivation typescript-language-server-4.3.3>

Declared by:

plugins.lsp.servers.tsserver.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.tsserver.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tsserver.extraOptions

Extra options for the tsserver language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.tsserver.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.tsserver.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.tsserver.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.tsserver.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.tsserver.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.tsserver.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.typos-lsp.enable

Whether to enable Source code spell checker for Visual Studio Code and LSP clients.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.typos-lsp.package

Which package to use for typos-lsp.

Type: null or package

Default: <derivation typos-lsp-0.1.18>

Declared by:

plugins.lsp.servers.typos-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.typos-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.typos-lsp.extraOptions

Extra options for the typos-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.typos-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.typos-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.typos-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.typos-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.typos-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.typos-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.typst-lsp.enable

Whether to enable typst-lsp for typst.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.typst-lsp.package

Which package to use for typst-lsp.

Type: null or package

Default: <derivation typst-lsp-0.13.0>

Declared by:

plugins.lsp.servers.typst-lsp.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.typst-lsp.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.typst-lsp.extraOptions

Extra options for the typst-lsp language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.typst-lsp.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.typst-lsp.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.typst-lsp.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.typst-lsp.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.typst-lsp.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.typst-lsp.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.vala-ls.enable

Whether to enable vala_ls for Vala.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.vala-ls.package

Which package to use for vala-ls.

Type: null or package

Default: <derivation vala-language-server-0.48.7>

Declared by:

plugins.lsp.servers.vala-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.vala-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vala-ls.extraOptions

Extra options for the vala-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.vala-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vala-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.vala-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.vala-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.vala-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.vala-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.vhdl-ls.enable

Whether to enable vhdl_ls for VHDL.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.vhdl-ls.package

Which package to use for vhdl-ls.

Type: null or package

Default: <derivation vhdl-ls-0.80.0>

Declared by:

plugins.lsp.servers.vhdl-ls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.vhdl-ls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vhdl-ls.extraOptions

Extra options for the vhdl-ls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.vhdl-ls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vhdl-ls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.vhdl-ls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.vhdl-ls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.vhdl-ls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.vhdl-ls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.vls.enable

Whether to enable vls for V.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.vls.package

Which package to use for vls.

Type: null or package

Default: null

Declared by:

plugins.lsp.servers.vls.autoSetFiletype

Files with the .v extension are not automatically detected as vlang files. If this option is enabled, Nixvim will automatically set the filetype accordingly.

Type: boolean

Default: true

Example: false

Declared by:

plugins.lsp.servers.vls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.vls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vls.extraOptions

Extra options for the vls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.vls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.vls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.vls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.vls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.vls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.volar.enable

Whether to enable @volar/vue-language-server for Vue.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.volar.package

Which package to use for volar.

Type: null or package

Default: <derivation _at_volar_slash_vue-language-server-1.6.5>

Declared by:

plugins.lsp.servers.volar.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.volar.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.volar.extraOptions

Extra options for the volar language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.volar.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.volar.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.volar.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.volar.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.volar.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.volar.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.vuels.enable

Whether to enable vuels for Vue.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.vuels.package

Which package to use for vuels.

Type: null or package

Default: <derivation vls-0.8.5>

Declared by:

plugins.lsp.servers.vuels.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.vuels.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vuels.extraOptions

Extra options for the vuels language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.vuels.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.vuels.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.vuels.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.vuels.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.vuels.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.vuels.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.yamlls.enable

Whether to enable yamlls for YAML.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.yamlls.package

Which package to use for yamlls.

Type: null or package

Default: <derivation yaml-language-server-1.14.0>

Declared by:

plugins.lsp.servers.yamlls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.yamlls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.yamlls.extraOptions

Extra options for the yamlls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.yamlls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.yamlls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.yamlls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.yamlls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.yamlls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.yamlls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp.servers.zls.enable

Whether to enable zls for Zig.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp.servers.zls.package

Which package to use for zls.

Type: null or package

Default: <derivation zls-0.12.0>

Declared by:

plugins.lsp.servers.zls.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp.servers.zls.cmd

This option has no description.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.zls.extraOptions

Extra options for the zls language server.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp.servers.zls.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp.servers.zls.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.lsp.servers.zls.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp.servers.zls.onAttach

Server specific on_attach behavior.

Type: null or (submodule)

Default: null

Declared by:

plugins.lsp.servers.zls.onAttach.function

Body of the on_attach function. The argument client and bufnr is provided.

Type: strings concatenated with “\n”

Declared by:

plugins.lsp.servers.zls.onAttach.override

Override the global plugins.lsp.onAttach function.

Type: boolean

Default: false

Declared by:

plugins.lsp-format.enable

Whether to enable lsp-format.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp-format.package

Which package to use for the lsp-format.nvim plugin.

Type: package

Default: <derivation vimplugin-lsp-format.nvim-2024-04-03>

Declared by:

plugins.lsp-format.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lsp-format.lspServersToEnable

Choose the LSP servers for which lsp-format should be enabled.

Possible values:

  • “all” (default): Enable formatting for all language servers
  • “none”: Do not enable formatting on any language server. You might choose this if for some reason you want to manually call require("lsp-format").on_attach(client) in the onAttach function of your language servers.
  • list of LS names: Manually choose the servers by name

Type: one of “none”, “all” or list of string

Default: "all"

Example:

[
  "efm"
  "gopls"
]

Declared by:

plugins.lsp-format.setup

The setup option maps |filetypes| to format options.

Type: attribute set of (attribute set)

Default: { }

Example:

{
  go = {
    exclude = [
      "gopls"
    ];
    force = true;
    order = [
      "gopls"
      "efm"
    ];
    sync = true;
  };
}

Declared by:

plugins.lsp-format.setup.<name>.exclude

List of client names to exclude from formatting.

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp-format.setup.<name>.force

If true, the format result will always be written to the buffer, even if the buffer changed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp-format.setup.<name>.order

List of client names. Formatting is requested from clients in the following order: first all clients that are not in the order table, then the remaining clients in the order as they occur in the order table. (same logic as |vim.lsp.buf.formatting_seq_sync()|).

Type: null or (list of string)

Default: null

Declared by:

plugins.lsp-format.setup.<name>.sync

Whether to turn on synchronous formatting. The editor will block until formatting is done.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp-lines.enable

Whether to enable lsp_lines.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp-lines.package

Which package to use for the lsp_lines.nvim plugin.

Type: package

Default: <derivation vimplugin-lsp_lines.nvim-2024-03-09>

Declared by:

plugins.lsp-lines.currentLine

Show diagnostics only on current line

Type: boolean

Default: false

Declared by:

lsp-status

Url: https://github.com/nvim-lua/lsp-status.nvim/

Maintainers: Ben

plugins.lsp-status.enable

Whether to enable lsp-status.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lsp-status.package

Which package to use for the lsp-status.nvim plugin.

Type: package

Default: <derivation vimplugin-lsp-status.nvim-2022-08-03>

Declared by:

plugins.lsp-status.settings

Options provided to the require('lsp-status').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.lsp-status.settings.component_separator

A string which goes between each “chunk” of the statusline component (i.e. different diagnostic groups, messages).

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.current_function

True if the current function should be updated and displayed in the default statusline component.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.diagnostics

If false, the default statusline component does not display LSP diagnostics.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_errors

The string to show as diagnostics. If you don’t have Nerd/Awesome Fonts you can replace defaults with ASCII chars.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_hint

The string to show as diagnostics. If you don’t have Nerd/Awesome Fonts you can replace defaults with ASCII chars.

Plugin default: "❗"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_info

The string to show as diagnostics. If you don’t have Nerd/Awesome Fonts you can replace defaults with ASCII chars.

Plugin default: "🛈"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_ok

The string to show as diagnostics. If you don’t have Nerd/Awesome Fonts you can replace defaults with ASCII chars.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_separator

A string which goes between each diagnostic group symbol and its count.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.indicator_warnings

The string to show as diagnostics. If you don’t have Nerd/Awesome Fonts you can replace defaults with ASCII chars.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.kind_labels

An optional map from LSP symbol kinds to label symbols. Used to decorate the current function name.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.lsp-status.settings.select_symbol

An optional handler of the form function(cursor_pos, document_symbol) that should return true if document_symbol (a DocumentSymbol) should be accepted as the symbol currently containing the cursor.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lsp-status.settings.show_filename

True if the current function should be updated and displayed in the default statusline component.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspkind.enable

Whether to enable lspkind.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lspkind.package

Which package to use for the lspkind plugin.

Type: package

Default: <derivation vimplugin-lspkind-nvim-2024-01-11>

Declared by:

plugins.lspkind.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lspkind.mode

Defines how annotations are shown

Plugin default: "symbol_text"

Type: null or one of “text”, “text_symbol”, “symbol_text”, “symbol” or raw lua code

Default: null

Declared by:

plugins.lspkind.preset

Default symbol map

Plugin default: "codicons"

Type: null or one of “default”, “codicons” or raw lua code

Default: null

Declared by:

plugins.lspkind.symbolMap

Override preset symbols

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lspkind.cmp.enable

Integrate with nvim-cmp

Type: boolean

Default: true

Declared by:

plugins.lspkind.cmp.after

Function to run after calculating the formatting. function(entry, vim_item, kind)

Type: null or string

Default: null

Declared by:

plugins.lspkind.cmp.ellipsisChar

Character to show when the popup exceeds maxwidth

Type: null or string

Default: null

Declared by:

plugins.lspkind.cmp.maxWidth

Maximum number of characters to show in the popup

Type: null or signed integer

Default: null

Declared by:

plugins.lspkind.cmp.menu

Show source names in the popup

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lspsaga.enable

Whether to enable lspsaga.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lspsaga.package

Which package to use for the lspsaga plugin.

Type: package

Default: <derivation vimplugin-lspsaga.nvim-2024-05-16>

Declared by:

plugins.lspsaga.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.lspsaga.beacon.enable

In Lspsaga, some commands jump around in buffer(s). With beacon enabled, it will show a beacon to tell you where the cursor is.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.beacon.frequency

Frequency.

Plugin default: 7

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.callhierarchy.layout

  • Layout normal and float.
  • Or you can pass in an extra argument like :Lspsaga incoming_calls ++normal, which overrides this option.

Plugin default: "float"

Type: null or one of “float”, “normal” or raw lua code

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.close

Close layout.

Plugin default: <C-c>k

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.edit

Edit (open) file.

Plugin default: e

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.quit

Quit layout.

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.shuttle

Shuttle between the layout left and right.

Plugin default: [w

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.split

split

Plugin default: i

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.tabe

Open in new tab.

Plugin default: t

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.toggleOrReq

Toggle or do request.

Plugin default: u

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.callhierarchy.keys.vsplit

vsplit

Plugin default: s

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.codeAction.extendGitSigns

Extend gitsigns plugin diff action.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.codeAction.numShortcut

Whether number shortcut for code actions are enabled.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.codeAction.onlyInCursor

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.codeAction.showServerName

Show language server name.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.codeAction.keys.exec

Execute action.

Plugin default: <CR>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.codeAction.keys.quit

Quit the float window.

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.height

Defines float window height.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.definition.width

Defines float window width.

Plugin default: 0.6

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.definition.keys.close

close

Plugin default: <C-c>k

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.keys.edit

edit

Plugin default: <C-c>o

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.keys.quit

quit

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.keys.split

split

Plugin default: <C-c>i

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.keys.tabe

tabe

Plugin default: <C-c>t

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.definition.keys.vsplit

vsplit

Plugin default: <C-c>v

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.diagnostic.borderFollow

Diagnostic jump window border follow diagnostic type.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.diagnosticOnlyCurrent

Only show diagnostic virtual text on the current line.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.extendRelatedInformation

When have relatedInformation, diagnostic message is extended to show it.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.jumpNumShortcut

Enable number shortcuts to execute code action quickly.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.maxHeight

Diagnostic jump window max height.

Plugin default: 0.6

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.diagnostic.maxShowHeight

Show window max height when layout is float.

Plugin default: 0.6

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.diagnostic.maxShowWidth

Show window max width when layout is float.

Plugin default: 0.9

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.diagnostic.maxWidth

Diagnostic jump window max width.

Plugin default: 0.8

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.diagnostic.showCodeAction

Show code action in diagnostic jump window. It’s useful. Suggested to set to true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.showLayout

Config layout of diagnostic window not jump window.

Plugin default: "float"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.showNormalHeight

Show window height when diagnostic show window layout is normal.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.textHlFollow

Diagnostic jump window text highlight follow diagnostic type.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.diagnostic.keys.execAction

Execute action (in jump window).

Plugin default: o

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.diagnostic.keys.quit

Quit key for the jump window.

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.diagnostic.keys.quitInShow

Quit key for the diagnostic_show window.

Plugin default: [q <ESC>]

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.diagnostic.keys.toggleOrJump

Toggle or jump to position when in diagnostic_show window.

Plugin default: <CR>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.default

Default search results shown, ref for “references” and imp for “implementation”.

Plugin default: "ref+imp"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.finder.filter

Keys are LSP methods. Values are a filter handler. Function parameter are client_id and result.

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lspsaga.finder.layout

normal will use the normal layout window priority is lower than command layout.

Plugin default: "float"

Type: null or one of “float”, “normal” or raw lua code

Default: null

Declared by:

plugins.lspsaga.finder.leftWidth

Width of the left finder window (float layout).

Plugin default: 0.3

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.finder.maxHeight

max_height of the finder window (float layout).

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.finder.methods

Keys are alias of LSP methods. Values are LSP methods, which you want show in finder.

Example:

  {
    tyd = "textDocument/typeDefinition";
  }

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.lspsaga.finder.rightWidth

Width of the right finder window (float layout).

Plugin default: 0.3

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.finder.silent

If it’s true, it will disable show the no response message.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.finder.keys.close

Close finder.

Plugin default: <C-c>k

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.quit

Quit the finder, only works in layout left window.

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.shuttle

Shuttle between the finder layout window.

Plugin default: [w

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.split

Open in split.

Plugin default: i

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.tabe

Open in tabe.

Plugin default: t

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.tabnew

Open in new tab.

Plugin default: r

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.toggleOrOpen

Toggle expand or open.

Plugin default: o

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.finder.keys.vsplit

Open in vsplit.

Plugin default: s

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.hover.maxHeight

Defines float window height.

Plugin default: 0.8

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.hover.maxWidth

Defines float window width.

Plugin default: 0.9

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.hover.openCmd

cmd for opening links.

Plugin default: "!chrome"

Type: null or string or raw lua code

Default: null

Declared by:

Key for opening links.

Plugin default: "gx"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.implement.enable

When buffer has instances of the interface type, Lspsaga will show extra information for it.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.implement.priority

Sign priority.

Plugin default: 100

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.implement.sign

Show sign in status column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.implement.virtualText

Show virtual text at the end of line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.lightbulb.enable

Enable lightbulb.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.lightbulb.debounce

Timer debounce.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.lightbulb.sign

Show sign in status column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.lightbulb.signPriority

Sign priority.

Plugin default: 40

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.lightbulb.virtualText

Show virtual text at the end of line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.autoClose

Auto close itself when outline window is last window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.autoPreview

Auto preview when cursor moved in outline window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.closeAfterJump

Close after jump.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.detail

Show detail.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.layout

float or normal. Default is normal. If set to float, above options will ignored.

Plugin default: "normal"

Type: null or one of “normal”, “float” or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.leftWidth

Width of outline float layout left window.

Plugin default: 0.3

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.outline.maxHeight

Height of outline float layout.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.outline.winPosition

right window position.

Plugin default: "right"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.winWidth

Window width.

Plugin default: 30

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.outline.keys.jump

Jump to pos even on a expand/collapse node.

Plugin default: e

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.outline.keys.quit

Quit outline window.

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.outline.keys.toggleOrJump

Toggle or jump.

Plugin default: o

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.rename.autoSave

Auto save file when the rename is done.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.rename.inSelect

Default is true. Whether the name is selected when the float opens.

In some situation, just like want to change one or less characters, inSelect is not so useful. You can tell the Lspsaga to start in normal mode using an extra argument like :Lspsaga lsp_rename mode=n.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.rename.projectMaxHeight

Height for the project_replace float window.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.rename.projectMaxWidth

Width for the project_replace float window.

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.lspsaga.rename.keys.exec

Execute rename in rename window or execute replace in project_replace window.

Plugin default: <CR>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.rename.keys.quit

Quit rename window or project_replace window.

Plugin default: <C-k>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.rename.keys.select

Select or cancel select item in project_replace float window.

Plugin default: x

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.scrollPreview.scrollDown

Scroll down.

Plugin default: <C-f>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.scrollPreview.scrollUp

Scroll up.

Plugin default: <C-b>

Type: null or string or list of string

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.enable

Enable.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.colorMode

Color mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.delay

Delay.

Plugin default: 300

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.folderLevel

Folder level.

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.hideKeyword

Hide keyword.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.separator

Separator character.

Plugin default: " › "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.symbolInWinbar.showFile

Show file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.actionfix

Action fix icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.border

Defines the border to use for lspsaga. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: single

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.codeAction

Code action icon.

Plugin default: "💡"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.collapse

Collapse icon.

Plugin default: "⊟"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.devicon

Whether to use nvim-web-devicons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.expand

Expand icon.

Plugin default: "⊞"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.impSign

Implement icon.

Plugin default: "󰳛 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lspsaga.ui.kind

LSP kind custom table.

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.lspsaga.ui.lines

Symbols used in virtual text connect.

Plugin default: ["┗" "┣" "┃" "━" "┏"]

Type: null or (list of string)

Default: null

Declared by:

plugins.lspsaga.ui.title

Show title in some float window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

ltex-extra

Url: https://github.com/barreiroleo/ltex_extra.nvim/

Maintainers: Loïc Reynier

plugins.ltex-extra.enable

Whether to enable ltex_extra.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ltex-extra.package

Which package to use for the ltex_extra.nvim plugin.

Type: package

Default: <derivation vimplugin-ltex_extra.nvim-2024-04-13>

Declared by:

plugins.ltex-extra.settings

Options provided to the require('ltex-extra').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  initCheck = true;
  loadLangs = [
    "en-US"
    "fr-FR"
  ];
  logLevel = "non";
  path = ".ltex";
}

Declared by:

plugins.ltex-extra.settings.init_check

Whether to load dictionaries on startup.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ltex-extra.settings.load_langs

Languages for witch dicionnaries will be loaded. See plugins.lsp.servers.ltex.languages for possible values.

Plugin default: ["en-US"]

Type: null or (list of string)

Default: null

Declared by:

plugins.ltex-extra.settings.log_level

Log level. Possible values:

  • “none”
  • “trace”
  • “debug”
  • “info”
  • “warn”
  • “error”
  • “fatal”

Plugin default: "none"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ltex-extra.settings.path

Path (relative to project root) to load external files from.

Commonly used values are:

  • .ltex
  • .vscode for compatibility with projects using the associated VS Code extension.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lualine.enable

Whether to enable lualine.

Type: boolean

Default: false

Example: true

Declared by:

plugins.lualine.package

Which package to use for the lualine plugin.

Type: package

Default: <derivation vimplugin-lualine.nvim-2024-04-05>

Declared by:

plugins.lualine.alwaysDivideMiddle

When set to true, left sections i.e. ‘a’,‘b’ and ‘c’ can’t take over the entire statusline even if neither of ‘x’, ‘y’ or ‘z’ are present.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lualine.extensions

list of enabled extensions

Type: null or (list of string)

Default: null

Example: "[ \"fzf\" ]"

Declared by:

plugins.lualine.globalstatus

Enable global statusline (have a single statusline at bottom of neovim instead of one for every window). This feature is only available in neovim 0.7 and higher.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.lualine.iconsEnabled

Whether to enable/disable icons for all components.

Type: boolean

Default: true

Declared by:

plugins.lualine.ignoreFocus

If current filetype is in this list it’ll always be drawn as inactive statusline and the last window will be drawn as active statusline.

For example if you don’t want statusline of your file tree / sidebar window to have active statusline you can add their filetypes here.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lualine.theme

The theme to use for lualine-nvim.

Plugin default: auto

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.lualine.componentSeparators.left

Left separator

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lualine.componentSeparators.right

Right separator

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lualine.disabledFiletypes.statusline

Only ignores the ft for statusline.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lualine.disabledFiletypes.winbar

Only ignores the ft for winbar.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_a

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_b

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_c

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_x

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_y

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveSections.lualine_z

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_a

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_b

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_c

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_x

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_y

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.inactiveWinbar.lualine_z

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.refresh.statusline

Refresh time for the status line (ms)

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lualine.refresh.tabline

Refresh time for the tabline (ms)

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lualine.refresh.winbar

Refresh time for the winbar (ms)

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.lualine.sectionSeparators.left

Left separator

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lualine.sectionSeparators.right

Right separator

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.lualine.sections.lualine_a

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.sections.lualine_b

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.sections.lualine_c

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.sections.lualine_x

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.sections.lualine_y

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.sections.lualine_z

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_a

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_b

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_c

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_x

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_y

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.tabline.lualine_z

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_a

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_b

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_c

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_x

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_y

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.lualine.winbar.lualine_z

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.luasnip.enable

Whether to enable luasnip.

Type: boolean

Default: false

Example: true

Declared by:

plugins.luasnip.package

Which package to use for the luasnip plugin.

Type: package

Default: <derivation vimplugin-lua5.1-luasnip-2.3.0-1-unstable-2024-05-16>

Declared by:

plugins.luasnip.extraConfig

Extra config options for luasnip.

Example: { enable_autosnippets = true, store_selection_keys = “<Tab>”, }

Type: attribute set of anything

Default: { }

Declared by:

plugins.luasnip.fromLua

Load lua snippets with the lua loader. Check https://github.com/L3MON4D3/LuaSnip/blob/master/DOC.md#lua for the necessary file structure.

Type: list of (submodule)

Default: [ ]

Example:

''
  [
    {}
    {
      paths = ./path/to/snippets;
    }
  ]
''

Declared by:

plugins.luasnip.fromLua.*.lazyLoad

Whether or not to lazy load the snippets

Type: boolean

Default: true

Declared by:

plugins.luasnip.fromLua.*.paths

Paths with snippets specified with native lua

Plugin default: ``

Type: null or null or string or path or raw lua code or list of (string or path or raw lua code)

Default: null

Declared by:

plugins.luasnip.fromVscode

This option has no description.

Type: list of (submodule)

Default: [ ]

Example:

''
  [
    {}
    {
      paths = ./path/to/snippets;
    }
  ]
  # generates:
  #
  # require("luasnip.loaders.from_vscode").lazy_load({})
  # require("luasnip.loaders.from_vscode").lazy_load({['paths'] = {'/nix/store/.../path/to/snippets'}})
  #
''

Declared by:

plugins.luasnip.fromVscode.*.exclude

List of languages to exclude, by default is empty.

Type: null or (list of string)

Default: null

Declared by:

plugins.luasnip.fromVscode.*.include

List of languages to include, by default is not set.

Type: null or (list of string)

Default: null

Declared by:

plugins.luasnip.fromVscode.*.lazyLoad

Whether or not to lazy load the snippets

Type: boolean

Default: true

Declared by:

plugins.luasnip.fromVscode.*.paths

This option has no description.

Type: null or string or path or raw lua code or list of (string or path or raw lua code)

Default: null

Declared by:

magma-nvim

Url: https://github.com/WhiteBlackGoose/magma-nvim-goose/

Maintainers: Gaetan Lepage

plugins.magma-nvim.enable

Whether to enable magma-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.magma-nvim.package

Which package to use for the magma-nvim plugin.

Type: package

Default: <derivation vimplugin-magma-nvim-goose-2023-03-13>

Declared by:

plugins.magma-nvim.settings

The configuration options for magma-nvim without the magma_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal magma_foo_bar=1
  • hello = "world" -> :setglobal magma_hello="world"
  • some_toggle = true -> :setglobal magma_some_toggle
  • other_toggle = false -> :setglobal nomagma_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  automatically_open_output = true;
  cell_highlight_group = "CursorLine";
  image_provider = "none";
  output_window_borders = true;
  save_path = {
    __raw = "vim.fn.stdpath('data') .. '/magma'";
  };
  show_mimetype_debug = false;
  wrap_output = true;
}

Declared by:

plugins.magma-nvim.settings.automatically_open_output

If this is true, then whenever you have an active cell its output window will be automatically shown.

If this is false, then the output window will only be automatically shown when you’ve just evaluated the code. So, if you take your cursor out of the cell, and then come back, the output window won’t be opened (but the cell will be highlighted). This means that there will be nothing covering your code. You can then open the output window at will using :MagmaShowOutput.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.cell_highlight_group

The highlight group to be used for highlighting cells.

Plugin default: "CursorLine"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.image_provider

This configures how to display images. The following options are available:

  • “none” – don’t show images.
  • “ueberzug” – use Ueberzug to display images.
  • “kitty” – use the Kitty protocol to display images.

Plugin default: "none"

Type: null or one of “none”, “ueberzug”, “kitty” or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.output_window_borders

If this is true, then the output window will have rounded borders. If it is false, it will have no borders.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.save_path

Where to save/load with :MagmaSave and :MagmaLoad (with no parameters). The generated file is placed in this directory, with the filename itself being the buffer’s name, with % replaced by %% and / replaced by %, and postfixed with the extension .json.

Plugin default: "{__raw = \"vim.fn.stdpath('data') .. '/magma'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.show_mimetype_debug

If this is true, then before any non-iostream output chunk, Magma shows the mimetypes it received for it. This is meant for debugging and adding new mimetypes.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.magma-nvim.settings.wrap_output

If this is true, then text output in the output window will be wrapped (akin to set wrap).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mark-radar.enable

Whether to enable mark-radar.

Type: boolean

Default: false

Example: true

Declared by:

plugins.mark-radar.package

Which package to use for the mark-radar plugin.

Type: package

Default: <derivation vimplugin-mark-radar.nvim-2024-02-29>

Declared by:

plugins.mark-radar.backgroundHighlight

Whether to highlight the background.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mark-radar.backgroundHighlightGroup

The name of the highlight group to use for the background.

Plugin default: "RadarBackground"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.mark-radar.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.mark-radar.highlightGroup

The name of the highlight group to use.

Plugin default: "RadarMark"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.mark-radar.setDefaultMappings

Whether to set default mappings.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

markdown-preview

Url: https://github.com/iamcco/markdown-preview.nvim/

Maintainers: Gaetan Lepage

plugins.markdown-preview.enable

Whether to enable markdown-preview.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.markdown-preview.package

Which package to use for the markdown-preview plugin.

Type: package

Default: <derivation vimplugin-markdown-preview.nvim-2023-10-17>

Declared by:

plugins.markdown-preview.settings

The configuration options for markdown-preview without the mkdp_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal mkdp_foo_bar=1
  • hello = "world" -> :setglobal mkdp_hello="world"
  • some_toggle = true -> :setglobal mkdp_some_toggle
  • other_toggle = false -> :setglobal nomkdp_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  auto_close = true;
  auto_start = true;
  browser = "firefox";
  echo_preview_url = true;
  highlight_css = {
    __raw = "vim.fn.expand('~/highlight.css')";
  };
  markdown_css = "/Users/username/markdown.css";
  page_title = "「\${name}」";
  port = "8080";
  preview_options = {
    disable_filename = true;
    disable_sync_scroll = true;
    sync_scroll_type = "middle";
  };
  theme = "dark";
}

Declared by:

plugins.markdown-preview.settings.auto_close

Auto close current preview window when change from markdown buffer to another buffer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.auto_start

Open the preview window after entering the markdown buffer.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.browser

The browser to open the preview page.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.browser_func

A custom vim function name to open preview page. This function will receive url as param.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.combine_preview

Combine preview window. If enable it will reuse previous opened preview window when you preview markdown file. Ensure to set auto_close = false if you have enable this option.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.combine_preview_auto_refresh

Auto refetch combine preview contents when change markdown buffer only when combine_preview is true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.command_for_global

Enable markdown preview for all files (by default, the plugin is only enabled for markdown files).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.echo_preview_url

Echo preview page url in command line when opening the preview page.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.filetypes

Recognized filetypes. These filetypes will have MarkdownPreview... commands.

Plugin default: ["markdown"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.highlight_css

Custom highlight style. Must be an absolute path like “/Users/username/highlight.css” or {__raw = "vim.fn.expand('~/highlight.css')";}.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.images_path

Use a custom location for images.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.markdown_css

Custom markdown style. Must be an absolute path like "/Users/username/markdown.css" or {__raw = "vim.fn.expand('~/markdown.css')";}.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.open_ip

Custom IP used to open the preview page. This can be useful when you work in remote vim and preview on local browser. For more detail see: https://github.com/iamcco/markdown-preview.nvim/pull/9.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.open_to_the_world

Make the preview server available to others in your network. By default, the server listens on localhost (127.0.0.1).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.page_title

Preview page title. $${name} will be replaced with the file name.

Plugin default: "「\${name}」"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.port

Custom port to start server or empty for random.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.refresh_slow

Refresh markdown when save the buffer or leave from insert mode, default false is auto refresh markdown as you edit or move the cursor.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.theme

Default theme (dark or light). By default the theme is define according to the preferences of the system.

Type: null or one of “dark”, “light”

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options

Preview options

Type: null or (attribute set)

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.content_editable

Content editable from the preview page.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.disable_filename

Disable filename header for the preview page.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.disable_sync_scroll

Disable sync scroll.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.flowchart_diagrams

flowcharts diagrams options.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.hide_yaml_meta

Hide yaml metadata.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.katex

katex options for math.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.maid

mermaid options.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.mkit

markdown-it options for render.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.sequence_diagrams

js-sequence-diagrams options.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.sync_scroll_type

Scroll type:

  • “middle”: The cursor position is always shown at the middle of the preview page.
  • “top”: The vim top viewport is always shown at the top of the preview page.
  • “relative”: The cursor position is always shown at the relative position of the preview page.

Plugin default: "middle"

Type: null or one of “middle”, “top”, “relative” or raw lua code

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.toc

Toc options.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.markdown-preview.settings.preview_options.uml

markdown-it-plantuml options.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.marks.enable

Whether to enable marks.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.marks.package

Which package to use for the marks.nvim plugin.

Type: package

Default: <derivation vimplugin-marks.nvim-2024-01-07>

Declared by:

plugins.marks.builtinMarks

Which builtin marks to track and show. If set, these marks will also show up in the signcolumn and will update on |CursorMoved|.

Plugin default: []

Type: null or (list of (one of “'”, “^”, “.”, “<”, “>” or raw lua code))

Default: null

Declared by:

plugins.marks.cyclic

Whether forward/backwards movement should cycle back to the beginning/end of buffer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.marks.defaultMappings

Whether to use the default plugin mappings or not. See |marks-mappings| for more.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.marks.excludedBuftypes

Which buftypes to ignore. If a buffer with this buftype is opened, then marks.nvim will not track any marks set in this buffer, and will not display any signs. Setting and moving to marks with ` or ’ will still work, but movement commands like “m]” or “m[” will not.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.marks.excludedFiletypes

Which filetypes to ignore. If a buffer with this filetype is opened, then marks.nvim will not track any marks set in this buffer, and will not display any signs. Setting and moving to marks with ` or ’ will still work, but movement commands like “m]” or “m[” will not.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.marks.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.marks.forceWriteShada

If true, then deleting global (uppercase) marks will also update the |shada| file accordingly and force deletion of the mark permanently. This option can be destructive and should be set only after reading more about the shada file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.marks.mappings

Custom mappings. Set a mapping to false to disable it.

Plugin default: {}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.marks.refreshInterval

How often (in ms) marks.nvim should update the marks list and recompute mark positions/redraw signs. Lower values means that mark positions and signs will refresh much quicker, but may incur a higher performance penalty, whereas higher values may result in better performance, but may also cause noticeable lag in signs updating.

Plugin default: 150

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.marks.signPriority

The sign priority to be used for marks. Can either be a number, in which case the priority applies to all types of marks, or a table with some or all of the following keys:

  • lower: sign priority for lowercase marks
  • upper: sign priority for uppercase marks
  • builtin: sign priority for builtin marks
  • bookmark: sign priority for bookmarks

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or (attribute set)

Default: null

Declared by:

plugins.marks.signs

Whether to show marks in the signcolumn or not. If set to true, its recommended to also set |signcolumn| to “auto”, for cases where multiple marks are placed on the same line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.marks.bookmarks

Configuration table for each bookmark group (see |marks-bookmarks|).

Type: attribute set of (submodule)

Default: { }

Declared by:

plugins.marks.bookmarks.<name>.annotate

When true, explicitly prompts the user for an annotation that will be displayed above the bookmark.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.marks.bookmarks.<name>.sign

The character to use in the signcolumn for this bookmark group.

Defaults to “!@#$%^&*()” - in order from group 1 to 10. Set to false to turn off signs for this bookmark.

Type: null or string or value false (singular enum)

Default: null

Declared by:

plugins.marks.bookmarks.<name>.virtText

Virtual text annotations to place at the eol of a bookmark. Defaults to null, meaning no virtual text.

Type: null or string

Default: null

Declared by:

plugins.mini.enable

Whether to enable mini.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.mini.package

Which package to use for the mini.nvim plugin.

Type: package

Default: <derivation vimplugin-mini.nvim-2024-05-12>

Declared by:

plugins.mini.modules

Enable and configure the mini modules. The keys are the names of the modules (without the mini. prefix). The value is an attrs of configuration options for the module. Leave the attrs empty to use the module’s default configuration.

Type: attribute set of (attribute set)

Default: { }

Example:

{
  ai = {
    n_lines = 50;
    search_method = "cover_or_next";
  };
  surround = { };
}

Declared by:

plugins.mkdnflow.enable

Whether to enable mkdnflow.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.mkdnflow.package

Which package to use for the mkdnflow.nvim plugin.

Type: package

Default: <derivation vimplugin-mkdnflow.nvim-2024-04-25>

Declared by:

plugins.mkdnflow.createDirs

  • true: Directories referenced in a link will be (recursively) created if they do not exist.
  • false: No action will be taken when directories referenced in a link do not exist. Neovim will open a new file, but you will get an error when you attempt to write the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.mkdnflow.filetypes

A matching extension will enable the plugin’s functionality for a file with that extension.

NOTE: This functionality references the file’s extension. It does not rely on Neovim’s filetype recognition. The extension must be provided in lower case because the plugin converts file names to lowercase. Any arbitrary extension can be supplied. Setting an extension to false is the same as not including it in the list.

Plugin default: {md = true; rmd = true; markdown = true;}

Type: null or (attribute set of boolean)

Default: null

Declared by:

plugins.mkdnflow.mappings

An attrs declaring the key mappings. The keys should be the name of a commands defined in mkdnflow.nvim/plugin/mkdnflow.lua (see :h Mkdnflow-commands for a list). Set to false to disable a mapping.

Plugin default:

{
  MkdnEnter = {
    modes = ["n" "v" "i"];
    key = "<CR>";
  };
  MkdnTab = false;
  MkdnSTab = false;
  MkdnNextLink = {
    modes = "n";
    key = "<Tab>";
  };
  MkdnPrevLink = {
    modes = "n";
    key = "<S-Tab>";
  };
  MkdnNextHeading = {
    modes = "n";
    key = "]]";
  };
  MkdnPrevHeading = {
    modes = "n";
    key = "[[";
  };
  MkdnGoBack = {
    modes = "n";
    key = "<BS>";
  };
  MkdnGoForward = {
    modes = "n";
    key = "<Del>";
  };
  MkdnFollowLink = false; # see MkdnEnter
  MkdnCreateLink = false; # see MkdnEnter
  MkdnCreateLinkFromClipboard = {
    modes = ["n" "v"];
    key = "<leader>p";
  }; # see MkdnEnter
  MkdnDestroyLink = {
    modes = "n";
    key = "<M-CR>";
  };
  MkdnMoveSource = {
    modes = "n";
    key = "<F2>";
  };
  MkdnYankAnchorLink = {
    modes = "n";
    key = "ya";
  };
  MkdnYankFileAnchorLink = {
    modes = "n";
    key = "yfa";
  };
  MkdnIncreaseHeading = {
    modes = "n";
    key = "+";
  };
  MkdnDecreaseHeading = {
    modes = "n";
    key = "-";
  };
  MkdnToggleToDo = {
    modes = ["n" "v"];
    key = "<C-Space>";
  };
  MkdnNewListItem = false;
  MkdnNewListItemBelowInsert = {
    modes = "n";
    key = "o";
  };
  MkdnNewListItemAboveInsert = {
    modes = "n";
    key = "O";
  };
  MkdnExtendList = false;
  MkdnUpdateNumbering = {
    modes = "n";
    key = "<leader>nn";
  };
  MkdnTableNextCell = {
    modes = "i";
    key = "<Tab>";
  };
  MkdnTablePrevCell = {
    modes = "i";
    key = "<S-Tab>";
  };
  MkdnTableNextRow = false;
  MkdnTablePrevRow = {
    modes = "i";
    key = "<M-CR>";
  };
  MkdnTableNewRowBelow = {
    modes = "n";
    key = "<leader>ir";
  };
  MkdnTableNewRowAbove = {
    modes = "n";
    key = "<leader>iR";
  };
  MkdnTableNewColAfter = {
    modes = "n";
    key = "<leader>ic";
  };
  MkdnTableNewColBefore = {
    modes = "n";
    key = "<leader>iC";
  };
  MkdnFoldSection = {
    modes = "n";
    key = "<leader>f";
  };
  MkdnUnfoldSection = {
    modes = "n";
    key = "<leader>F";
  };
}

Type: null or (attribute set of (value false (singular enum) or (submodule)))

Default: null

Declared by:

plugins.mkdnflow.silent

  • true: The plugin will not display any messages in the console except compatibility warnings related to your config.
  • false: The plugin will display messages to the console (all messages from the plugin start with ⬇️ ).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.wrap

  • true: When jumping to next/previous links or headings, the cursor will continue searching at the beginning/end of the file.
  • false: When jumping to next/previous links or headings, the cursor will stop searching at the end/beginning of the file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.bib.defaultPath

Specifies a path to a default .bib file to look for citation keys in (need not be in root directory of notebook).

Type: null or string

Default: null

Declared by:

plugins.mkdnflow.bib.findInRoot

  • true: When perspective.priority is also set to root (and a root directory was found), the plugin will search for bib files to reference in the notebook’s top-level directory. If bib.default_path is also specified, the default path will be appended to the list of bib files found in the top level directory so that it will also be searched.
  • false: The notebook’s root directory will not be searched for bib files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.links.conceal

  • true: Link sources and delimiters will be concealed (depending on which link style is selected)
  • false: Link sources and delimiters will not be concealed by mkdnflow

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.links.context

  • 0 (default): When following or jumping to links, assume that no link will be split over multiple lines
  • n: When following or jumping to links, consider n lines before and after a given line (useful if you ever permit links to be interrupted by a hard line break)

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.mkdnflow.links.implicitExtension

A string that instructs the plugin (a) how to interpret links to files that do not have an extension, and (b) that new links should be created without an explicit extension.

Type: null or string

Default: null

Declared by:

plugins.mkdnflow.links.style

  • markdown: Links will be expected in the standard markdown format: [<title>](<source>)
  • wiki: Links will be expected in the unofficial wiki-link style, specifically the title-after-pipe format (see https://github.com/jgm/pandoc/pull/7705): [[<source>|<title>]].

Plugin default: "markdown"

Type: null or one of “markdown”, “wiki” or raw lua code

Default: null

Declared by:

plugins.mkdnflow.links.transformExplicit

A function that transforms the text to be inserted as the source/path of a link when a link is created. Anchor links are not currently customizable. If you want all link paths to be explicitly prefixed with the year, for instance, and for the path to be converted to uppercase, you could provide the following function under this key. (NOTE: The previous functionality specified under the prefix key has been migrated here to provide greater flexibility.)

Example:

  function(input)
      return(string.upper(os.date('%Y-')..input))
  end

Plugin default: false

Type: null or lua function string or value false (singular enum)

Default: null

Declared by:

plugins.mkdnflow.links.transformImplicit

A function that transforms the path of a link immediately before interpretation. It does not transform the actual text in the buffer but can be used to modify link interpretation. For instance, link paths that match a date pattern can be opened in a journals subdirectory of your notebook, and all others can be opened in a pages subdirectory, using the following function:

  function(input)
      if input:match('%d%d%d%d%-%d%d%-%d%d') then
          return('journals/'..input)
      else
          return('pages/'..input)
      end
  end

Plugin default:

function(text)
    text = text:gsub(" ", "-")
    text = text:lower()
    text = os.date('%Y-%m-%d_')..text
    return(text)
end

Type: null or lua function string or value false (singular enum)

Default: null

Declared by:

plugins.mkdnflow.modules.bib

Enable module bib. Required for parsing bib files and following citations.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.buffers

Enable module buffers. Required for backward and forward navigation through buffers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.conceal

Enable module conceal. Required if you wish to enable link concealing. Note that you must declare links.conceal as true in addition to enabling this module if you wish to conceal links.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.cursor

Enable module cursor. Required for jumping to links and headings; yanking anchor links.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.folds

Enable module folds. Required for folding by section.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

Enable module links. Required for creating and destroying links and following links.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.lists

Enable module lists. Required for manipulating lists, toggling to-do list items, etc.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.maps

Enable module maps. Required for setting mappings via the mappings table. Set to false if you wish to set mappings outside of the plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.paths

Enable module paths. Required for link interpretation and following links.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.tables

Enable module tables. Required for table navigation and formatting.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.modules.yaml

Enable module yaml. Required for parsing yaml blocks.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.perspective.fallback

Specifies the backup perspective to take if priority isn’t possible (e.g. if it is root but no root directory is found).

  • first (default): Links will be interpreted relative to the first-opened file (when the current instance of Neovim was started)
  • current: Links will be interpreted relative to the current file
  • root: Links will be interpreted relative to the root directory of the current notebook (requires perspective.root_tell to be specified)

Plugin default: "first"

Type: null or one of “first”, “current”, “root” or raw lua code

Default: null

Declared by:

plugins.mkdnflow.perspective.nvimWdHeel

Specifies whether changes in perspective will result in corresponding changes to Neovim’s working directory.

  • true: Changes in perspective will be reflected in the nvim working directory. (In other words, the working directory will “heel” to the plugin’s perspective.) This helps ensure (at least) that path completions (if using a completion plugin with support for paths) will be accurate and usable.
  • false (default): Neovim’s working directory will not be affected by Mkdnflow.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.perspective.priority

Specifies the priority perspective to take when interpreting link paths

  • first (default): Links will be interpreted relative to the first-opened file (when the current instance of Neovim was started)
  • current: Links will be interpreted relative to the current file
  • root: Links will be interpreted relative to the root directory of the current notebook (requires perspective.root_tell to be specified)

Plugin default: "first"

Type: null or one of “first”, “current”, “root” or raw lua code

Default: null

Declared by:

plugins.mkdnflow.perspective.rootTell

  • <any file name>: Any arbitrary filename by which the plugin can uniquely identify the root directory of the current notebook.
  • If false is used instead, the plugin will never search for a root directory, even if perspective.priority is set to root.

Plugin default: false

Type: null or value false (singular enum) or string

Default: null

Declared by:

plugins.mkdnflow.perspective.update

Determines whether the plugin looks to determine if a followed link is in a different notebook/wiki than before. If it is, the perspective will be updated. Requires rootTell to be defined and priority to be root.

  • true (default): Perspective will be updated when following a link to a file in a separate notebook/wiki (or navigating backwards to a file in another notebook/wiki).
  • false: Perspective will be not updated when following a link to a file in a separate notebook/wiki. Under the hood, links in the file in the separate notebook/wiki will be interpreted relative to the original notebook/wiki.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.tables.autoExtendCols

Whether a new column should automatically be added to a table when :MkdnTableNextCell is triggered when the cursor is in the final column of the table. If false, the cursor will jump to the first cell of the next row, unless the cursor is already in the last row, in which case nothing will happen.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.tables.autoExtendRows

Whether a new row should automatically be added to a table when :MkdnTableNextRow is triggered when the cursor is in the final row of the table. If false, the cursor will simply leave the table for the next line.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.tables.formatOnMove

Whether tables should be formatted each time the cursor is moved via MkdnTableNext/PrevCell or MkdnTableNext/Prev/Row.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.tables.trimWhitespace

Whether extra whitespace should be trimmed from the end of a table cell when a table is formatted.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.toDo.complete

This option can be used to stipulate which symbols shall be used when updating a parent to-do’s status when a child to-do’s status is changed. This is not required: if toDo.symbols is customized but this option is not provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order.

For example, if you set toDo.symbols as [" " "⧖" "✓"], " " will be assigned to toDo.notStarted, “⧖” will be assigned to toDo.inProgress, etc. If more than three symbols are specified, the first will be used as notStarted, the second will be used as inProgress, and the last will be used as complete. If two symbols are provided (e.g. " ", "✓"), the first will be used as both notStarted and inProgress, and the second will be used as complete.

toDo.complete stipulates which symbol represents a complete to-do.

Plugin default: "X"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.mkdnflow.toDo.inProgress

This option can be used to stipulate which symbols shall be used when updating a parent to-do’s status when a child to-do’s status is changed. This is not required: if toDo.symbols is customized but this option is not provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order.

For example, if you set toDo.symbols as [" " "⧖" "✓"], " " will be assigned to toDo.notStarted, “⧖” will be assigned to toDo.inProgress, etc. If more than three symbols are specified, the first will be used as notStarted, the second will be used as inProgress, and the last will be used as complete. If two symbols are provided (e.g. " ", "✓"), the first will be used as both notStarted and inProgress, and the second will be used as complete.

toDo.inProgress stipulates which symbol represents an in-progress to-do.

Plugin default: "-"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.mkdnflow.toDo.notStarted

This option can be used to stipulate which symbols shall be used when updating a parent to-do’s status when a child to-do’s status is changed. This is not required: if toDo.symbols is customized but this option is not provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order.

For example, if you set toDo.symbols as [" " "⧖" "✓"], " " will be assigned to toDo.notStarted, “⧖” will be assigned to toDo.inProgress, etc. If more than three symbols are specified, the first will be used as notStarted, the second will be used as inProgress, and the last will be used as complete. If two symbols are provided (e.g. " ", "✓"), the first will be used as both notStarted and inProgress, and the second will be used as complete.

toDo.notStarted stipulates which symbol represents a not-yet-started to-do.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.mkdnflow.toDo.symbols

A list of symbols (each no more than one character) that represent to-do list completion statuses. MkdnToggleToDo references these when toggling the status of a to-do item. Three are expected: one representing not-yet-started to-dos (default: ' '), one representing in-progress to-dos (default: -), and one representing complete to-dos (default: X).

NOTE: Native Lua support for UTF-8 characters is limited, so in order to ensure all functionality works as intended if you are using non-ascii to-do symbols, you’ll need to install the luarocks module “luautf8”.

Plugin default: [" " "-" "X"]

Type: null or (list of string)

Default: null

Declared by:

plugins.mkdnflow.toDo.updateParents

Whether parent to-dos’ statuses should be updated based on child to-do status changes performed via MkdnToggleToDo

  • true (default): Parent to-do statuses will be inferred and automatically updated when a child to-do’s status is changed
  • false: To-do items can be toggled, but parent to-do statuses (if any) will not be automatically changed

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.mkdnflow.yaml.bib.override

Whether or not a bib path specified in a yaml block should be the only source considered for bib references in that file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

molten

Url: https://github.com/benlubas/molten-nvim/

Maintainers: Gaetan Lepage

plugins.molten.enable

Whether to enable molten-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.molten.package

Which package to use for the molten plugin.

Type: package

Default: <derivation vimplugin-molten-nvim-2024-05-10>

Declared by:

plugins.molten.python3Dependencies

Python packages to add to the PYTHONPATH of neovim.

Type: function that evaluates to a(n) list of package

Default:

p: with p; [
  pynvim
  jupyter-client
  cairosvg
  ipython
  nbformat
]

Declared by:

plugins.molten.settings

The configuration options for molten without the molten_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal molten_foo_bar=1
  • hello = "world" -> :setglobal molten_hello="world"
  • some_toggle = true -> :setglobal molten_some_toggle
  • other_toggle = false -> :setglobal nomolten_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  auto_open_output = true;
  copy_output = false;
  enter_output_behavior = "open_then_enter";
  image_provider = "none";
  output_crop_border = true;
  output_show_more = false;
  output_virt_lines = false;
  output_win_border = [
    ""
    "━"
    ""
    ""
  ];
  output_win_cover_gutter = true;
  output_win_hide_on_leave = true;
  output_win_style = false;
  save_path = {
    __raw = "vim.fn.stdpath('data')..'/molten'";
  };
  show_mimetype_debug = false;
  use_border_highlights = false;
  virt_lines_off_by1 = false;
  wrap_output = false;
}

Declared by:

plugins.molten.settings.auto_image_popup

When true, cells that produce an image output will open the image output automatically with python’s Image.show().

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.auto_init_behavior

When set to “raise” commands which would otherwise ask for a kernel when they’re run without a running kernel will instead raise an exception. Useful for other plugins that want to use pcall and do their own error handling.

Plugin default: "init"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.molten.settings.auto_open_html_in_browser

Automatically open HTML outputs in a browser. related: open_cmd.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.auto_open_output

Automatically open the floating output window when your cursor moves into a cell.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.copy_output

Copy evaluation output to clipboard automatically (requires pyperclip).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.cover_empty_lines

The output window and virtual text will be shown just below the last line of code in the cell.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.cover_lines_starting_with

When cover_empty_lines is true, also covers lines starting with these strings.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.molten.settings.enter_output_behavior

The behavior of MoltenEnterOutput.

Plugin default: "open_then_enter"

Type: null or one of “open_then_enter”, “open_and_enter”, “no_open” or raw lua code

Default: null

Declared by:

plugins.molten.settings.image_provider

How images are displayed.

Plugin default: "none"

Type: null or one of “none”, “image.nvim” or raw lua code

Default: null

Declared by:

plugins.molten.settings.limit_output_chars

Limit on the number of chars in an output. If you’re lagging your editor with too much output text, decrease it.

Plugin default: 1000000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.molten.settings.open_cmd

Defaults to xdg-open on Linux, open on Darwin, and start on Windows. But you can override it to whatever you want. The command is called like: subprocess.run([open_cmd, filepath])

Type: null or string

Default: null

Declared by:

plugins.molten.settings.output_crop_border

‘crops’ the bottom border of the output window when it would otherwise just sit at the bottom of the screen.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_show_more

When the window can’t display the entire contents of the output buffer, shows the number of extra lines in the window footer (requires nvim 10.0+ and a window border).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_virt_lines

Pad the main buffer with virtual lines so the floating window doesn’t cover anything while it’s open.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_border

Defines the border to use for output window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: ["" "━" "" ""]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_cover_gutter

Should the output window cover the gutter (numbers and sign col), or not. If you change this, you probably also want to change output_win_style.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_hide_on_leave

After leaving the output window (via :q or switching windows), do not attempt to redraw the output window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_max_height

Max height of the output window.

Plugin default: 999999

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_max_width

Max width of the output window.

Plugin default: 999999

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.molten.settings.output_win_style

Value passed to the style option in :h nvim_open_win().

Plugin default: false

Type: null or one of false, “minimal” or raw lua code

Default: null

Declared by:

plugins.molten.settings.save_path

Where to save/load data with :MoltenSave and :MoltenLoad.

Plugin default: "{__raw = \"vim.fn.stdpath('data')..'/molten'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.molten.settings.show_mimetype_debug

Before any non-iostream output chunk, the mime-type for that output chunk is shown. Meant for debugging/plugin development.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.tick_rate

How often (in ms) we poll the kernel for updates. Determines how quickly the ui will update, if you want a snappier experience, you can set this to 150 or 200.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.molten.settings.use_border_highlights

When true, uses different highlights for output border depending on the state of the cell (running, done, error).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.virt_lines_off_by_1

Allows the output window to cover exactly one line of the regular buffer when output_virt_lines is true, also effects where virt_text_output is displayed. (useful for running code in a markdown file where that covered line will just be ```).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.virt_text_max_lines

Max height of the virtual text.

Plugin default: 12

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.molten.settings.virt_text_output

When true, show output as virtual text below the cell, virtual text stays after leaving the cell. When true, output window doesn’t open automatically on run. Effected by virt_lines_off_by_1.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.molten.settings.wrap_output

Wrap output text.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.multicursors.enable

Whether to enable multicursors.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.multicursors.package

Which package to use for the multicursors.nvim plugin.

Type: package

Default: <derivation vimplugin-multicursors.nvim-2024-04-12>

Declared by:

plugins.multicursors.createCommands

Create Multicursor user commands.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.multicursors.debugMode

Enable debug mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.multicursors.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.multicursors.nowait

see :help :map-nowait.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.multicursors.updatetime

Selections get updated if this many milliseconds nothing is typed in the insert mode see :help updatetime.

Plugin default: 50

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.multicursors.extendKeys

Insert mode key mappings.

Default: see the README.md

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.multicursors.extendKeys.<name>.method

Assigning "nil" exits from multi cursor mode. Assigning false removes the binding

Type: string or value false (singular enum)

Example:

''
  function()
    require('multicursors.utils').call_on_selections(
      function(selection)
        vim.api.nvim_win_set_cursor(0, { selection.row + 1, selection.col + 1 })
        local line_count = selection.end_row - selection.row + 1
        vim.cmd('normal ' .. line_count .. 'gcc')
      end
    )
  end
''

Declared by:

plugins.multicursors.extendKeys.<name>.opts

You can pass :map-arguments here.

Type: attribute set of string

Default: { }

Example:

{
  desc = "comment selections";
}

Declared by:

plugins.multicursors.generateHints.extend

Hints for extend mode.

Accepted values:

  • true: generate hints
  • false: don’t generate hints
  • str: provide your own hints

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.multicursors.generateHints.insert

Hints for insert mode.

Accepted values:

  • true: generate hints
  • false: don’t generate hints
  • str: provide your own hints

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.multicursors.generateHints.normal

Hints for normal mode.

Accepted values:

  • true: generate hints
  • false: don’t generate hints
  • str: provide your own hints

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.multicursors.hintConfig.border

Defines the border to use for the hint window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: none

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.multicursors.hintConfig.funcs

Attrs where keys are function names and values are functions themselves. Each function should return string. This functions can be required from hint with %{func_name} syntaxis.

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.multicursors.hintConfig.offset

The offset from the nearest editor border. (valid when type if "window").

Type: null or signed integer

Default: null

Declared by:

plugins.multicursors.hintConfig.position

Set the position of the hint.

Plugin default: "bottom"

Type: null or one of “top-left”, “top”, “top-right”, “middle-left”, “middle”, “middle-right”, “bottom-left”, “bottom”, “bottom-right” or raw lua code

Default: null

Declared by:

plugins.multicursors.hintConfig.showName

Show hydras name or HYDRA: label at the beginning of an auto-generated hint.

Type: null or boolean

Default: null

Declared by:

plugins.multicursors.hintConfig.type

  • “window”: show hint in a floating window;
  • “cmdline”: show hint in a echo area;
  • “statusline”: show auto-generated hint in the statusline.

Type: null or one of “window”, “cmdline”, “statusline”

Default: null

Declared by:

plugins.multicursors.insertKeys

Insert mode key mappings.

Default: see the README.md

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.multicursors.insertKeys.<name>.method

Assigning "nil" exits from multi cursor mode. Assigning false removes the binding

Type: string or value false (singular enum)

Example:

''
  function()
    require('multicursors.utils').call_on_selections(
      function(selection)
        vim.api.nvim_win_set_cursor(0, { selection.row + 1, selection.col + 1 })
        local line_count = selection.end_row - selection.row + 1
        vim.cmd('normal ' .. line_count .. 'gcc')
      end
    )
  end
''

Declared by:

plugins.multicursors.insertKeys.<name>.opts

You can pass :map-arguments here.

Type: attribute set of string

Default: { }

Example:

{
  desc = "comment selections";
}

Declared by:

plugins.multicursors.normalKeys

Normal mode key mappings.

Default: see the README.md

Example:

  {
    # to change default lhs of key mapping, change the key
    "," = {
      # assigning `null` to method exits from multi cursor mode
      # assigning `false` to method removes the binding
      method = "require 'multicursors.normal_mode'.clear_others";

      # you can pass :map-arguments here
      opts = { desc = "Clear others"; };
    };
    "<C-/>" = {
        method = \'\'
          function()
            require('multicursors.utils').call_on_selections(
              function(selection)
                vim.api.nvim_win_set_cursor(0, { selection.row + 1, selection.col + 1 })
                local line_count = selection.end_row - selection.row + 1
                vim.cmd('normal ' .. line_count .. 'gcc')
              end
            )
          end
        \'\';
        opts = { desc = "comment selections"; };
    };
  }

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.multicursors.normalKeys.<name>.method

Assigning "nil" exits from multi cursor mode. Assigning false removes the binding

Type: string or value false (singular enum)

Example:

''
  function()
    require('multicursors.utils').call_on_selections(
      function(selection)
        vim.api.nvim_win_set_cursor(0, { selection.row + 1, selection.col + 1 })
        local line_count = selection.end_row - selection.row + 1
        vim.cmd('normal ' .. line_count .. 'gcc')
      end
    )
  end
''

Declared by:

plugins.multicursors.normalKeys.<name>.opts

You can pass :map-arguments here.

Type: attribute set of string

Default: { }

Example:

{
  desc = "comment selections";
}

Declared by:

plugins.navbuddy.enable

Whether to enable nvim-navbuddy.

Type: boolean

Default: false

Example: true

Declared by:

plugins.navbuddy.package

Which package to use for the nvim-navbuddy plugin.

Type: package

Default: <derivation vimplugin-nvim-navbuddy-2024-03-24>

Declared by:

plugins.navbuddy.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.navbuddy.keymapsSilent

Whether navbuddy keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.navbuddy.mappings

Actions to be triggered for specified keybindings. It can take either action name i.e toggle_preview Or it can a rawLua.

Plugin default:

{
  "<esc>" = "close";
  "q" = "close";
  "j" = "next_sibling";
  "k" = "previous_sibling";

  "h" = "parent";
  "l" = "children";
  "0" = "root";

  "v" = "visual_name";
  "V" = "visual_scope";

  "y" = "yank_name";
  "Y" = "yank_scope";

  "i" = "insert_name";
  "I" = "insert_scope";

  "a" = "append_name";
  "A" = "append_scope";

  "r" = "rename";

  "d" = "delete";

  "f" = "fold_create";
  "F" = "fold_delete";

  "c" = "comment";

  "<enter>" = "select";
  "o" = "select";
  "J" = "move_down";
  "K" = "move_up";

  "s" = "toggle_preview";

  "<C-v>" = "vsplit";
  "<C-s>" = "hsplit";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.navbuddy.useDefaultMapping

If set to false, only mappings set by user are set. Else default mappings are used for keys that are not set by user

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Array

icon for Array.

Plugin default: "󰅪 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Boolean

icon for Boolean.

Plugin default: "◩ "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Class

icon for Class.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Constant

icon for Constant.

Plugin default: "󰏿 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Constructor

icon for Constructor.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Enum

icon for Enum.

Plugin default: "󰕘"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.EnumMember

icon for EnumMember.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Event

icon for Event.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Field

icon for Field.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.File

icon for File.

Plugin default: "󰈙 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Function

icon for Function.

Plugin default: "󰊕 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Interface

icon for Interface.

Plugin default: "󰕘"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Key

icon for Key.

Plugin default: "󰌋 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Method

icon for Method.

Plugin default: "󰆧 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Module

icon for Module.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Namespace

icon for Namespace.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Null

icon for Null.

Plugin default: "󰟢 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Number

icon for Number.

Plugin default: "󰎠 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Object

icon for Object.

Plugin default: "󰅩 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Operator

icon for Operator.

Plugin default: "󰆕 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Package

icon for Package.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Property

icon for Property.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.String

icon for String.

Plugin default: "󰀬 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Struct

icon for Struct.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.TypeParameter

icon for TypeParameter.

Plugin default: "󰊄 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.icons.Variable

icon for Variable.

Plugin default: "󰆧 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.lsp.autoAttach

If set to true, you don’t need to manually use attach function

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navbuddy.lsp.preference

list of lsp server names in order of preference

Type: null or (list of string)

Default: null

Declared by:

plugins.navbuddy.nodeMarkers.enabled

Enable node markers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navbuddy.nodeMarkers.icons.branch

The icon to use for branch nodes.

Plugin default: "  "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.nodeMarkers.icons.leaf

The icon to use for leaf nodes.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.nodeMarkers.icons.leafSelected

The icon to use for selected leaf node.

Plugin default: " → "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navbuddy.sourceBuffer.followNode

Keep the current node in focus on the source buffer

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navbuddy.sourceBuffer.highlight

Highlight the currently focused node

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navbuddy.sourceBuffer.reorient

Right section can show previews too. Options: “leaf”, “always” or “never”

Plugin default: "smart"

Type: null or one of “smart”, “top”, “mid”, “none” or raw lua code

Default: null

Declared by:

plugins.navbuddy.sourceBuffer.scrolloff

scrolloff value when navbuddy is open.

Plugin default: null

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.navbuddy.window.border

“rounded”, “double”, “solid”, “none” or an array with eight chars building up the border in a clockwise fashion starting with the top-left corner. eg: { “╔”, “═” ,“╗”, “║”, “╝”, “═”, “╚”, “║” }.

Defines the border to use for window border. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.navbuddy.window.position

The position of the window.

Plugin default: 50

Type: null or integer between 0 and 100 (both inclusive) or (submodule)

Default: null

Declared by:

plugins.navbuddy.window.scrolloff

scrolloff value within navbuddy window

Type: null or signed integer

Default: null

Declared by:

plugins.navbuddy.window.size

The size of the window.

Plugin default: 60

Type: null or integer between 0 and 100 (both inclusive) or (submodule)

Default: null

Declared by:

plugins.navbuddy.window.sections.left.border

“rounded”, “double”, “solid”, “none” or an array with eight chars building up the border in a clockwise fashion starting with the top-left corner. eg: { “╔”, “═” ,“╗”, “║”, “╝”, “═”, “╚”, “║” }.

Defines the border to use for left section border. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.navbuddy.window.sections.left.size

The height size (in %).

Plugin default: 20

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.navbuddy.window.sections.mid.border

“rounded”, “double”, “solid”, “none” or an array with eight chars building up the border in a clockwise fashion starting with the top-left corner. eg: { “╔”, “═” ,“╗”, “║”, “╝”, “═”, “╚”, “║” }.

Defines the border to use for mid section border. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.navbuddy.window.sections.mid.size

The height size (in %).

Plugin default: 40

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.navbuddy.window.sections.right.border

“rounded”, “double”, “solid”, “none” or an array with eight chars building up the border in a clockwise fashion starting with the top-left corner. eg: { “╔”, “═” ,“╗”, “║”, “╝”, “═”, “╚”, “║” }.

Defines the border to use for right section border. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.navbuddy.window.sections.right.preview

Right section can show previews too. Options: “leaf”, “always” or “never”

Plugin default: "leaf"

Type: null or one of “leaf”, “always”, “never” or raw lua code

Default: null

Declared by:

plugins.navic.enable

Whether to enable nvim-navic.

Type: boolean

Default: false

Example: true

Declared by:

plugins.navic.package

Which package to use for the nvim-navic plugin.

Type: package

Default: <derivation vimplugin-nvim-navic-2023-11-30>

Declared by:

plugins.navic.click

Single click to goto element, double click to open nvim-navbuddy on the clicked element.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navic.depthLimit

Maximum depth of context to be shown. If the context hits this depth limit, it is truncated.

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.navic.depthLimitIndicator

Icon to indicate that depth_limit was hit and the shown context is truncated.

Plugin default: ".."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.navic.highlight

If set to true, will add colors to icons and text as defined by highlight groups NavicIcons* (NavicIconsFile, NavicIconsModule… etc.), NavicText and NavicSeparator.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navic.lazyUpdateContext

If true, turns off context updates for the “CursorMoved” event.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navic.safeOutput

Sanitize the output for use in statusline and winbar.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navic.separator

Icon to separate items. to use between items.

Plugin default: " > "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Array

icon for Array.

Plugin default: "󰅪 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Boolean

icon for Boolean.

Plugin default: "◩ "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Class

icon for Class.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Constant

icon for Constant.

Plugin default: "󰏿 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Constructor

icon for Constructor.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Enum

icon for Enum.

Plugin default: "󰕘"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.EnumMember

icon for EnumMember.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Event

icon for Event.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Field

icon for Field.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.File

icon for File.

Plugin default: "󰈙 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Function

icon for Function.

Plugin default: "󰊕 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Interface

icon for Interface.

Plugin default: "󰕘"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Key

icon for Key.

Plugin default: "󰌋 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Method

icon for Method.

Plugin default: "󰆧 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Module

icon for Module.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Namespace

icon for Namespace.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Null

icon for Null.

Plugin default: "󰟢 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Number

icon for Number.

Plugin default: "󰎠 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Object

icon for Object.

Plugin default: "󰅩 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Operator

icon for Operator.

Plugin default: "󰆕 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Package

icon for Package.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Property

icon for Property.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.String

icon for String.

Plugin default: "󰀬 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Struct

icon for Struct.

Plugin default: "󰌗 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.TypeParameter

icon for TypeParameter.

Plugin default: "󰊄 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.icons.Variable

icon for Variable.

Plugin default: "󰆧 "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.navic.lsp.autoAttach

Enable to have nvim-navic automatically attach to every LSP for current buffer. Its disabled by default.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.navic.lsp.preference

Table ranking lsp_servers. Lower the index, higher the priority of the server. If there are more than one server attached to a buffer. In the example below will prefer clangd over pyright

Example: [ "clangd" "pyright" ].

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.enable

Whether to enable neo-tree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neo-tree.enableDiagnostics

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableGitStatus

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableModifiedMarkers

Show markers for files with unsaved changes.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableRefreshOnWrite

Refresh the tree when a file is written. Only used if use_libuv_file_watcher is false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.package

Which package to use for the neo-tree plugin.

Type: package

Default: <derivation vimplugin-neo-tree.nvim-2024-05-15>

Declared by:

plugins.neo-tree.addBlankLineAtTop

Add a blank line at the top of the tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.autoCleanAfterSessionRestore

Automatically clean up broken neo-tree buffers saved in sessions

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.closeIfLastWindow

Close Neo-tree if it is the last window left in the tab

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultSource

Plugin default: "filesystem"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.eventHandlers

Configuration of event handlers. Attrs:

  • keys are the events (e.g. before_render, file_opened)
  • values are lua code defining the callback function.

Example:

{
  before_render = \'\'
    function (state)
      -- add something to the state that can be used by custom components
    end
  \'\';

  file_opened = \'\'
    function(file_path)
      --auto close
      require("neo-tree").close_all()
    end
  \'\';
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.neo-tree.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.neo-tree.extraSources

Extra sources to be added to the sources. This is an internal nixvim option.

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.gitStatusAsync

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.hideRootNode

Hide the root node.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.logLevel

Plugin default: "info"

Type: null or one of “trace”, “debug”, “info”, “warn”, “error”, “fatal” or raw lua code

Default: null

Declared by:

plugins.neo-tree.logToFile

use :NeoTreeLogs to show the file

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.neo-tree.nestingRules

nesting rules

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.neo-tree.openFilesInLastWindow

If false, open files in top left window

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.popupBorderStyle

Plugin default: "NC"

Type: null or one of “NC”, “double”, “none”, “rounded”, “shadow”, “single”, “solid” or raw lua code

Default: null

Declared by:

plugins.neo-tree.resizeTimerInterval

In ms, needed for containers to redraw right aligned and faded content. Set to -1 to disable the resize timer entirely.

NOTE: this will speed up to 50 ms for 1 second following a resize

Plugin default: 500

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.retainHiddenRootIndent

If the root node is hidden, keep the indentation anyhow. This is needed if you use expanders because they render in the indent.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sortCaseInsensitive

Used when sorting files and directories in the tree

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sortFunction

Uses a custom function for sorting files and directories in the tree

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.neo-tree.sources

If a user has a sources list it will replace this one. Only sources listed here will be loaded. You can also add an external source by adding it’s name to this list. The name used here must be the same name you would use in a require() call.

Plugin default: ["filesystem" "buffers" "git_status"]

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.useDefaultMappings

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.usePopupsForInput

If false, inputs will use vim.ui.input() instead of custom floats.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.buffers.bindToCwd

Bind to current working directory.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.buffers.groupEmptyDirs

When true, empty directories will be grouped together.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.buffers.followCurrentFile.enabled

This will find and focus the file in the active buffer every time the current file is changed while the tree is open.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.buffers.followCurrentFile.leaveDirsOpen

false closes auto expanded dirs, such as with :Neotree reveal.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.buffers.window.mappings

Mapping options

Plugin default:

{
  "<bs>" = "navigate_up";
  "." = "set_root";
  bd = "buffer_delete";
}

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.container.enableCharacterFade

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.container.rightPadding

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.container.width

Plugin default: "100%"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.error

Plugin default: "DiagnosticSignError"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.hint

Plugin default: "DiagnosticSignHint"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.info

Plugin default: "DiagnosticSignInfo"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.warn

Plugin default: "DiagnosticSignWarn"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.error

Plugin default: "X"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.hint

Plugin default: "H"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.info

Plugin default: "I"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.warn

Plugin default: "!"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.align

icon alignment

Plugin default: "right"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.added

added

Plugin default: "✚"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.conflict

conflict

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.deleted

deleted

Plugin default: "✖"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.ignored

ignored

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.modified

modified

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.renamed

renamed

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.staged

staged

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.unstaged

unstaged

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.untracked

untracked

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.default

Only a fallback, if you use nvim-web-devicons and configure default icons there then this will never be used.

Plugin default: "*"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.folderClosed

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.folderEmpty

Plugin default: "ﰊ"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.folderEmptyOpen

Plugin default: "ﰊ"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.folderOpen

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.icon.highlight

Only a fallback, if you use nvim-web-devicons and configure default icons there then this will never be used.

Plugin default: "NeoTreeFileIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.expanderCollapsed

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.expanderExpanded

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.expanderHighlight

Plugin default: "NeoTreeExpander"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.highlight

Plugin default: "NeoTreeIndentMarker"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.indentMarker

Plugin default: "│"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.indentSize

Plugin default: 2

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.lastIndentMarker

Plugin default: "└"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.padding

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.withExpanders

If null and file nesting is enabled, will enable expanders.

Plugin default: null

Type: null or boolean

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.indent.withMarkers

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.modified.highlight

Plugin default: "NeoTreeModified"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.modified.symbol

Plugin default: "[+] "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.name.highlight

Plugin default: "NeoTreeFileName"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.name.trailingSlash

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultComponentConfigs.name.useGitStatusColors

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.documentSymbols.customKinds

A table mapping the LSP kind id (an integer) to the LSP kind name that is used for kinds.

For the list of kinds (id and name), please refer to https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentSymbol

Type: attribute set of string

Default: { }

Example:

{
  "252" = "TypeAlias";
}

Declared by:

plugins.neo-tree.documentSymbols.followCursor

If set to true, will automatically focus on the symbol under the cursor.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.documentSymbols.kinds

An attrs specifying how LSP kinds should be rendered. Each entry should map the LSP kind name to an icon and a highlight group, for example Class = { icon = ""; hl = "Include"; }

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.neo-tree.documentSymbols.kinds.<name>.hl

Highlight group for this LSP kind.

Type: string

Example: "Include"

Declared by:

plugins.neo-tree.documentSymbols.kinds.<name>.icon

Icon for this LSP kind.

Type: string

Example: ""

Declared by:

plugins.neo-tree.documentSymbols.window.mappings

Mapping options

Plugin default: {}

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.example.renderers.custom

custom renderers

Plugin default:

[
  "indent"
  {
    name = "icon";
    default = "C";
  }
  "custom"
  "name"
]

Type: null or (list of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.example.window.mappings

Mapping options

Plugin default:

{
  "<cr>" = "toggle_node";
  "<C-e>" = "example_command";
  d = "show_debug_info";
}

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.filesystem.asyncDirectoryScan

  • “auto” means refreshes are async, but it’s synchronous when called from the Neotree commands.
  • “always” means directory scans are always async.
  • “never” means directory scans are never async.

Plugin default: "auto"

Type: null or one of “auto”, “always”, “never” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.bindToCwd

true creates a 2-way binding between vim’s cwd and neo-tree’s root.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.findArgs

Find arguments

Either use a list of strings:

findArgs = {
  fd = [
    "--exclude"
    ".git"
    "--exclude"
    "node_modules"
  ];
};

Or use a function instead of list of strings

findArgs = \'\'
  find_args = function(cmd, path, search_term, args)
    if cmd ~= "fd" then
      return args
    end
    --maybe you want to force the filter to always include hidden files:
    table.insert(args, "--hidden")
    -- but no one ever wants to see .git files
    table.insert(args, "--exclude")
    table.insert(args, ".git")
    -- or node_modules
    table.insert(args, "--exclude")
    table.insert(args, "node_modules")
    --here is where it pays to use the function, you can exclude more for
    --short search terms, or vary based on the directory
    if string.len(search_term) < 4 and path == "/home/cseickel" then
      table.insert(args, "--exclude")
      table.insert(args, "Library")
    end
    return args
  end
\'\';

Type: null or lua function string or (submodule)

Default: null

Declared by:

plugins.neo-tree.filesystem.findByFullPathWords

false means it only searches the tail of a path. true will change the filter into a full path

search with space as an implicit “.*”, so fi init will match: `./sources/filesystem/init.lua

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.findCommand

This is determined automatically, you probably don’t need to set it

Plugin default: "fd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.groupEmptyDirs

when true, empty folders will be grouped together

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.hijackNetrwBehavior

  • “open_default”: netrw disabled, opening a directory opens neo-tree in whatever position is specified in window.position
  • “open_current”: netrw disabled, opening a directory opens within the window like netrw would, regardless of window.position
  • “disabled”: netrw left alone, neo-tree does not handle opening dirs

Plugin default: "open_default"

Type: null or one of “open_default”, “open_current”, “disabled” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.scanMode

  • “shallow”: Don’t scan into directories to detect possible empty directory a priori.
  • “deep”: Scan into directories to detect empty or grouped empty directories a priori.

Plugin default: "shallow"

Type: null or one of “shallow”, “deep” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.searchLimit

max number of search results when using filters

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.useLibuvFileWatcher

This will use the OS level file watchers to detect changes instead of relying on nvim autocmd events.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.cwdTarget.current

current is when position = current

Plugin default: "window"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.cwdTarget.sidebar

sidebar is when position = left or right

Plugin default: "tab"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.alwaysShow

Files/folders to always show.

Example: [".gitignore"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.forceVisibleInEmptyFolder

when true, hidden files will be shown if the root folder is otherwise empty

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.hideByName

hide by name

Plugin default: [".DS_Store" "thumbs.db"]

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.hideByPattern

Hide by pattern.

Example:

  [
    "*.meta"
    "*/src/*/tsconfig.json"
  ]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.hideDotfiles

hide dotfiles

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.hideGitignored

hide gitignored files

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.hideHidden

only works on Windows for hidden files/directories

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.neverShow

Files/folders to never show.

Example: [".DS_Store" "thumbs.db"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.neverShowByPattern

Files/folders to never show (by pattern).

Example: [".null-ls_*"]

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.showHiddenCount

when true, the number of hidden items in each folder will be shown as the last entry

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.filteredItems.visible

when true, they will just be displayed differently than normal items

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.followCurrentFile.enabled

This will find and focus the file in the active buffer every time the current file is changed while the tree is open.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.followCurrentFile.leaveDirsOpen

false closes auto expanded dirs, such as with :Neotree reveal.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.window.mappings

Mapping options

Plugin default:

```nix
  {
    H = "toggle_hidden";
    "/" = "fuzzy_finder";
    D = "fuzzy_finder_directory";
    # "/" = "filter_as_you_type"; # this was the default until v1.28
    "#" = "fuzzy_sorter"; # fuzzy sorting using the fzy algorithm
    # D = "fuzzy_sorter_directory";
    f = "filter_on_submit";
    "<C-x>" = "clear_filter";
    "<bs>" = "navigate_up";
    "." = "set_root";
    "[g" = "prev_git_modified";
    "]g" = "next_git_modified";
  }

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.gitStatus.window.mappings

Mapping options

Plugin default:

{
  A = "git_add_all";
  gu = "git_unstage_file";
  ga = "git_add_file";
  gr = "git_revert_file";
  gc = "git_commit";
  gp = "git_push";
  gg = "git_commit_and_push";
}

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.gitStatusAsyncOptions.batchDelay

delay in ms between batches. Spreads out the workload to let other processes run.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.gitStatusAsyncOptions.batchSize

How many lines of git status results to process at a time

Plugin default: 1000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.gitStatusAsyncOptions.maxLines

How many lines of git status results to process. Anything after this will be dropped. Anything before this will be used. The last items to be processed are the untracked files.

Plugin default: 10000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.renderers.directory

directory renderers

Plugin default:

[
  "indent"
  "icon"
  "current_filter"
  {
    name = "container";
    content = [
      {
        name = "name";
        zindex = 10;
      }
      {
        name = "clipboard";
        zindex = 10;
      }
      {
        name = "diagnostics";
        errors_only = true;
        zindex = 20;
        align = "right";
        hide_when_expanded = true;
      }
      {
        name = "git_status";
        zindex = 20;
        align = "right";
        hide_when_expanded = true;
      }
    ];
  }
]

Type: null or (list of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.renderers.file

file renderers

Plugin default:

[
  "indent"
  "icon"
  {
    name = "container";
    content = [
      {
        name = "name";
        zindex = 10;
      }
      {
        name = "clipboard";
        zindex = 10;
      }
      {
        name = "bufnr";
        zindex = 10;
      }
      {
        name = "modified";
        zindex = 20;
        align = "right";
      }
      {
        name = "diagnostics";
        zindex = 20;
        align = "right";
      }
      {
        name = "git_status";
        zindex = 20;
        align = "right";
      }
    ];
  }
]

Type: null or (list of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.renderers.message

message renderers

Plugin default:

[
  {
    name = "indent";
    with_markers = false;
  }
  {
    name = "name";
    highlight = "NeoTreeMessage";
  }
]

Type: null or (list of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.renderers.terminal

message renderers

Plugin default:

[
  "indent"
  "icon"
  "name"
  "bufnr"
]

Type: null or (list of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.sourceSelector.contentLayout

Defines how the labels are placed inside a tab. This only takes effect when the tab width is greater than the length of label i.e. tabsLayout = "equal", "focus" or when tabsMinWidth is large enough.

Following options are available. “start” : left aligned / 裡 bufname /… “end” : right aligned / 裡 bufname /… “center” : centered with equal padding / 裡 bufname /…

Plugin default: "start"

Type: null or one of “start”, “end”, “focus” or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.highlightBackground

Plugin default: "NeoTreeTabInactive"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.highlightSeparator

Plugin default: "NeoTreeTabSeparatorInactive"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.highlightSeparatorActive

Plugin default: "NeoTreeTabSeparatorActive"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.highlightTab

Plugin default: "NeoTreeTabInactive"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.highlightTabActive

Plugin default: "NeoTreeTabActive"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.padding

Defines the global padding of the source selector. It can be an integer or an attrs with keys left and right. Setting padding = 2 is exactly the same as { left = 2; right = 2; }.

Example: { left = 2; right = 0; }

Plugin default: 0

Type: null or signed integer or attribute set of signed integer

Default: null

Declared by:

plugins.neo-tree.sourceSelector.separator

{ left = “▏”; right= “▕”; }

Plugin default: Can be a string or a table

Type: null or string or (submodule)

Default: null

Declared by:

plugins.neo-tree.sourceSelector.separatorActive

Set separators around the active tab. null falls back to sourceSelector.separator.

Plugin default: null

Type: null or string or (submodule)

Default: null

Declared by:

plugins.neo-tree.sourceSelector.showScrolledOffParentNode

If true, tabs are replaced with the parent path of the top visible node when scrolled down.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.showSeparatorOnEdge

Takes a boolean value where false (default) hides the separators on the far left / right. Especially useful when left and right separator are the same.

'true'  : ┃/    ~    \/    ~    \/    ~    \┃
'false' : ┃     ~    \/    ~    \/    ~     ┃

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.statusline

toggle to show selector on statusline

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.tabsLayout

Defines how the tabs are aligned inside the window when there is more than enough space. The following options are available. active will expand the focused tab as much as possible. Bars denote the edge of window.

"start"  : left aligned                                       ┃/  ~  \/  ~  \/  ~  \            ┃
"end"    : right aligned                                      ┃            /  ~  \/  ~  \/  ~  \┃
"center" : centered with equal padding                        ┃      /  ~  \/  ~  \/  ~  \      ┃
"equal"  : expand all tabs equally to fit the window width    ┃/    ~    \/    ~    \/    ~    \┃
"active" : expand the focused tab to fit the window width     ┃/  focused tab    \/  ~  \/  ~  \┃

Plugin default: "equal"

Type: null or one of “start”, “end”, “center”, “equal”, “focus” or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.tabsMaxWidth

This will truncate text even if textTruncToFit = false

Plugin default: null

Type: null or signed integer

Default: null

Declared by:

plugins.neo-tree.sourceSelector.tabsMinWidth

If int padding is added based on contentLayout

Plugin default: null

Type: null or signed integer

Default: null

Declared by:

plugins.neo-tree.sourceSelector.truncationCharacter

Character to use when truncating the tab label

Plugin default: "…"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.winbar

toggle to show selector on winbar

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sourceSelector.sources

Configure the characters shown on each tab.

Type: null or (list of (submodule))

Default: null

Declared by:

plugins.neo-tree.sourceSelector.sources.*.displayName

How that source to appear in the bar.

Type: null or string

Default: null

Declared by:

plugins.neo-tree.sourceSelector.sources.*.source

Name of the source to add to the bar.

Type: string

Declared by:

plugins.neo-tree.window.autoExpandWidth

Expand the window when file exceeds the window width. does not work with position = “float”

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.height

Applies to top and bottom positions

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.insertAs

Affects how nodes get inserted into the tree during creation/pasting/moving of files if the node under the cursor is a directory:

  • “child”: Insert nodes as children of the directory under cursor.
  • “sibling”: Insert nodes as siblings of the directory under cursor.

Plugin default: "child"

Type: null or one of “child”, “sibling” or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.mappings

Mapping options

Plugin default:

```nix
  {
    "<space>" = {
      command = "toggle_node";
      # disable `nowait` if you have existing combos starting with this char that you want to use
      nowait = false;
    };
    "<2-LeftMouse>" = "open";
    "<cr>" = "open";
    "<esc>" = "revert_preview";
    P = {
      command = "toggle_preview";
      config = { use_float = true; };
    };
    l = "focus_preview";
    S = "open_split";
    # S = "split_with_window_picker";
    s = "open_vsplit";
    # s = "vsplit_with_window_picker";
    t = "open_tabnew";
    # "<cr>" = "open_drop";
    # t = "open_tab_drop";
    w = "open_with_window_picker";
    C = "close_node";
    z = "close_all_nodes";
    # Z = "expand_all_nodes";
    R = "refresh";
    a = {
      command = "add";
      # some commands may take optional config options, see `:h neo-tree-mappings` for details
      config = {
        show_path = "none"; # "none", "relative", "absolute"
      };
    };
    A = "add_directory"; # also accepts the config.show_path and config.insert_as options.
    d = "delete";
    r = "rename";
    y = "copy_to_clipboard";
    x = "cut_to_clipboard";
    p = "paste_from_clipboard";
    c = "copy"; # takes text input for destination, also accepts the config.show_path and config.insert_as options
    m = "move"; # takes text input for destination, also accepts the config.show_path and config.insert_as options
    e = "toggle_auto_expand_width";
    q = "close_window";
    "?" = "show_help";
    "<" = "prev_source";
    ">" = "next_source";
  }

Type: null or (attribute set of (string or (attribute set)))

Default: null

Declared by:

plugins.neo-tree.window.position

position

Plugin default: "left"

Type: null or one of “left”, “right”, “top”, “bottom”, “float”, “current” or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.sameLevel

Create and paste/move files/directories on the same level as the directory under cursor (as opposed to within the directory under cursor).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.width

Applies to left and right positions

Plugin default: 40

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.mappingOptions.noremap

noremap

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.mappingOptions.nowait

nowait

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.popup.position

50% means center it. You can also specify border here, if you want a different setting from the global popupBorderStyle.

Plugin default: "80%"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.popup.size.height

height

Plugin default: "80%"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.window.popup.size.width

height

Plugin default: "50%"

Type: null or string or raw lua code

Default: null

Declared by:

neocord

Url: https://github.com/IogaMaster/neocord/

plugins.neocord.enable

Whether to enable neocord.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neocord.package

Which package to use for the neocord plugin.

Type: package

Default: <derivation vimplugin-neocord-2024-04-24>

Declared by:

plugins.neocord.settings

Options provided to the require('neocord').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  auto_update = true;
  blacklist = [ ];
  client_id = "1157438221865717891";
  debounce_timeout = 10;
  editing_text = "Editing...";
  enable_line_number = false;
  file_assets = null;
  file_explorer_text = "Browsing...";
  git_commit_text = "Committing changes...";
  global_timer = false;
  line_number_text = "Line %s out of %s";
  log_level = null;
  logo = "auto";
  logo_tooltip = null;
  main_image = "language";
  plugin_manager_text = "Managing plugins...";
  reading_text = "Reading...";
  show_time = true;
  terminal_text = "Using Terminal...";
  workspace_text = "Working on %s";
}

Declared by:

plugins.neocord.settings.enable_line_number

Displays the current line number instead of the current project.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neocord.settings.auto_update

Update activity based on autocmd events. If false, map or manually execute :lua package.loaded.neocord:update()

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neocord.settings.blacklist

A list of strings or Lua patterns that disable Rich Presence if the current file name, path, or workspace matches.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neocord.settings.buttons

Button configurations which will always appear in Rich Presence. Can be a list of attribute sets, each with the following attributes: label: The label of the button. e.g. "GitHub Profile". url: The URL the button leads to. e.g. "https://github.com/<NAME>". Can also be a lua function: function(buffer: string, repo_url: string|nil): table

Plugin default: []

Type: null or raw lua code or list of (submodule)

Default: null

Declared by:

plugins.neocord.settings.client_id

Use your own Discord application client id. (not recommended)

Plugin default: "1157438221865717891"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.debounce_timeout

Number of seconds to debounce events. (or calls to :lua package.loaded.neocord:update(<filename>, true))

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neocord.settings.editing_text

String rendered when an editable file is loaded in the buffer. Can also be a lua function: function(filename: string): string

Plugin default: "Editing %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.file_assets

Custom file asset definitions keyed by file names and extensions. List elements for each attribute (filetype): name: The name of the asset shown as the title of the file in Discord. source: The source of the asset, either an art asset key or the URL of an image asset. Example:

  {
    # Use art assets uploaded in Discord application for the configured client id
    js = [ "JavaScript" "javascript" ];
    ts = [ "TypeScript" "typescript" ];
    # Use image URLs
    rs = [ "Rust" "https://www.rust-lang.org/logos/rust-logo-512x512.png" ];
    go = [ "Go" "https://go.dev/blog/go-brand/Go-Logo/PNG/Go-Logo_Aqua.png" ];
  };

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.neocord.settings.file_explorer_text

String rendered when browsing a file explorer. Can also be a lua function: function(file_explorer_name: string): string

Plugin default: "Browsing %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.git_commit_text

String rendered when committing changes in git. Can also be a lua function: function(filename: string): string

Plugin default: "Committing changes"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.global_timer

if set true, timer won’t update when any event are triggered.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neocord.settings.line_number_text

String rendered when enableLineNumber is set to true to display the current line number. Can also be a lua function: function(line_number: number, line_count: number): string

Plugin default: "Line %s out of %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.log_level

Log messages at or above this level.

Plugin default: null

Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code

Default: null

Declared by:

Update the Logo to the specified option (“auto” or url).

Plugin default: "auto"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.logo_tooltip

Sets the logo tooltip

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.main_image

Main image display (either “language” or “logo”)

Plugin default: "language"

Type: null or one of “language”, “logo” or raw lua code

Default: null

Declared by:

plugins.neocord.settings.plugin_manager_text

String rendered when managing plugins. Can also be a lua function: function(plugin_manager_name: string): string

Plugin default: "Managing plugins"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.reading_text

String rendered when a read-only/unmodifiable file is loaded into the buffer. Can also be a lua function: function(filename: string): string

Plugin default: "Reading %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.show_time

Show the timer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neocord.settings.terminal_text

Format string rendered when in terminal mode.

Plugin default: "Using Terminal"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neocord.settings.workspace_text

String rendered when in a git repository. Can also be a lua function: function(project_name: string|nil, filename: string): string

Plugin default: "Working on %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.enable

Whether to enable neogen.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neogen.enablePlaceholders

If true, enables placeholders when inserting annotation

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogen.package

Which package to use for the neogen plugin.

Type: package

Default: <derivation vimplugin-neogen-2024-05-13>

Declared by:

plugins.neogen.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.neogen.inputAfterComment

If true, go to annotation after insertion, and change to insert mode

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogen.keymapsSilent

Whether Neogen keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.neogen.languages

Configuration for languages.

template.annotation_convention (default: check the language default configurations): Change the annotation convention to use with the language.

template.use_default_comment (default: true): Prepend any template line with the default comment for the filetype

template.position (fun(node: userdata, type: string):(number,number)?): Provide an absolute position for the annotation. If return values are nil, use default position

template.append: If you want to customize the position of the annotation.

template.append.child_name: What child node to use for appending the annotation.

template.append.position (before/after): Relative positioning with child_name.

template.<convention_name> (replace <convention_name> with an annotation convention): Template for an annotation convention. To know more about how to create your own template, go here: https://github.com/danymat/neogen/blob/main/docs/adding-languages.md#default-generator

Example:

  {
    csharp = {
      template = {
        annotation_convention = "...";
      };
    };
  }

Plugin default: see upstream documentation

Type: null or (attribute set)

Default: null

Declared by:

plugins.neogen.placeholderHighlight

Placeholders highlights to use. If you don’t want custom highlight, pass “None”

Plugin default: "DiagnosticHint"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.snippetEngine

Use a snippet engine to generate annotations. Some snippet engines come out of the box bundled with neogen:

  • "luasnip" (https://github.com/L3MON4D3/LuaSnip)
  • "snippy" (https://github.com/dcampos/nvim-snippy)
  • "vsnip" (https://github.com/hrsh7th/vim-vsnip)

Type: null or string

Default: null

Declared by:

plugins.neogen.keymaps.generate

The only function required to use Neogen.

It’ll try to find the first parent that matches a certain type. For example, if you are inside a function, and called generate({ type = "func" }), Neogen will go until the start of the function and start annotating for you.

Type: null or string

Default: null

Declared by:

plugins.neogen.keymaps.generateClass

Generates annotation for class.

Type: null or string

Default: null

Declared by:

plugins.neogen.keymaps.generateFile

Generates annotation for file.

Type: null or string

Default: null

Declared by:

plugins.neogen.keymaps.generateFunction

Generates annotation for function.

Type: null or string

Default: null

Declared by:

plugins.neogen.keymaps.generateType

Generates annotation for type.

Type: null or string

Default: null

Declared by:

plugins.neogen.placeholdersText.args

Placeholder for args.

Plugin default: "[TODO:args]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.attribute

Placeholder for attribute.

Plugin default: "[TODO:attribute]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.class

Placeholder for class.

Plugin default: "[TODO:class]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.description

Placeholder for description.

Plugin default: "[TODO:description]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.kwargs

Placeholder for kwargs.

Plugin default: "[TODO:kwargs]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.parameter

Placeholder for parameter.

Plugin default: "[TODO:parameter]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.return

Placeholder for return.

Plugin default: "[TODO:return]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.throw

Placeholder for throw.

Plugin default: "[TODO:throw]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.tparam

Placeholder for tparam.

Plugin default: "[TODO:tparam]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.type

Placeholder for type.

Plugin default: "[TODO:type]"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogen.placeholdersText.varargs

Placeholder for varargs.

Plugin default: "[TODO:varargs]"

Type: null or string or raw lua code

Default: null

Declared by:

neogit

Url: https://github.com/NeogitOrg/neogit/

Maintainers: Gaetan Lepage

plugins.neogit.enable

Whether to enable neogit.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neogit.package

Which package to use for the neogit plugin.

Type: package

Default: <derivation vimplugin-neogit-v0.0.1>

Declared by:

plugins.neogit.settings

Options provided to the require('neogit').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  commit_popup = {
    kind = "floating";
  };
  disable_builtin_notifications = true;
  disable_commit_confirmation = true;
  integrations = {
    diffview = false;
  };
  kind = "floating";
  mappings = {
    status = {
      a = "Stage";
      l = "Toggle";
    };
  };
  popup = {
    kind = "floating";
  };
  preview_buffer = {
    kind = "floating";
  };
  sections = {
    recent = {
      folded = true;
    };
    staged = {
      folded = false;
    };
    stashes = {
      folded = false;
    };
    unmerged = {
      folded = true;
    };
    unpulled = {
      folded = false;
    };
    unstaged = {
      folded = false;
    };
    untracked = {
      folded = false;
    };
  };
}

Declared by:

plugins.neogit.settings.auto_refresh

Neogit refreshes its internal state after specific events, which can be expensive depending on the repository size. Disabling auto_refresh will make it so you have to manually refresh the status after you open it.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.auto_show_console

Automatically show console if a command takes more than consoleTimeout milliseconds.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.console_timeout

The time after which an output console is shown for slow running commands.

Plugin default: 2000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neogit.settings.disable_context_highlighting

Disables changing the buffer highlights based on where the cursor is.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.disable_hint

Hides the hints at the top of the status buffer.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.disable_insert_on_commit

Changes what mode the Commit Editor starts in. true will leave nvim in normal mode, false will change nvim to insert mode, and "auto" will change nvim to insert mode IF the commit message is empty, otherwise leaving it in normal mode.

Plugin default: auto

Type: null or boolean or value “auto” (singular enum)

Default: null

Declared by:

plugins.neogit.settings.disable_line_numbers

Disable line numbers and relative line numbers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.disable_signs

Disables signs for sections/items/hunks.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.fetch_after_checkout

Perform a fetch if the newly checked out branch has an upstream or pushRemote set.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.git_services

Used to generate URL’s for branch popup action ‘pull request’.

Plugin default:

{
  "github.com" = "https://github.com/$\{owner}/$\{repository}/compare/$\{branch_name}?expand=1";
  "bitbucket.org" = "https://bitbucket.org/$\{owner}/$\{repository}/pull-requests/new?source=$\{branch_name}&t=1";
  "gitlab.com" = "https://gitlab.com/$\{owner}/$\{repository}/merge_requests/new?merge_request[source_branch]=$\{branch_name}";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.graph_style

  • “ascii” is the graph the git CLI generates
  • “unicode” is the graph like https://github.com/rbong/vim-flog

Plugin default: "ascii"

Type: null or one of “ascii”, “unicode” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.ignored_settings

Table of settings to never persist. Uses format “Filetype–cli-value”.

Plugin default:

[
  "NeogitPushPopup--force-with-lease"
  "NeogitPushPopup--force"
  "NeogitPullPopup--rebase"
  "NeogitCommitPopup--allow-empty"
  "NeogitRevertPopup--no-edit"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.kind

Change the default way of opening neogit.

Plugin default: "tab"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.notification_icon

Icon for notifications.

Plugin default: "󰊢"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogit.settings.remember_settings

Persist the values of switches/options within and across sessions.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.sort_branches

Value used for --sort option for git branch command. By default, branches will be sorted by commit date descending. Flag description: https://git-scm.com/docs/git-branch#Documentation/git-branch.txt—sortltkeygt Sorting keys: https://git-scm.com/docs/git-for-each-ref#_options

Plugin default: "-committerdate"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neogit.settings.telescope_sorter

Allows a different telescope sorter. Defaults to ‘fuzzy_with_index_bias’. The example below will use the native fzf sorter instead. By default, this function returns nil.

Example:

  require("telescope").extensions.fzf.native_fzf_sorter

Type: null or lua code string

Default: null

Declared by:

plugins.neogit.settings.use_default_keymaps

Set to false if you want to be responsible for creating ALL keymappings.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.use_per_project_settings

Scope persisted settings on a per-project basis.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.commit_editor.kind

The type of window that should be opened.

Plugin default: "auto"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.commit_select_view.kind

The type of window that should be opened.

Plugin default: "tab"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.commit_view.kind

The type of window that should be opened.

Plugin default: "vsplit"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.commit_view.verify_commit

Show commit signature information in the buffer. Can be set to true or false, otherwise we try to find the binary.

Default: “os.execute(‘which gpg’) == 0”

Type: null or lua code string or boolean

Default: null

Declared by:

plugins.neogit.settings.description_editor.kind

The type of window that should be opened.

Plugin default: "auto"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.filewatcher.enabled

When enabled, will watch the .git/ directory for changes and refresh the status buffer in response to filesystem events.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.filewatcher.interval

Interval between two refreshes.

Plugin default: 1000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neogit.settings.highlight.bold

Set the bold property of the highlight group.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.highlight.italic

Set the italic property of the highlight group.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.highlight.underline

Set the underline property of the highlight group.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neogit.settings.integrations.diffview

Neogit only provides inline diffs. If you want a more traditional way to look at diffs, you can use diffview. The diffview integration enables the diff popup.

Type: null or boolean

Default: null

Declared by:

plugins.neogit.settings.integrations.fzf-lua

If enabled, uses fzf-lua for menu selection. If the telescope integration is also selected then telescope is used instead.

Type: null or boolean

Default: null

Declared by:

plugins.neogit.settings.integrations.telescope

If enabled, use telescope for menu selection rather than vim.ui.select. Allows multi-select and some things that vim.ui.select doesn’t.

Type: null or boolean

Default: null

Declared by:

plugins.neogit.settings.log_view.kind

The type of window that should be opened.

Plugin default: "tab"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.mappings.commit_editor

Mappings for the commit editor.

Plugin default:

{
  q = "Close";
  "<c-c><c-c>" = "Submit";
  "<c-c><c-k>" = "Abort";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.mappings.finder

Mappings for the finder.

Plugin default:

{
  "<cr>" = "Select";
  "<c-c>" = "Close";
  "<esc>" = "Close";
  "<c-n>" = "Next";
  "<c-p>" = "Previous";
  "<down>" = "Next";
  "<up>" = "Previous";
  "<tab>" = "MultiselectToggleNext";
  "<s-tab>" = "MultiselectTogglePrevious";
  "<c-j>" = "NOP";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.mappings.popup

Mappings for popups.

Plugin default:

{
  "?" = "HelpPopup";
  A = "CherryPickPopup";
  D = "DiffPopup";
  M = "RemotePopup";
  P = "PushPopup";
  X = "ResetPopup";
  Z = "StashPopup";
  b = "BranchPopup";
  c = "CommitPopup";
  f = "FetchPopup";
  l = "LogPopup";
  m = "MergePopup";
  p = "PullPopup";
  r = "RebasePopup";
  v = "RevertPopup";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.mappings.rebase_editor

Mappings for the rebase editor.

Plugin default:

{
  p = "Pick";
  r = "Reword";
  e = "Edit";
  s = "Squash";
  f = "Fixup";
  x = "Execute";
  d = "Drop";
  b = "Break";
  q = "Close";
  "<cr>" = "OpenCommit";
  gk = "MoveUp";
  gj = "MoveDown";
  "<c-c><c-c>" = "Submit";
  "<c-c><c-k>" = "Abort";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.mappings.status

Mappings for status.

Plugin default:

{
  q = "Close";
  I = "InitRepo";
  "1" = "Depth1";
  "2" = "Depth2";
  "3" = "Depth3";
  "4" = "Depth4";
  "<tab>" = "Toggle";
  x = "Discard";
  s = "Stage";
  S = "StageUnstaged";
  "<c-s>" = "StageAll";
  u = "Unstage";
  U = "UnstageStaged";
  "$" = "CommandHistory";
  "#" = "Console";
  Y = "YankSelected";
  "<c-r>" = "RefreshBuffer";
  "<enter>" = "GoToFile";
  "<c-v>" = "VSplitOpen";
  "<c-x>" = "SplitOpen";
  "<c-t>" = "TabOpen";
  "{" = "GoToPreviousHunkHeader";
  "}" = "GoToNextHunkHeader";
}

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.merge_editor.kind

The type of window that should be opened.

Plugin default: "auto"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.popup.kind

The type of window that should be opened.

Plugin default: "split"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.preview_buffer.kind

The type of window that should be opened.

Plugin default: "split"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.rebase_editor.kind

The type of window that should be opened.

Plugin default: "auto"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.reflog_view.kind

The type of window that should be opened.

Plugin default: "tab"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neogit.settings.sections.rebase

Settings for the rebase section

Type: null or (submodule)

Default:

{
  folded = true;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.rebase.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.rebase.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.recent

Settings for the recent section

Type: null or (submodule)

Default:

{
  folded = true;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.recent.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.recent.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.sequencer

Settings for the sequencer section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.sequencer.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.sequencer.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.staged

Settings for the staged section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.staged.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.staged.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.stashes

Settings for the stashes section

Type: null or (submodule)

Default:

{
  folded = true;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.stashes.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.stashes.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unmerged_pushRemote

Settings for the unmerged_pushRemote section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.unmerged_pushRemote.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unmerged_pushRemote.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unmerged_upstream

Settings for the unmerged_upstream section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.unmerged_upstream.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unmerged_upstream.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unpulled_pushRemote

Settings for the unpulled_pushRemote section

Type: null or (submodule)

Default:

{
  folded = true;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.unpulled_pushRemote.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unpulled_pushRemote.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unpulled_upstream

Settings for the unpulled_upstream section

Type: null or (submodule)

Default:

{
  folded = true;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.unpulled_upstream.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unpulled_upstream.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unstaged

Settings for the unstaged section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.unstaged.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.unstaged.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.sections.untracked

Settings for the untracked section

Type: null or (submodule)

Default:

{
  folded = false;
  hidden = false;
}

Declared by:

plugins.neogit.settings.sections.untracked.folded

Whether or not this section should be open or closed by default.

Type: boolean

Declared by:

plugins.neogit.settings.sections.untracked.hidden

Whether or not this section should be shown.

Type: boolean

Declared by:

plugins.neogit.settings.signs.hunk

The icons to use for open and closed hunks.

Plugin default: ["" ""]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.signs.item

The icons to use for open and closed items.

Plugin default: [">" "v"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.signs.section

The icons to use for open and closed sections.

Plugin default: [">" "v"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neogit.settings.status.recent_commit_count

Recent commit count in the status buffer.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neogit.settings.tag_editor.kind

The type of window that should be opened.

Plugin default: "auto"

Type: null or one of “split”, “vsplit”, “split_above”, “tab”, “floating”, “replace”, “auto” or raw lua code

Default: null

Declared by:

plugins.neorg.enable

Whether to enable neorg.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neorg.package

Which package to use for the neorg plugin.

Type: package

Default: <derivation vimplugin-neorg-2024-05-13>

Declared by:

plugins.neorg.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.neorg.lazyLoading

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neorg.modules

Modules configuration.

Type: attribute set of (attribute set)

Default: { }

Example:

{
  "core.defaults" = {
    __empty = null;
  };
  "core.dirman" = {
    config = {
      workspaces = {
        home = "~/notes/home";
        work = "~/notes/work";
      };
    };
  };
}

Declared by:

plugins.neorg.logger.floatPrecision

Can limit the number of decimals displayed for floats

Plugin default: 0.01

Type: null or floating point number

Default: null

Declared by:

plugins.neorg.logger.highlights

Should highlighting be used in console (using echohl)

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neorg.logger.level

Any messages above this level will be logged

Plugin default: "warn"

Type: null or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn” or raw lua code

Default: null

Declared by:

plugins.neorg.logger.plugin

Name of the plugin. Prepended to log messages

Plugin default: "neorg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.useConsole

Should print the output to neovim while running

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neorg.logger.useFile

Should write to a file

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.debug

Settings for mode debug.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.debug.hl

Highlight for mode debug.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.debug.level

Level for mode debug.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "debug"

Declared by:

plugins.neorg.logger.modes.error

Settings for mode error.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.error.hl

Highlight for mode error.

Plugin default: "ErrorMsg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.error.level

Level for mode error.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "error"

Declared by:

plugins.neorg.logger.modes.fatal

Settings for mode fatal.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.fatal.hl

Highlight for mode fatal.

Plugin default: "ErrorMsg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.fatal.level

Level for mode fatal.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: 5

Declared by:

plugins.neorg.logger.modes.info

Settings for mode info.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.info.hl

Highlight for mode info.

Plugin default: "None"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.info.level

Level for mode info.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

plugins.neorg.logger.modes.trace

Settings for mode trace.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.trace.hl

Highlight for mode trace.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.trace.level

Level for mode trace.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "trace"

Declared by:

plugins.neorg.logger.modes.warn

Settings for mode warn.

Type: null or (submodule)

Default: null

Declared by:

plugins.neorg.logger.modes.warn.hl

Highlight for mode warn.

Plugin default: "WarningMsg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neorg.logger.modes.warn.level

Level for mode warn.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "warn"

Declared by:

neoscroll

Url: https://github.com/karb94/neoscroll.nvim/

Maintainers: Gaetan Lepage

plugins.neoscroll.enable

Whether to enable neoscroll.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neoscroll.package

Which package to use for the neoscroll.nvim plugin.

Type: package

Default: <derivation vimplugin-neoscroll.nvim-2024-04-30>

Declared by:

plugins.neoscroll.settings

Options provided to the require('neoscroll').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  cursor_scrolls_alone = true;
  easing_function = "quadratic";
  hide_cursor = true;
  mappings = [
    "<C-u>"
    "<C-d>"
    "<C-b>"
    "<C-f>"
    "<C-y>"
    "<C-e>"
    "zt"
    "zz"
    "zb"
  ];
  respect_scrolloff = false;
  stop_eof = true;
}

Declared by:

plugins.neoscroll.settings.cursor_scrolls_alone

The cursor will keep on scrolling even if the window cannot scroll further.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neoscroll.settings.easing_function

Name of the easing function to use by default in all scrolling animamtions. scroll() that don’t provide the optional easing argument will use this easing function. If set to null (the default) no easing function will be used in the scrolling animation (constant scrolling speed).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neoscroll.settings.hide_cursor

If ‘termguicolors’ is set, hide the cursor while scrolling.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neoscroll.settings.mappings

All the keys defined in this option will be mapped to their corresponding default scrolling animation. To no map any key pass an empty table:

  mappings.__empty = null;

Plugin default:

[
  "<C-u>"
  "<C-d>"
  "<C-b>"
  "<C-f>"
  "<C-y>"
  "<C-e>"
  "zt"
  "zz"
  "zb"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.neoscroll.settings.performance_mode

Option to enable “Performance Mode” on all buffers.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neoscroll.settings.post_hook

Equivalent to pre_hook but the function will run after the scrolling animation ends.

Type: null or lua code string

Default: null

Declared by:

plugins.neoscroll.settings.pre_hook

Function to run before the scrolling animation starts. The function will be called with the info parameter which can be optionally passed to scroll() (or any of the provided wrappers). This can be used to conditionally run different hooks for different types of scrolling animations.

Type: null or lua code string

Default: null

Declared by:

plugins.neoscroll.settings.respect_scrolloff

The cursor stops at the scrolloff margin. Try combining this option with either stop_eof or cursor_scrolls_alone (or both).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neoscroll.settings.step_eof

When move_cursor is true scrolling downwards will stop when the bottom line of the window is the last line of the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

neotest

Url: https://github.com/nvim-neotest/neotest/

Maintainers: Gaetan Lepage

plugins.neotest.enable

Whether to enable neotest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.package

Which package to use for the neotest plugin.

Type: package

Default: <derivation vimplugin-lua5.1-neotest-5.2.3-1-unstable-2024-04-28>

Declared by:

plugins.neotest.adapters.bash.enable

Whether to enable bash.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.bash.package

Which package to use for the bash plugin.

Type: package

Default: <derivation vimplugin-neotest-bash-2024-05-06>

Declared by:

plugins.neotest.adapters.bash.settings

settings for the bash adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.dart.enable

Whether to enable dart.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.dart.package

Which package to use for the dart plugin.

Type: package

Default: <derivation vimplugin-neotest-dart-2024-02-28>

Declared by:

plugins.neotest.adapters.dart.settings

settings for the dart adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.deno.enable

Whether to enable deno.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.deno.package

Which package to use for the deno plugin.

Type: package

Default: <derivation vimplugin-neotest-deno-2022-12-09>

Declared by:

plugins.neotest.adapters.deno.settings

settings for the deno adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.dotnet.enable

Whether to enable dotnet.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.dotnet.package

Which package to use for the dotnet plugin.

Type: package

Default: <derivation vimplugin-neotest-dotnet-2024-04-13>

Declared by:

plugins.neotest.adapters.dotnet.settings

settings for the dotnet adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.elixir.enable

Whether to enable elixir.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.elixir.package

Which package to use for the elixir plugin.

Type: package

Default: <derivation vimplugin-neotest-elixir-2023-11-26>

Declared by:

plugins.neotest.adapters.elixir.settings

settings for the elixir adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.foundry.enable

Whether to enable foundry.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.foundry.package

Which package to use for the foundry plugin.

Type: package

Default: <derivation vimplugin-neotest-foundry-2024-02-03>

Declared by:

plugins.neotest.adapters.foundry.settings

settings for the foundry adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.go.enable

Whether to enable go.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.go.package

Which package to use for the go plugin.

Type: package

Default: <derivation vimplugin-neotest-go-2024-05-07>

Declared by:

plugins.neotest.adapters.go.settings

settings for the go adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.gradle.enable

Whether to enable gradle.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.gradle.package

Which package to use for the gradle plugin.

Type: package

Default: <derivation vimplugin-neotest-gradle-2023-12-05>

Declared by:

plugins.neotest.adapters.gradle.settings

settings for the gradle adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.gtest.enable

Whether to enable gtest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.gtest.package

Which package to use for the gtest plugin.

Type: package

Default: <derivation vimplugin-neotest-gtest-2024-05-13>

Declared by:

plugins.neotest.adapters.gtest.settings

settings for the gtest adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.hardhat.enable

Whether to enable hardhat.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.hardhat.package

Which package to use for the hardhat plugin.

Type: package

Default: <derivation vimplugin-hardhat.nvim-2024-05-12>

Declared by:

plugins.neotest.adapters.hardhat.settings

settings for the hardhat adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.haskell.enable

Whether to enable haskell.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.haskell.package

Which package to use for the haskell plugin.

Type: package

Default: <derivation vimplugin-neotest-haskell-2024-05-13>

Declared by:

plugins.neotest.adapters.haskell.settings

settings for the haskell adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.java.enable

Whether to enable java.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.java.package

Which package to use for the java plugin.

Type: package

Default: <derivation vimplugin-neotest-java-2024-05-08>

Declared by:

plugins.neotest.adapters.java.settings

settings for the java adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.jest.enable

Whether to enable jest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.jest.package

Which package to use for the jest plugin.

Type: package

Default: <derivation vimplugin-neotest-jest-2024-03-21>

Declared by:

plugins.neotest.adapters.jest.settings

settings for the jest adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.minitest.enable

Whether to enable minitest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.minitest.package

Which package to use for the minitest plugin.

Type: package

Default: <derivation vimplugin-neotest-minitest-2024-04-29>

Declared by:

plugins.neotest.adapters.minitest.settings

settings for the minitest adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.pest.enable

Whether to enable pest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.pest.package

Which package to use for the pest plugin.

Type: package

Default: <derivation vimplugin-neotest-pest-2024-02-16>

Declared by:

plugins.neotest.adapters.pest.settings

settings for the pest adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.phpunit.enable

Whether to enable phpunit.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.phpunit.package

Which package to use for the phpunit plugin.

Type: package

Default: <derivation vimplugin-neotest-phpunit-2024-05-05>

Declared by:

plugins.neotest.adapters.phpunit.settings

settings for the phpunit adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.playwright.enable

Whether to enable playwright.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.playwright.package

Which package to use for the playwright plugin.

Type: package

Default: <derivation vimplugin-neotest-playwright-2024-02-23>

Declared by:

plugins.neotest.adapters.playwright.settings

settings for the playwright adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.plenary.enable

Whether to enable plenary.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.plenary.package

Which package to use for the plenary plugin.

Type: package

Default: <derivation vimplugin-neotest-plenary-2023-09-29>

Declared by:

plugins.neotest.adapters.plenary.settings

settings for the plenary adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.python.enable

Whether to enable python.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.python.package

Which package to use for the python plugin.

Type: package

Default: <derivation vimplugin-neotest-python-2024-01-15>

Declared by:

plugins.neotest.adapters.python.settings

settings for the python adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.rspec.enable

Whether to enable rspec.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.rspec.package

Which package to use for the rspec plugin.

Type: package

Default: <derivation vimplugin-neotest-rspec-2024-05-15>

Declared by:

plugins.neotest.adapters.rspec.settings

settings for the rspec adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.rust.enable

Whether to enable rust.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.rust.package

Which package to use for the rust plugin.

Type: package

Default: <derivation vimplugin-neotest-rust-2024-04-08>

Declared by:

plugins.neotest.adapters.rust.settings

settings for the rust adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.scala.enable

Whether to enable scala.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.scala.package

Which package to use for the scala plugin.

Type: package

Default: <derivation vimplugin-neotest-scala-2022-10-15>

Declared by:

plugins.neotest.adapters.scala.settings

settings for the scala adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.testthat.enable

Whether to enable testthat.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.testthat.package

Which package to use for the testthat plugin.

Type: package

Default: <derivation vimplugin-neotest-testthat-2022-07-04>

Declared by:

plugins.neotest.adapters.testthat.settings

settings for the testthat adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.vitest.enable

Whether to enable vitest.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.vitest.package

Which package to use for the vitest plugin.

Type: package

Default: <derivation vimplugin-neotest-vitest-2024-04-17>

Declared by:

plugins.neotest.adapters.vitest.settings

settings for the vitest adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.adapters.zig.enable

Whether to enable zig.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neotest.adapters.zig.package

Which package to use for the zig plugin.

Type: package

Default: <derivation vimplugin-neotest-zig-2024-05-06>

Declared by:

plugins.neotest.adapters.zig.settings

settings for the zig adapter.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.neotest.settings

Options provided to the require('neotest').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  output = {
    enabled = true;
    open_on_run = true;
  };
  output_panel = {
    enabled = true;
    open = "botright split | resize 15";
  };
  quickfix = {
    enabled = false;
  };
}

Declared by:

plugins.neotest.settings.consumers

key: string value: lua function

Plugin default: {}

Type: null or (attribute set of (raw lua code or raw lua code))

Default: null

Declared by:

plugins.neotest.settings.default_strategy

The default strategy.

Plugin default: "integrated"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neotest.settings.highlights

Plugin default:

{
  adapter_name = "NeotestAdapterName";
  border = "NeotestBorder";
  dir = "NeotestDir";
  expand_marker = "NeotestExpandMarker";
  failed = "NeotestFailed";
  file = "NeotestFile";
  focused = "NeotestFocused";
  indent = "NeotestIndent";
  marked = "NeotestMarked";
  namespace = "NeotestNamespace";
  passed = "NeotestPassed";
  running = "NeotestRunning";
  select_win = "NeotestWinSelect";
  skipped = "NeotestSkipped";
  target = "NeotestTarget";
  test = "NeotestTest";
  unknown = "NeotestUnknown";
  watching = "NeotestWatching";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.neotest.settings.icons

Icons used throughout the UI. Defaults use VSCode’s codicons.

Plugin default:

{
  child_indent = "│";
  child_prefix = "├";
  collapsed = "─";
  expanded = "╮";
  failed = "";
  final_child_indent = " ";
  final_child_prefix = "╰";
  non_collapsible = "─";
  passed = "";
  running = "";
  running_animated = ["/" "|" "\\" "-" "/" "|" "\\" "-"];
  skipped = "";
  unknown = "";
  watching = "";
}

Type: null or (attribute set of (string or list of string or raw lua code))

Default: null

Declared by:

plugins.neotest.settings.log_level

Minimum log levels.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "warn"

Declared by:

plugins.neotest.settings.diagnostic.enabled

Enable diagnostic.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.diagnostic.severity

Diagnostic severity, one of vim.diagnostic.severity.

Type: null or unsigned integer, meaning >=0, or one of “error”, “warn”, “info”, “hint”

Default: "error"

Declared by:

plugins.neotest.settings.discovery.enabled

Enable discovery.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.discovery.concurrent

Number of workers to parse files concurrently. 0 automatically assigns number based on CPU. Set to 1 if experiencing lag.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neotest.settings.discovery.filter_dir

fun(name: string, rel_path: string, root: string): boolean

A function to filter directories when searching for test files. Receives the name, path relative to project root and project root path.

Type: null or lua code string

Default: null

Declared by:

plugins.neotest.settings.floating.border

Border style.

Plugin default: "rounded"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neotest.settings.floating.max_height

Max height of window as proportion of NeoVim window.

Plugin default: 0.6

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.neotest.settings.floating.max_width

Max width of window as proportion of NeoVim window.

Plugin default: 0.6

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.neotest.settings.floating.options

Window local options to set on floating windows (e.g. winblend).

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.neotest.settings.output.enabled

Enable output.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.output.open_on_run

Open nearest test result after running.

Plugin default: short

Type: null or string or boolean

Default: null

Declared by:

plugins.neotest.settings.output_panel.enabled

Enable output panel.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.output_panel.open

A command or function to open a window for the output panel. Either a string or a function that returns an integer.

Plugin default: "botright split | resize 15"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neotest.settings.quickfix.enabled

Enable quickfix.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.quickfix.open

Set to true to open quickfix on startup, or a function to be called when the quickfix results are set.

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.neotest.settings.running.concurrent

Run tests concurrently when an adapter provides multiple commands to run.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.state.enabled

Enable state.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.status.enabled

Enable status.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.status.signs

Display status using signs.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.status.virtual_text

Display status using virtual text.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.strategies.integrated.height

height to pass to the pty running commands.

Plugin default: 40

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neotest.settings.strategies.integrated.width

Width to pass to the pty running commands.

Plugin default: 120

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.neotest.settings.summary.enabled

Whether to enable summary.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.summary.animated

Enable/disable animation of icons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.summary.expandErrors

Expand all failed positions.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.summary.follow

Expand user’s current file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.summary.mappings

Buffer mappings for summary window.

Plugin default:

{
  attach = "a";
  clear_marked = "M";
  clear_target = "T";
  debug = "d";
  debug_marked = "D";
  expand = ["<CR>" "<2-LeftMouse>"];
  expand_all = "e";
  jumpto = "i";
  mark = "m";
  next_failed = "J";
  output = "o";
  prev_failed = "K";
  run = "r";
  run_marked = "R";
  short = "O";
  stop = "u";
  target = "t";
  watch = "w";
}

Type: null or (attribute set of (string or list of string or raw lua code))

Default: null

Declared by:

plugins.neotest.settings.summary.open

A command or function to open a window for the summary. Either a string or a function that returns an integer.

Plugin default: "botright vsplit | vertical resize 50"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neotest.settings.watch.enabled

Enable watch.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neotest.settings.watch.filter_path

(fun(path: string, root: string): boolean)

Returns whether the watcher should inspect a path for dependencies. Default ignores paths not under root or common package manager directories.

Type: null or lua code string

Default: null

Declared by:

plugins.neotest.settings.watch.symbol_queries

Treesitter queries or functions to capture symbols that are used for querying the LSP server for definitions to link files. If it is a function then the return value should be a list of node ranges.

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.netman.enable

Whether to enable netman.nvim, a framework to access remote resources.

Type: boolean

Default: false

Example: true

Declared by:

plugins.netman.package

Which package to use for the netman.nvim plugin.

Type: package

Default: <derivation vimplugin-netman.nvim-2024-04-21>

Declared by:

plugins.netman.neoTreeIntegration

Whether to enable support for netman as a neo-tree source.

Type: boolean

Default: false

Example: true

Declared by:

nix

Url: https://github.com/LnL7/vim-nix/

Maintainers: Gaetan Lepage

plugins.nix.enable

Whether to enable vim-nix.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nix.package

Which package to use for the nix plugin.

Type: package

Default: <derivation vimplugin-vim-nix-2024-02-24>

Declared by:

plugins.nix-develop.enable

Whether to enable nix-develop.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nix-develop.package

Which package to use for the nix-develop.nvim plugin.

Type: package

Default: <derivation vimplugin-nix-develop.nvim-2023-07-23>

Declared by:

plugins.nix-develop.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.nix-develop.ignoredVariables

This option has no description.

Type: attribute set of boolean

Default: { }

Declared by:

plugins.nix-develop.separatedVariables

This option has no description.

Type: attribute set of string

Default: { }

Declared by:

plugins.noice.enable

Whether to enable noice.nvim, an experimental nvim UI. Note that if treesitter is enabled you need the following parsers: vim, regex, lua, bash, markdown, markdown_inline .

Type: boolean

Default: false

Example: true

Declared by:

plugins.noice.package

Which package to use for the noice plugin.

Type: package

Default: <derivation vimplugin-noice.nvim-2024-05-16>

Declared by:

plugins.noice.commands

You can add any custom commands that will be available with :Noice command

Plugin default:

{
  history = {
    view = "split";
    opts = {enter = true; format = "details";};
    filter = {
      any = [
        {event = "notify";}
        {error = true;}
        {warning = true;}
        {event = "msg_show"; kind = [""];}
        {event = "lsp"; kind = "message";}
      ];
    };
  };
  last = {
    view = "popup";
    opts = {enter = true; format = "details";};
    filter = {
      any = [
        {event = "notify";}
        {error = true;}
        {warning = true;}
        {event = "msg_show"; kind = [""];}
        {event = "lsp"; kind = "message";}
      ];
    };
    filter_opts = {count = 1;};
  };
  errors = {
    view = "popup";
    opts = {enter = true; format = "details";};
    filter = {error = true;};
    filter_opts = {reverse = true;};
  };
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.noice.format

Plugin default: {}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.presets

    you can enable a preset by setting it to true, or a table that will override the preset
    config. you can also add custom presets that you can enable/disable with enabled=true

Plugin default:

{
  bottom_search = false;
  command_palette = false;
  long_message_to_split = false;
  inc_rename = false;
  lsp_doc_border = false;
}

Type: null or boolean or anything

Default: null

Declared by:

plugins.noice.redirect

default options for require(‘noice’).redirect

Plugin default:

{
  view = "popup";
  filter = {event = "msg_show";};
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.routes

Plugin default: []

Type: null or (list of attribute set of anything)

Default: null

Declared by:

plugins.noice.status

Plugin default: {}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.throttle

how frequently does Noice need to check for ui updates? This has no effect when in blocking mode

Plugin default: 1000 / 30

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.noice.views

Plugin default: {}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.cmdline.enabled

enables Noice cmdline UI

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.cmdline.format

conceal: (default=true) This will hide the text in the cmdline that matches the pattern. view: (default is cmdline view) opts: any options passed to the view icon_hl_group: optional hl_group for the icon title: set to anything or empty string to hide lua = false, to disable a format, set to false

Plugin default:

{
  cmdline = {pattern = "^:"; icon = ""; lang = "vim";};
  search_down = {kind = "search"; pattern = "^/"; icon = " "; lang = "regex";};
  search_up = {kind = "search"; pattern = "?%?"; icon = " "; lang = "regex";};
  filter = {pattern = "^:%s*!"; icon = "$"; lang = "bash";};
  lua = {pattern = "^:%s*lua%s+"; icon = ""; lang = "lua";};
  help = {pattern = "^:%s*he?l?p?%s+"; icon = "";};
  input = {};
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.noice.cmdline.opts

Plugin default: {}

Type: null or anything

Default: null

Declared by:

plugins.noice.cmdline.view

Plugin default: "cmdline_popup"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.health.checker

Disable if you don’t want health checks to run

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.override

Plugin default:

{
  "vim.lsp.util.convert_input_to_markdown_lines" = false;
  "vim.lsp.util.stylize_markdown" = false;
  "cmp.entry.get_documentation" = false;
}

Type: null or (attribute set of boolean)

Default: null

Declared by:

plugins.noice.lsp.documentation.opts

Plugin default:

{
  lang = "markdown";
  replace = true;
  render = "plain";
  format = ["{message}"];
  win_options = { concealcursor = "n"; conceallevel = 3; };
}

Type: null or anything

Default: null

Declared by:

plugins.noice.lsp.documentation.view

Plugin default: "hover"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.lsp.hover.enabled

enable hover UI

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.hover.opts

merged with defaults from documentation

Plugin default: {}

Type: null or anything

Default: null

Declared by:

plugins.noice.lsp.hover.view

when null, use defaults from documentation

Plugin default: null

Type: null or string

Default: null

Declared by:

plugins.noice.lsp.message.enabled

enable display of messages

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.message.opts

Plugin default: {}

Type: null or anything

Default: null

Declared by:

plugins.noice.lsp.message.view

Plugin default: "notify"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.lsp.progress.enabled

enable LSP progress

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.progress.format

Lsp Progress is formatted using the builtins for lsp_progress

Plugin default: "lsp_progress"

Type: null or string or anything

Default: null

Declared by:

plugins.noice.lsp.progress.formatDone

Plugin default: "lsp_progress"

Type: null or string or anything

Default: null

Declared by:

plugins.noice.lsp.progress.throttle

frequency to update lsp progress message

Plugin default: 1000 / 30

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.noice.lsp.progress.view

Plugin default: "mini"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.lsp.signature.enabled

enable signature UI

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.signature.opts

merged with defaults from documentation

Plugin default: {}

Type: null or anything

Default: null

Declared by:

plugins.noice.lsp.signature.view

when null, use defaults from documentation

Plugin default: null

Type: null or string

Default: null

Declared by:

plugins.noice.lsp.signature.autoOpen.enabled

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.signature.autoOpen.luasnip

Will open signature help when jumping to Luasnip insert nodes

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.lsp.signature.autoOpen.throttle

Debounce lsp signature help request by 50ms

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.noice.lsp.signature.autoOpen.trigger

Automatically show signature help when typing a trigger character from the LSP

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.markdown.highlights

set highlight groups

Plugin default:

{
  "|%S-|" = "@text.reference";
  "@%S+" = "@parameter";
  "^%s*(Parameters:)" = "@text.title";
  "^%s*(Return:)" = "@text.title";
  "^%s*(See also:)" = "@text.title";
  "{%S-}" = "@parameter";
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.noice.markdown.hover

set handlers for hover (lua code)

Plugin default:

{
  "|(%S-)|" = helpers.mkRaw "vim.cmd.help"; // vim help links
  "%[.-%]%((%S-)%)" = helpers.mkRaw "require("noice.util").open"; // markdown links
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.noice.messages.enabled

Enables the messages UI. NOTE: If you enable messages, then the cmdline is enabled automatically.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.messages.view

default view for messages

Plugin default: "notify"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.messages.viewError

default view for errors

Plugin default: "notify"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.messages.viewHistory

view for :messages

Plugin default: "messages"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.messages.viewSearch

view for search count messages

Plugin default: "virtualtext"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.messages.viewWarn

default view for warnings

Plugin default: "notify"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.notify.enabled

Enable notification handling.

Noice can be used as vim.notify so you can route any notification like other messages. Notification messages have their level and other properties set. event is always “notify” and kind can be any log level as a string. The default routes will forward notifications to nvim-notify. Benefit of using Noice for this is the routing and consistent history view.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.notify.view

Plugin default: "notify"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.noice.popupmenu.enabled

enables the Noice popupmenu UI

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.popupmenu.backend

Plugin default: "nui"

Type: null or one of “nui”, “cmp” or raw lua code

Default: null

Declared by:

plugins.noice.popupmenu.kindIcons

Icons for completion item kinds. set to false to disable icons

Plugin default: {}

Type: null or boolean or attribute set of anything

Default: null

Declared by:

plugins.noice.smartMove.enabled

Noice tries to move out of the way of existing floating windows. You can disable this behaviour here

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.noice.smartMove.excludedFiletypes

add any filetypes here, that shouldn’t trigger smart move

Plugin default: [ "cmp_menu" "cmp_docs" "notify"]

Type: null or (list of string)

Default: null

Declared by:

plugins.none-ls.enable

Whether to enable none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.enableLspFormat

Automatically enable the lsp-format plugin and configure none-ls accordingly.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.package

Plugin to use for none-ls

Type: package

Default: <derivation vimplugin-none-ls.nvim-2024-05-14>

Declared by:

plugins.none-ls.border

Uses NullLsInfoBorder highlight group (see Highlight Groups).

Defines the border to use for :NullLsInfo UI window… Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: null

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.none-ls.cmd

Defines the command used to start the null-ls server. If you do not have an nvim binary available on your $PATH, you should change this to an absolute path to the binary.

Plugin default: ["nvim"]

Type: null or (list of string)

Default: null

Declared by:

plugins.none-ls.debounce

The debounce setting controls the amount of time between the last change to a buffer and the next textDocument/didChange notification. These notifications cause null-ls to generate diagnostics, so this setting indirectly controls the rate of diagnostic generation (affected by update_in_insert, described below).

Lowering debounce will result in quicker diagnostic refreshes at the cost of running diagnostic sources more frequently, which can affect performance. The default value should be enough to provide near-instantaneous feedback from most sources without unnecessary resource usage.

Plugin default: 250

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.none-ls.debug

Displays all possible log messages and writes them to the null-ls log, which you can view with the command :NullLsLog. This option can slow down Neovim, so it’s strongly recommended to disable it for normal use.

debug = true is the same as setting logLevel to "trace".

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.none-ls.defaultTimeout

Sets the amount of time (in milliseconds) after which built-in sources will time out. Note that built-in sources can define their own timeout period and that users can override the timeout period on a per-source basis, too (see BUILTIN_CONFIG.md).

Specifying a timeout with a value less than zero will prevent commands from timing out.

Plugin default: 5000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.none-ls.diagnosticConfig

Specifies diagnostic display options for null-ls sources, as described in :help vim.diagnostic.config(). (null-ls uses separate namespaces for each source, so server-wide configuration will not work as expected.)

You can also configure diagnostic_config per built-in by using the with method, described in BUILTIN_CONFIG.md.

Plugin default: null

Type: null or (attribute set)

Default: null

Declared by:

plugins.none-ls.diagnosticsFormat

Sets the default format used for diagnostics. The plugin will replace the following special components with the relevant diagnostic information:

  • #{m}: message
  • #{s}: source name (defaults to null-ls if not specified)
  • #{c}: code (if available)

For example, setting diagnostics_format to the following:

diagnostics_format = "[#{c}] #{m} (#{s})"

Formats diagnostics as follows:

[2148] Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive. (shellcheck)

You can also configure diagnostics_format per built-in by using the with method, described in BUILTIN_CONFIG.

Plugin default: "#{m}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.none-ls.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.none-ls.fallbackSeverity

Defines the severity used when a diagnostic source does not explicitly define a severity. See :help diagnostic-severity for available values.

Type: null or unsigned integer, meaning >=0, or one of “error”, “warn”, “info”, “hint”

Default: "error"

Declared by:

plugins.none-ls.logLevel

Enables or disables logging to file.

Plugin logs messages on several logging levels to following destinations:

  • file, can be inspected by :NullLsLog.
  • neovim’s notification area.

Plugin default: "warn"

Type: null or one of “off”, “error”, “warn”, “info”, “debug”, “trace” or raw lua code

Default: null

Declared by:

plugins.none-ls.notifyFormat

Sets the default format for vim.notify() messages. Can be used to customize 3rd party notification plugins like nvim-notify.

Plugin default: "[null-ls] %s"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.none-ls.onAttach

Defines an on_attach callback to run whenever null-ls attaches to a buffer. If you have a common on_attach you’re using for LSP servers, you can reuse that here, use a custom callback for null-ls, or leave this undefined.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.none-ls.onExit

Defines an on_exit callback to run when the null-ls client exits.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.none-ls.onInit

Defines an on_init callback to run when null-ls initializes. From here, you can make changes to the client (the first argument) or initialize_result (the second argument, which as of now is not used).

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.none-ls.rootDir

Determines the root of the null-ls server. On startup, null-ls will call root_dir with the full path to the first file that null-ls attaches to.

local root_dir = function(fname)
    return fname:match("my-project") and "my-project-root"
end

If root_dir returns nil, the root will resolve to the current working directory.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.none-ls.shouldAttach

A user-defined function that controls whether to enable null-ls for a given buffer. Receives bufnr as its first argument.

To cut down potentially expensive calls, null-ls will call should_attach after its own internal checks pass, so it’s not guaranteed to run on each new buffer.

require("null-ls.nvim").setup({
    should_attach = function(bufnr)
        return not vim.api.nvim_buf_get_name(bufnr):match("^git://")
    end,
})

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.none-ls.sourcesItems

The list of sources to enable, should be strings of lua code. Don’t use this directly

Type: null or (list of attribute set of string)

Default: null

Declared by:

plugins.none-ls.tempDir

Defines the directory used to create temporary files for sources that rely on them (a workaround used for command-based sources that do not support stdio).

To maximize compatibility, null-ls defaults to creating temp files in the same directory as the parent file. If this is causing issues, you can set it to /tmp (or another appropriate directory) here. Otherwise, there is no need to change this setting.

Note: some null-ls built-in sources expect temp files to exist within a project for context and so will not work if this option changes.

You can also configure temp_dir per built-in by using the with method, described in BUILTIN_CONFIG.md.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.none-ls.updateInInsert

Controls whether diagnostic sources run in insert mode. If set to false, diagnostic sources will run upon exiting insert mode, which greatly improves performance but can create a slight delay before diagnostics show up. Set this to true if you don’t experience performance issues with your sources.

Note that by default, Neovim will not display updated diagnostics in insert mode. Together with the option above, you need to pass update_in_insert = true to vim.diagnostic.config for diagnostics to work as expected. See :help vim.diagnostic.config for more info.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.none-ls.sources.code_actions.gitrebase.enable

Whether to enable the gitrebase code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.gitrebase.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.gitsigns.enable

Whether to enable the gitsigns code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.gitsigns.package

Package to use for gitsigns by none-ls.

Type: null or package

Default: <derivation git-2.44.1>

Declared by:

plugins.none-ls.sources.code_actions.gitsigns.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.gomodifytags.enable

Whether to enable the gomodifytags code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.gomodifytags.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.impl.enable

Whether to enable the impl code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.impl.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.proselint.enable

Whether to enable the proselint code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.proselint.package

Package to use for proselint by none-ls.

Type: null or package

Default: <derivation proselint-0.13.0>

Declared by:

plugins.none-ls.sources.code_actions.proselint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.refactoring.enable

Whether to enable the refactoring code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.refactoring.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.statix.enable

Whether to enable the statix code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.statix.package

Package to use for statix by none-ls.

Type: null or package

Default: <derivation statix-0.5.8>

Declared by:

plugins.none-ls.sources.code_actions.statix.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.code_actions.ts_node_action.enable

Whether to enable the ts_node_action code_actions source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.code_actions.ts_node_action.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.completion.luasnip.enable

Whether to enable the luasnip completion source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.completion.luasnip.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.completion.spell.enable

Whether to enable the spell completion source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.completion.spell.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.completion.tags.enable

Whether to enable the tags completion source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.completion.tags.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.completion.vsnip.enable

Whether to enable the vsnip completion source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.completion.vsnip.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.actionlint.enable

Whether to enable the actionlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.actionlint.package

Package to use for actionlint by none-ls.

Type: null or package

Default: <derivation actionlint-1.7.0>

Declared by:

plugins.none-ls.sources.diagnostics.actionlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.alex.enable

Whether to enable the alex diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.alex.package

Package to use for alex by none-ls.

Type: null or package

Default: <derivation alex-11.0.1>

Declared by:

plugins.none-ls.sources.diagnostics.alex.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.ansiblelint.enable

Whether to enable the ansiblelint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.ansiblelint.package

Package to use for ansiblelint by none-ls.

Type: null or package

Default: <derivation ansible-lint-24.2.2>

Declared by:

plugins.none-ls.sources.diagnostics.ansiblelint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.bean_check.enable

Whether to enable the bean_check diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.bean_check.package

Package to use for bean_check by none-ls.

Type: null or package

Default: <derivation beancount-2.3.6>

Declared by:

plugins.none-ls.sources.diagnostics.bean_check.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.bslint.enable

Whether to enable the bslint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.bslint.package

Package to use for bslint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.bslint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.buf.enable

Whether to enable the buf diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.buf.package

Package to use for buf by none-ls.

Type: null or package

Default: <derivation buf-1.31.0>

Declared by:

plugins.none-ls.sources.diagnostics.buf.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.buildifier.enable

Whether to enable the buildifier diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.buildifier.package

Package to use for buildifier by none-ls.

Type: null or package

Default: <derivation bazel-buildtools-7.1.1>

Declared by:

plugins.none-ls.sources.diagnostics.buildifier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.cfn_lint.enable

Whether to enable the cfn_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.cfn_lint.package

Package to use for cfn_lint by none-ls.

Type: null or package

Default: <derivation python3.11-cfn-lint-0.86.0>

Declared by:

plugins.none-ls.sources.diagnostics.cfn_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.checkmake.enable

Whether to enable the checkmake diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.checkmake.package

Package to use for checkmake by none-ls.

Type: null or package

Default: <derivation checkmake-0.2.2>

Declared by:

plugins.none-ls.sources.diagnostics.checkmake.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.checkstyle.enable

Whether to enable the checkstyle diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.checkstyle.package

Package to use for checkstyle by none-ls.

Type: null or package

Default: <derivation checkstyle-10.16.0>

Declared by:

plugins.none-ls.sources.diagnostics.checkstyle.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.clazy.enable

Whether to enable the clazy diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.clazy.package

Package to use for clazy by none-ls.

Type: null or package

Default: <derivation clazy-1.11>

Declared by:

plugins.none-ls.sources.diagnostics.clazy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.clj_kondo.enable

Whether to enable the clj_kondo diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.clj_kondo.package

Package to use for clj_kondo by none-ls.

Type: null or package

Default: <derivation clj-kondo-2024.03.13>

Declared by:

plugins.none-ls.sources.diagnostics.clj_kondo.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.cmake_lint.enable

Whether to enable the cmake_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.cmake_lint.package

Package to use for cmake_lint by none-ls.

Type: null or package

Default: <derivation cmake-format-0.6.13>

Declared by:

plugins.none-ls.sources.diagnostics.cmake_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.codespell.enable

Whether to enable the codespell diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.codespell.package

Package to use for codespell by none-ls.

Type: null or package

Default: <derivation codespell-2.2.6>

Declared by:

plugins.none-ls.sources.diagnostics.codespell.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.commitlint.enable

Whether to enable the commitlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.commitlint.package

Package to use for commitlint by none-ls.

Type: null or package

Default: <derivation _at_commitlint_slash_cli-19.2.0>

Declared by:

plugins.none-ls.sources.diagnostics.commitlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.cppcheck.enable

Whether to enable the cppcheck diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.cppcheck.package

Package to use for cppcheck by none-ls.

Type: null or package

Default: <derivation cppcheck-2.14.0>

Declared by:

plugins.none-ls.sources.diagnostics.cppcheck.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.credo.enable

Whether to enable the credo diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.credo.package

Package to use for credo by none-ls.

Type: null or package

Default: <derivation elixir-1.16.3>

Declared by:

plugins.none-ls.sources.diagnostics.credo.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.cue_fmt.enable

Whether to enable the cue_fmt diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.cue_fmt.package

Package to use for cue_fmt by none-ls.

Type: null or package

Default: <derivation cue-0.8.2>

Declared by:

plugins.none-ls.sources.diagnostics.cue_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.deadnix.enable

Whether to enable the deadnix diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.deadnix.package

Package to use for deadnix by none-ls.

Type: null or package

Default: <derivation deadnix-1.2.1>

Declared by:

plugins.none-ls.sources.diagnostics.deadnix.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.djlint.enable

Whether to enable the djlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.djlint.package

Package to use for djlint by none-ls.

Type: null or package

Default: <derivation djlint-1.34.1>

Declared by:

plugins.none-ls.sources.diagnostics.djlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.dotenv_linter.enable

Whether to enable the dotenv_linter diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.dotenv_linter.package

Package to use for dotenv_linter by none-ls.

Type: null or package

Default: <derivation dotenv-linter-3.3.0>

Declared by:

plugins.none-ls.sources.diagnostics.dotenv_linter.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.editorconfig_checker.enable

Whether to enable the editorconfig_checker diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.editorconfig_checker.package

Package to use for editorconfig_checker by none-ls.

Type: null or package

Default: <derivation editorconfig-checker-3.0.1>

Declared by:

plugins.none-ls.sources.diagnostics.editorconfig_checker.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.erb_lint.enable

Whether to enable the erb_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.erb_lint.package

Package to use for erb_lint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.erb_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.fish.enable

Whether to enable the fish diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.fish.package

Package to use for fish by none-ls.

Type: null or package

Default: <derivation fish-3.7.1>

Declared by:

plugins.none-ls.sources.diagnostics.fish.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.gccdiag.enable

Whether to enable the gccdiag diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.gccdiag.package

Package to use for gccdiag by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.gccdiag.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.gdlint.enable

Whether to enable the gdlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.gdlint.package

Package to use for gdlint by none-ls.

Type: null or package

Default: <derivation gdtoolkit-3.3.1>

Declared by:

plugins.none-ls.sources.diagnostics.gdlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.gitlint.enable

Whether to enable the gitlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.gitlint.package

Package to use for gitlint by none-ls.

Type: null or package

Default: <derivation gitlint-0.19.1>

Declared by:

plugins.none-ls.sources.diagnostics.gitlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.glslc.enable

Whether to enable the glslc diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.glslc.package

Package to use for glslc by none-ls.

Type: null or package

Default: <derivation shaderc-2024.0>

Declared by:

plugins.none-ls.sources.diagnostics.glslc.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.golangci_lint.enable

Whether to enable the golangci_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.golangci_lint.package

Package to use for golangci_lint by none-ls.

Type: null or package

Default: <derivation golangci-lint-1.58.2>

Declared by:

plugins.none-ls.sources.diagnostics.golangci_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.hadolint.enable

Whether to enable the hadolint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.hadolint.package

Package to use for hadolint by none-ls.

Type: null or package

Default: <derivation hadolint-2.12.0>

Declared by:

plugins.none-ls.sources.diagnostics.hadolint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.haml_lint.enable

Whether to enable the haml_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.haml_lint.package

Package to use for haml_lint by none-ls.

Type: null or package

Default: <derivation mastodon-4.2.10>

Declared by:

plugins.none-ls.sources.diagnostics.haml_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.ktlint.enable

Whether to enable the ktlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.ktlint.package

Package to use for ktlint by none-ls.

Type: null or package

Default: <derivation ktlint-1.2.1>

Declared by:

plugins.none-ls.sources.diagnostics.ktlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.ltrs.enable

Whether to enable the ltrs diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.ltrs.package

Package to use for ltrs by none-ls.

Type: null or package

Default: <derivation languagetool-rust-2.1.4>

Declared by:

plugins.none-ls.sources.diagnostics.ltrs.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint.enable

Whether to enable the markdownlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint.package

Package to use for markdownlint by none-ls.

Type: null or package

Default: <derivation markdownlint-cli-0.40.0>

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint_cli2.enable

Whether to enable the markdownlint_cli2 diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint_cli2.package

Package to use for markdownlint_cli2 by none-ls.

Type: null or package

Default: <derivation markdownlint-cli2-0.9.0>

Declared by:

plugins.none-ls.sources.diagnostics.markdownlint_cli2.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.markuplint.enable

Whether to enable the markuplint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.markuplint.package

Package to use for markuplint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.markuplint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.mdl.enable

Whether to enable the mdl diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.mdl.package

Package to use for mdl by none-ls.

Type: null or package

Default: <derivation mdl-0.13.0>

Declared by:

plugins.none-ls.sources.diagnostics.mdl.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.mlint.enable

Whether to enable the mlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.mlint.package

Package to use for mlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.mlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.mypy.enable

Whether to enable the mypy diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.mypy.package

Package to use for mypy by none-ls.

Type: null or package

Default: <derivation mypy-1.9.0>

Declared by:

plugins.none-ls.sources.diagnostics.mypy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.npm_groovy_lint.enable

Whether to enable the npm_groovy_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.npm_groovy_lint.package

Package to use for npm_groovy_lint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.npm_groovy_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.opacheck.enable

Whether to enable the opacheck diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.opacheck.package

Package to use for opacheck by none-ls.

Type: null or package

Default: <derivation open-policy-agent-0.64.1>

Declared by:

plugins.none-ls.sources.diagnostics.opacheck.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.perlimports.enable

Whether to enable the perlimports diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.perlimports.package

Package to use for perlimports by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.perlimports.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.phpcs.enable

Whether to enable the phpcs diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.phpcs.package

Package to use for phpcs by none-ls.

Type: null or package

Default: <derivation php-codesniffer-3.9.0>

Declared by:

plugins.none-ls.sources.diagnostics.phpcs.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.phpmd.enable

Whether to enable the phpmd diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.phpmd.package

Package to use for phpmd by none-ls.

Type: null or package

Default: <derivation phpmd-2.15.0>

Declared by:

plugins.none-ls.sources.diagnostics.phpmd.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.phpstan.enable

Whether to enable the phpstan diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.phpstan.package

Package to use for phpstan by none-ls.

Type: null or package

Default: <derivation phpstan-1.11.1>

Declared by:

plugins.none-ls.sources.diagnostics.phpstan.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.pmd.enable

Whether to enable the pmd diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.pmd.package

Package to use for pmd by none-ls.

Type: null or package

Default: <derivation pmd-6.55.0>

Declared by:

plugins.none-ls.sources.diagnostics.pmd.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.proselint.enable

Whether to enable the proselint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.proselint.package

Package to use for proselint by none-ls.

Type: null or package

Default: <derivation proselint-0.13.0>

Declared by:

plugins.none-ls.sources.diagnostics.proselint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.protolint.enable

Whether to enable the protolint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.protolint.package

Package to use for protolint by none-ls.

Type: null or package

Default: <derivation protolint-0.49.7>

Declared by:

plugins.none-ls.sources.diagnostics.protolint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.puppet_lint.enable

Whether to enable the puppet_lint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.puppet_lint.package

Package to use for puppet_lint by none-ls.

Type: null or package

Default: <derivation puppet-lint-4.2.4>

Declared by:

plugins.none-ls.sources.diagnostics.puppet_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.pylint.enable

Whether to enable the pylint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.pylint.package

Package to use for pylint by none-ls.

Type: null or package

Default: <derivation pylint-3.1.1>

Declared by:

plugins.none-ls.sources.diagnostics.pylint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.qmllint.enable

Whether to enable the qmllint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.qmllint.package

Package to use for qmllint by none-ls.

Type: null or package

Default: <derivation qtdeclarative-6.7.2>

Declared by:

plugins.none-ls.sources.diagnostics.qmllint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.reek.enable

Whether to enable the reek diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.reek.package

Package to use for reek by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.reek.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.regal.enable

Whether to enable the regal diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.regal.package

Package to use for regal by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.regal.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.revive.enable

Whether to enable the revive diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.revive.package

Package to use for revive by none-ls.

Type: null or package

Default: <derivation revive-1.3.7>

Declared by:

plugins.none-ls.sources.diagnostics.revive.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.rpmspec.enable

Whether to enable the rpmspec diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.rpmspec.package

Package to use for rpmspec by none-ls.

Type: null or package

Default: <derivation rpm-4.18.1>

Declared by:

plugins.none-ls.sources.diagnostics.rpmspec.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.rstcheck.enable

Whether to enable the rstcheck diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.rstcheck.package

Package to use for rstcheck by none-ls.

Type: null or package

Default: <derivation rstcheck-6.2.1>

Declared by:

plugins.none-ls.sources.diagnostics.rstcheck.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.rubocop.enable

Whether to enable the rubocop diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.rubocop.package

Package to use for rubocop by none-ls.

Type: null or package

Default: <derivation ruby3.1-rubocop-1.62.1>

Declared by:

plugins.none-ls.sources.diagnostics.rubocop.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.saltlint.enable

Whether to enable the saltlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.saltlint.package

Package to use for saltlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.saltlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.selene.enable

Whether to enable the selene diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.selene.package

Package to use for selene by none-ls.

Type: null or package

Default: <derivation selene-0.27.1>

Declared by:

plugins.none-ls.sources.diagnostics.selene.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.semgrep.enable

Whether to enable the semgrep diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.semgrep.package

Package to use for semgrep by none-ls.

Type: null or package

Default: <derivation semgrep-1.74.0>

Declared by:

plugins.none-ls.sources.diagnostics.semgrep.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.solhint.enable

Whether to enable the solhint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.solhint.package

Package to use for solhint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.solhint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.spectral.enable

Whether to enable the spectral diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.spectral.package

Package to use for spectral by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.spectral.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.sqlfluff.enable

Whether to enable the sqlfluff diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.sqlfluff.package

Package to use for sqlfluff by none-ls.

Type: null or package

Default: <derivation sqlfluff-3.0.7>

Declared by:

plugins.none-ls.sources.diagnostics.sqlfluff.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.staticcheck.enable

Whether to enable the staticcheck diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.staticcheck.package

Package to use for staticcheck by none-ls.

Type: null or package

Default: <derivation go-tools-2023.1.7>

Declared by:

plugins.none-ls.sources.diagnostics.staticcheck.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.statix.enable

Whether to enable the statix diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.statix.package

Package to use for statix by none-ls.

Type: null or package

Default: <derivation statix-0.5.8>

Declared by:

plugins.none-ls.sources.diagnostics.statix.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.stylelint.enable

Whether to enable the stylelint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.stylelint.package

Package to use for stylelint by none-ls.

Type: null or package

Default: <derivation stylelint-16.5.0>

Declared by:

plugins.none-ls.sources.diagnostics.stylelint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.stylint.enable

Whether to enable the stylint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.stylint.package

Package to use for stylint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.stylint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.swiftlint.enable

Whether to enable the swiftlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.swiftlint.package

Package to use for swiftlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.swiftlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.teal.enable

Whether to enable the teal diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.teal.package

Package to use for teal by none-ls.

Type: null or package

Default: <derivation lua5.2-tl-0.15.3-1>

Declared by:

plugins.none-ls.sources.diagnostics.teal.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.terraform_validate.enable

Whether to enable the terraform_validate diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.terraform_validate.package

Package to use for terraform_validate by none-ls.

Type: null or package

Default: <derivation terraform-1.8.3>

Declared by:

plugins.none-ls.sources.diagnostics.terraform_validate.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.textidote.enable

Whether to enable the textidote diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.textidote.package

Package to use for textidote by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.textidote.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.textlint.enable

Whether to enable the textlint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.textlint.package

Package to use for textlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.textlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.tfsec.enable

Whether to enable the tfsec diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.tfsec.package

Package to use for tfsec by none-ls.

Type: null or package

Default: <derivation tfsec-1.28.6>

Declared by:

plugins.none-ls.sources.diagnostics.tfsec.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.tidy.enable

Whether to enable the tidy diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.tidy.package

Package to use for tidy by none-ls.

Type: null or package

Default: <derivation html-tidy-5.8.0>

Declared by:

plugins.none-ls.sources.diagnostics.tidy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.todo_comments.enable

Whether to enable the todo_comments diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.todo_comments.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.trail_space.enable

Whether to enable the trail_space diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.trail_space.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.trivy.enable

Whether to enable the trivy diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.trivy.package

Package to use for trivy by none-ls.

Type: null or package

Default: <derivation trivy-0.52.0>

Declared by:

plugins.none-ls.sources.diagnostics.trivy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.twigcs.enable

Whether to enable the twigcs diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.twigcs.package

Package to use for twigcs by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.twigcs.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.vacuum.enable

Whether to enable the vacuum diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.vacuum.package

Package to use for vacuum by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.diagnostics.vacuum.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.vale.enable

Whether to enable the vale diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.vale.package

Package to use for vale by none-ls.

Type: null or package

Default: <derivation vale-3.4.2>

Declared by:

plugins.none-ls.sources.diagnostics.vale.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.verilator.enable

Whether to enable the verilator diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.verilator.package

Package to use for verilator by none-ls.

Type: null or package

Default: <derivation verilator-5.022>

Declared by:

plugins.none-ls.sources.diagnostics.verilator.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.vint.enable

Whether to enable the vint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.vint.package

Package to use for vint by none-ls.

Type: null or package

Default: <derivation vim-vint-0.3.21>

Declared by:

plugins.none-ls.sources.diagnostics.vint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.write_good.enable

Whether to enable the write_good diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.write_good.package

Package to use for write_good by none-ls.

Type: null or package

Default: <derivation write-good-1.0.8>

Declared by:

plugins.none-ls.sources.diagnostics.write_good.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.yamllint.enable

Whether to enable the yamllint diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.yamllint.package

Package to use for yamllint by none-ls.

Type: null or package

Default: <derivation yamllint-1.35.1>

Declared by:

plugins.none-ls.sources.diagnostics.yamllint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.diagnostics.zsh.enable

Whether to enable the zsh diagnostics source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.diagnostics.zsh.package

Package to use for zsh by none-ls.

Type: null or package

Default: <derivation zsh-5.9>

Declared by:

plugins.none-ls.sources.diagnostics.zsh.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.alejandra.enable

Whether to enable the alejandra formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.alejandra.package

Package to use for alejandra by none-ls.

Type: null or package

Default: <derivation alejandra-3.0.0>

Declared by:

plugins.none-ls.sources.formatting.alejandra.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.asmfmt.enable

Whether to enable the asmfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.asmfmt.package

Package to use for asmfmt by none-ls.

Type: null or package

Default: <derivation asmfmt-1.3.2>

Declared by:

plugins.none-ls.sources.formatting.asmfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.astyle.enable

Whether to enable the astyle formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.astyle.package

Package to use for astyle by none-ls.

Type: null or package

Default: <derivation astyle-3.4.15>

Declared by:

plugins.none-ls.sources.formatting.astyle.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.bean_format.enable

Whether to enable the bean_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.bean_format.package

Package to use for bean_format by none-ls.

Type: null or package

Default: <derivation beancount-2.3.6>

Declared by:

plugins.none-ls.sources.formatting.bean_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.bibclean.enable

Whether to enable the bibclean formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.bibclean.package

Package to use for bibclean by none-ls.

Type: null or package

Default: <derivation bibclean-3.07>

Declared by:

plugins.none-ls.sources.formatting.bibclean.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.biome.enable

Whether to enable the biome formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.biome.package

Package to use for biome by none-ls.

Type: null or package

Default: <derivation biome-1.7.3>

Declared by:

plugins.none-ls.sources.formatting.biome.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.black.enable

Whether to enable the black formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.black.package

Package to use for black by none-ls.

Type: null or package

Default: <derivation python3.11-black-24.4.0>

Declared by:

plugins.none-ls.sources.formatting.black.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.blackd.enable

Whether to enable the blackd formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.blackd.package

Package to use for blackd by none-ls.

Type: null or package

Default: <derivation black-24.4.0>

Declared by:

plugins.none-ls.sources.formatting.blackd.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.blade_formatter.enable

Whether to enable the blade_formatter formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.blade_formatter.package

Package to use for blade_formatter by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.blade_formatter.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.bsfmt.enable

Whether to enable the bsfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.bsfmt.package

Package to use for bsfmt by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.bsfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.buf.enable

Whether to enable the buf formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.buf.package

Package to use for buf by none-ls.

Type: null or package

Default: <derivation buf-1.31.0>

Declared by:

plugins.none-ls.sources.formatting.buf.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.buildifier.enable

Whether to enable the buildifier formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.buildifier.package

Package to use for buildifier by none-ls.

Type: null or package

Default: <derivation bazel-buildtools-7.1.1>

Declared by:

plugins.none-ls.sources.formatting.buildifier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.cbfmt.enable

Whether to enable the cbfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.cbfmt.package

Package to use for cbfmt by none-ls.

Type: null or package

Default: <derivation cbfmt-0.2.0>

Declared by:

plugins.none-ls.sources.formatting.cbfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.clang_format.enable

Whether to enable the clang_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.clang_format.package

Package to use for clang_format by none-ls.

Type: null or package

Default: <derivation clang-tools-17.0.6>

Declared by:

plugins.none-ls.sources.formatting.clang_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.cljstyle.enable

Whether to enable the cljstyle formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.cljstyle.package

Package to use for cljstyle by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.cljstyle.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.cmake_format.enable

Whether to enable the cmake_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.cmake_format.package

Package to use for cmake_format by none-ls.

Type: null or package

Default: <derivation cmake-format-0.6.13>

Declared by:

plugins.none-ls.sources.formatting.cmake_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.codespell.enable

Whether to enable the codespell formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.codespell.package

Package to use for codespell by none-ls.

Type: null or package

Default: <derivation codespell-2.2.6>

Declared by:

plugins.none-ls.sources.formatting.codespell.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.crystal_format.enable

Whether to enable the crystal_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.crystal_format.package

Package to use for crystal_format by none-ls.

Type: null or package

Default: <derivation crystal-1.11.2>

Declared by:

plugins.none-ls.sources.formatting.crystal_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.csharpier.enable

Whether to enable the csharpier formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.csharpier.package

Package to use for csharpier by none-ls.

Type: null or package

Default: <derivation csharpier-0.28.2>

Declared by:

plugins.none-ls.sources.formatting.csharpier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.cue_fmt.enable

Whether to enable the cue_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.cue_fmt.package

Package to use for cue_fmt by none-ls.

Type: null or package

Default: <derivation cue-0.8.2>

Declared by:

plugins.none-ls.sources.formatting.cue_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.cueimports.enable

Whether to enable the cueimports formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.cueimports.package

Package to use for cueimports by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.cueimports.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.d2_fmt.enable

Whether to enable the d2_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.d2_fmt.package

Package to use for d2_fmt by none-ls.

Type: null or package

Default: <derivation d2-0.6.5>

Declared by:

plugins.none-ls.sources.formatting.d2_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.dart_format.enable

Whether to enable the dart_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.dart_format.package

Package to use for dart_format by none-ls.

Type: null or package

Default: <derivation dart-3.3.4>

Declared by:

plugins.none-ls.sources.formatting.dart_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.dfmt.enable

Whether to enable the dfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.dfmt.package

Package to use for dfmt by none-ls.

Type: null or package

Default: <derivation dfmt-1.2.0>

Declared by:

plugins.none-ls.sources.formatting.dfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.djhtml.enable

Whether to enable the djhtml formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.djhtml.package

Package to use for djhtml by none-ls.

Type: null or package

Default: <derivation djhtml-3.0.6>

Declared by:

plugins.none-ls.sources.formatting.djhtml.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.djlint.enable

Whether to enable the djlint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.djlint.package

Package to use for djlint by none-ls.

Type: null or package

Default: <derivation djlint-1.34.1>

Declared by:

plugins.none-ls.sources.formatting.djlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.dxfmt.enable

Whether to enable the dxfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.dxfmt.package

Package to use for dxfmt by none-ls.

Type: null or package

Default: <derivation dioxus-cli-0.5.4>

Declared by:

plugins.none-ls.sources.formatting.dxfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.elm_format.enable

Whether to enable the elm_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.elm_format.package

Package to use for elm_format by none-ls.

Type: null or package

Default: <derivation elm-format-0.8.7>

Declared by:

plugins.none-ls.sources.formatting.elm_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.emacs_scheme_mode.enable

Whether to enable the emacs_scheme_mode formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.emacs_scheme_mode.package

Package to use for emacs_scheme_mode by none-ls.

Type: null or package

Default: <derivation emacs-29.3>

Declared by:

plugins.none-ls.sources.formatting.emacs_scheme_mode.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.emacs_vhdl_mode.enable

Whether to enable the emacs_vhdl_mode formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.emacs_vhdl_mode.package

Package to use for emacs_vhdl_mode by none-ls.

Type: null or package

Default: <derivation emacs-29.3>

Declared by:

plugins.none-ls.sources.formatting.emacs_vhdl_mode.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.erb_format.enable

Whether to enable the erb_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.erb_format.package

Package to use for erb_format by none-ls.

Type: null or package

Default: <derivation ruby3.1-erb-formatter-0.7.2>

Declared by:

plugins.none-ls.sources.formatting.erb_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.erb_lint.enable

Whether to enable the erb_lint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.erb_lint.package

Package to use for erb_lint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.erb_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.erlfmt.enable

Whether to enable the erlfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.erlfmt.package

Package to use for erlfmt by none-ls.

Type: null or package

Default: <derivation erlfmt-1.3.0>

Declared by:

plugins.none-ls.sources.formatting.erlfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.fantomas.enable

Whether to enable the fantomas formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.fantomas.package

Package to use for fantomas by none-ls.

Type: null or package

Default: <derivation fantomas-6.3.4>

Declared by:

plugins.none-ls.sources.formatting.fantomas.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.findent.enable

Whether to enable the findent formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.findent.package

Package to use for findent by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.findent.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.fish_indent.enable

Whether to enable the fish_indent formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.fish_indent.package

Package to use for fish_indent by none-ls.

Type: null or package

Default: <derivation fish-3.7.1>

Declared by:

plugins.none-ls.sources.formatting.fish_indent.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.fnlfmt.enable

Whether to enable the fnlfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.fnlfmt.package

Package to use for fnlfmt by none-ls.

Type: null or package

Default: <derivation fnlfmt-0.3.1>

Declared by:

plugins.none-ls.sources.formatting.fnlfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.forge_fmt.enable

Whether to enable the forge_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.forge_fmt.package

Package to use for forge_fmt by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.forge_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.format_r.enable

Whether to enable the format_r formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.format_r.package

Package to use for format_r by none-ls.

Type: null or package

Default: <derivation R-4.3.3>

Declared by:

plugins.none-ls.sources.formatting.format_r.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.fprettify.enable

Whether to enable the fprettify formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.fprettify.package

Package to use for fprettify by none-ls.

Type: null or package

Default: <derivation fprettify-0.3.7>

Declared by:

plugins.none-ls.sources.formatting.fprettify.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gdformat.enable

Whether to enable the gdformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gdformat.package

Package to use for gdformat by none-ls.

Type: null or package

Default: <derivation gdtoolkit-3.3.1>

Declared by:

plugins.none-ls.sources.formatting.gdformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gersemi.enable

Whether to enable the gersemi formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gersemi.package

Package to use for gersemi by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.gersemi.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gleam_format.enable

Whether to enable the gleam_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gleam_format.package

Package to use for gleam_format by none-ls.

Type: null or package

Default: <derivation gleam-1.1.0>

Declared by:

plugins.none-ls.sources.formatting.gleam_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gn_format.enable

Whether to enable the gn_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gn_format.package

Package to use for gn_format by none-ls.

Type: null or package

Default: <derivation gn-unstable-2020-03-09>

Declared by:

plugins.none-ls.sources.formatting.gn_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gofmt.enable

Whether to enable the gofmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gofmt.package

Package to use for gofmt by none-ls.

Type: null or package

Default: <derivation go-1.22.4>

Declared by:

plugins.none-ls.sources.formatting.gofmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.gofumpt.enable

Whether to enable the gofumpt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.gofumpt.package

Package to use for gofumpt by none-ls.

Type: null or package

Default: <derivation gofumpt-0.6.0>

Declared by:

plugins.none-ls.sources.formatting.gofumpt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.goimports.enable

Whether to enable the goimports formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.goimports.package

Package to use for goimports by none-ls.

Type: null or package

Default: <derivation gotools-0.18.0>

Declared by:

plugins.none-ls.sources.formatting.goimports.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.goimports_reviser.enable

Whether to enable the goimports_reviser formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.goimports_reviser.package

Package to use for goimports_reviser by none-ls.

Type: null or package

Default: <derivation goimports-reviser-3.6.5>

Declared by:

plugins.none-ls.sources.formatting.goimports_reviser.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.golines.enable

Whether to enable the golines formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.golines.package

Package to use for golines by none-ls.

Type: null or package

Default: <derivation golines-0.12.2>

Declared by:

plugins.none-ls.sources.formatting.golines.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.google_java_format.enable

Whether to enable the google_java_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.google_java_format.package

Package to use for google_java_format by none-ls.

Type: null or package

Default: <derivation google-java-format-1.22.0>

Declared by:

plugins.none-ls.sources.formatting.google_java_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.haxe_formatter.enable

Whether to enable the haxe_formatter formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.haxe_formatter.package

Package to use for haxe_formatter by none-ls.

Type: null or package

Default: <derivation haxe-4.3.4>

Declared by:

plugins.none-ls.sources.formatting.haxe_formatter.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.hclfmt.enable

Whether to enable the hclfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.hclfmt.package

Package to use for hclfmt by none-ls.

Type: null or package

Default: <derivation hclfmt-2.20.1>

Declared by:

plugins.none-ls.sources.formatting.hclfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.htmlbeautifier.enable

Whether to enable the htmlbeautifier formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.htmlbeautifier.package

Package to use for htmlbeautifier by none-ls.

Type: null or package

Default: <derivation ruby3.1-htmlbeautifier-1.4.3>

Declared by:

plugins.none-ls.sources.formatting.htmlbeautifier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.isort.enable

Whether to enable the isort formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.isort.package

Package to use for isort by none-ls.

Type: null or package

Default: <derivation isort-5.13.2>

Declared by:

plugins.none-ls.sources.formatting.isort.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.isortd.enable

Whether to enable the isortd formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.isortd.package

Package to use for isortd by none-ls.

Type: null or package

Default: <derivation isort-5.13.2>

Declared by:

plugins.none-ls.sources.formatting.isortd.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.joker.enable

Whether to enable the joker formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.joker.package

Package to use for joker by none-ls.

Type: null or package

Default: <derivation joker-1.3.5>

Declared by:

plugins.none-ls.sources.formatting.joker.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.just.enable

Whether to enable the just formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.just.package

Package to use for just by none-ls.

Type: null or package

Default: <derivation just-1.28.0>

Declared by:

plugins.none-ls.sources.formatting.just.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.ktlint.enable

Whether to enable the ktlint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.ktlint.package

Package to use for ktlint by none-ls.

Type: null or package

Default: <derivation ktlint-1.2.1>

Declared by:

plugins.none-ls.sources.formatting.ktlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.leptosfmt.enable

Whether to enable the leptosfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.leptosfmt.package

Package to use for leptosfmt by none-ls.

Type: null or package

Default: <derivation leptosfmt-0.1.18>

Declared by:

plugins.none-ls.sources.formatting.leptosfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.markdownlint.enable

Whether to enable the markdownlint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.markdownlint.package

Package to use for markdownlint by none-ls.

Type: null or package

Default: <derivation markdownlint-cli-0.40.0>

Declared by:

plugins.none-ls.sources.formatting.markdownlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.mdformat.enable

Whether to enable the mdformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.mdformat.package

Package to use for mdformat by none-ls.

Type: null or package

Default: <derivation mdformat-wrapped>

Declared by:

plugins.none-ls.sources.formatting.mdformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.mix.enable

Whether to enable the mix formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.mix.package

Package to use for mix by none-ls.

Type: null or package

Default: <derivation elixir-1.16.3>

Declared by:

plugins.none-ls.sources.formatting.mix.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.nginx_beautifier.enable

Whether to enable the nginx_beautifier formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.nginx_beautifier.package

Package to use for nginx_beautifier by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.nginx_beautifier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.nimpretty.enable

Whether to enable the nimpretty formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.nimpretty.package

Package to use for nimpretty by none-ls.

Type: null or package

Default: <derivation x86_64-unknown-linux-gnu-nim-wrapper-2.0.4>

Declared by:

plugins.none-ls.sources.formatting.nimpretty.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.nixfmt.enable

Whether to enable the nixfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.nixfmt.package

Package to use for nixfmt by none-ls.

Type: null or package

Default: <derivation nixfmt-0.6.0>

Declared by:

plugins.none-ls.sources.formatting.nixfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.nixpkgs_fmt.enable

Whether to enable the nixpkgs_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.nixpkgs_fmt.package

Package to use for nixpkgs_fmt by none-ls.

Type: null or package

Default: <derivation nixpkgs-fmt-1.3.0>

Declared by:

plugins.none-ls.sources.formatting.nixpkgs_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.npm_groovy_lint.enable

Whether to enable the npm_groovy_lint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.npm_groovy_lint.package

Package to use for npm_groovy_lint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.npm_groovy_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.ocamlformat.enable

Whether to enable the ocamlformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.ocamlformat.package

Package to use for ocamlformat by none-ls.

Type: null or package

Default: <derivation ocaml5.1.1-ocamlformat-0.26.2>

Declared by:

plugins.none-ls.sources.formatting.ocamlformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.ocdc.enable

Whether to enable the ocdc formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.ocdc.package

Package to use for ocdc by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.ocdc.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.packer.enable

Whether to enable the packer formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.packer.package

Package to use for packer by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.packer.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.pg_format.enable

Whether to enable the pg_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.pg_format.package

Package to use for pg_format by none-ls.

Type: null or package

Default: <derivation perl5.38.2-pgformatter-5.5>

Declared by:

plugins.none-ls.sources.formatting.pg_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.phpcbf.enable

Whether to enable the phpcbf formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.phpcbf.package

Package to use for phpcbf by none-ls.

Type: null or package

Default: <derivation php-codesniffer-3.9.0>

Declared by:

plugins.none-ls.sources.formatting.phpcbf.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.phpcsfixer.enable

Whether to enable the phpcsfixer formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.phpcsfixer.package

Package to use for phpcsfixer by none-ls.

Type: null or package

Default: <derivation php-cs-fixer-3.51.0>

Declared by:

plugins.none-ls.sources.formatting.phpcsfixer.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.pint.enable

Whether to enable the pint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.pint.package

Package to use for pint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.pint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.prettier.enable

Whether to enable the prettier formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.prettier.package

Package to use for prettier by none-ls.

Type: null or package

Default: <derivation prettier-3.2.5>

Declared by:

plugins.none-ls.sources.formatting.prettier.disableTsServerFormatter

Disables the formatting capability of the tsserver language server if it is enabled.

Type: null or boolean

Default: null

Example: true

Declared by:

plugins.none-ls.sources.formatting.prettier.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.prettierd.enable

Whether to enable the prettierd formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.prettierd.package

Package to use for prettierd by none-ls.

Type: null or package

Default: <derivation fsouza-prettierd-0.25.3>

Declared by:

plugins.none-ls.sources.formatting.prettierd.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.pretty_php.enable

Whether to enable the pretty_php formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.pretty_php.package

Package to use for pretty_php by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.pretty_php.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.prisma_format.enable

Whether to enable the prisma_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.prisma_format.package

Package to use for prisma_format by none-ls.

Type: null or package

Default: <derivation prisma-5.12.1>

Declared by:

plugins.none-ls.sources.formatting.prisma_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.protolint.enable

Whether to enable the protolint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.protolint.package

Package to use for protolint by none-ls.

Type: null or package

Default: <derivation protolint-0.49.7>

Declared by:

plugins.none-ls.sources.formatting.protolint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.ptop.enable

Whether to enable the ptop formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.ptop.package

Package to use for ptop by none-ls.

Type: null or package

Default: <derivation fpc-3.2.2>

Declared by:

plugins.none-ls.sources.formatting.ptop.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.puppet_lint.enable

Whether to enable the puppet_lint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.puppet_lint.package

Package to use for puppet_lint by none-ls.

Type: null or package

Default: <derivation puppet-lint-4.2.4>

Declared by:

plugins.none-ls.sources.formatting.puppet_lint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.purs_tidy.enable

Whether to enable the purs_tidy formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.purs_tidy.package

Package to use for purs_tidy by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.purs_tidy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.pyink.enable

Whether to enable the pyink formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.pyink.package

Package to use for pyink by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.pyink.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.qmlformat.enable

Whether to enable the qmlformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.qmlformat.package

Package to use for qmlformat by none-ls.

Type: null or package

Default: <derivation qtdeclarative-6.7.2>

Declared by:

plugins.none-ls.sources.formatting.qmlformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.racket_fixw.enable

Whether to enable the racket_fixw formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.racket_fixw.package

Package to use for racket_fixw by none-ls.

Type: null or package

Default: <derivation racket-8.13>

Declared by:

plugins.none-ls.sources.formatting.racket_fixw.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.raco_fmt.enable

Whether to enable the raco_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.raco_fmt.package

Package to use for raco_fmt by none-ls.

Type: null or package

Default: <derivation racket-8.13>

Declared by:

plugins.none-ls.sources.formatting.raco_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rego.enable

Whether to enable the rego formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rego.package

Package to use for rego by none-ls.

Type: null or package

Default: <derivation open-policy-agent-0.64.1>

Declared by:

plugins.none-ls.sources.formatting.rego.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.remark.enable

Whether to enable the remark formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.remark.package

Package to use for remark by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.remark.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rescript.enable

Whether to enable the rescript formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rescript.package

Package to use for rescript by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.rescript.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rubocop.enable

Whether to enable the rubocop formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rubocop.package

Package to use for rubocop by none-ls.

Type: null or package

Default: <derivation ruby3.1-rubocop-1.62.1>

Declared by:

plugins.none-ls.sources.formatting.rubocop.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rubyfmt.enable

Whether to enable the rubyfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rubyfmt.package

Package to use for rubyfmt by none-ls.

Type: null or package

Default: <derivation rubyfmt-0.10.0>

Declared by:

plugins.none-ls.sources.formatting.rubyfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rufo.enable

Whether to enable the rufo formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rufo.package

Package to use for rufo by none-ls.

Type: null or package

Default: <derivation rufo-0.17.0>

Declared by:

plugins.none-ls.sources.formatting.rufo.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.rustywind.enable

Whether to enable the rustywind formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.rustywind.package

Package to use for rustywind by none-ls.

Type: null or package

Default: <derivation rustywind-0.22.0>

Declared by:

plugins.none-ls.sources.formatting.rustywind.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.scalafmt.enable

Whether to enable the scalafmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.scalafmt.package

Package to use for scalafmt by none-ls.

Type: null or package

Default: <derivation scalafmt-3.7.9>

Declared by:

plugins.none-ls.sources.formatting.scalafmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.shellharden.enable

Whether to enable the shellharden formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.shellharden.package

Package to use for shellharden by none-ls.

Type: null or package

Default: <derivation shellharden-4.3.1>

Declared by:

plugins.none-ls.sources.formatting.shellharden.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.shfmt.enable

Whether to enable the shfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.shfmt.package

Package to use for shfmt by none-ls.

Type: null or package

Default: <derivation shfmt-3.8.0>

Declared by:

plugins.none-ls.sources.formatting.shfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.smlfmt.enable

Whether to enable the smlfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.smlfmt.package

Package to use for smlfmt by none-ls.

Type: null or package

Default: <derivation smlfmt-1.1.0>

Declared by:

plugins.none-ls.sources.formatting.smlfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.sql_formatter.enable

Whether to enable the sql_formatter formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.sql_formatter.package

Package to use for sql_formatter by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.sql_formatter.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.sqlfluff.enable

Whether to enable the sqlfluff formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.sqlfluff.package

Package to use for sqlfluff by none-ls.

Type: null or package

Default: <derivation sqlfluff-3.0.7>

Declared by:

plugins.none-ls.sources.formatting.sqlfluff.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.sqlfmt.enable

Whether to enable the sqlfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.sqlfmt.package

Package to use for sqlfmt by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.sqlfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.sqlformat.enable

Whether to enable the sqlformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.sqlformat.package

Package to use for sqlformat by none-ls.

Type: null or package

Default: <derivation python3.11-sqlparse-0.5.0>

Declared by:

plugins.none-ls.sources.formatting.sqlformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.stylelint.enable

Whether to enable the stylelint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.stylelint.package

Package to use for stylelint by none-ls.

Type: null or package

Default: <derivation stylelint-16.5.0>

Declared by:

plugins.none-ls.sources.formatting.stylelint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.styler.enable

Whether to enable the styler formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.styler.package

Package to use for styler by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.styler.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.stylua.enable

Whether to enable the stylua formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.stylua.package

Package to use for stylua by none-ls.

Type: null or package

Default: <derivation stylua-0.20.0>

Declared by:

plugins.none-ls.sources.formatting.stylua.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.surface.enable

Whether to enable the surface formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.surface.package

Package to use for surface by none-ls.

Type: null or package

Default: <derivation elixir-1.16.3>

Declared by:

plugins.none-ls.sources.formatting.surface.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.swift_format.enable

Whether to enable the swift_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.swift_format.package

Package to use for swift_format by none-ls.

Type: null or package

Default: <derivation swift-format-5.8>

Declared by:

plugins.none-ls.sources.formatting.swift_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.swiftformat.enable

Whether to enable the swiftformat formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.swiftformat.package

Package to use for swiftformat by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.swiftformat.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.swiftlint.enable

Whether to enable the swiftlint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.swiftlint.package

Package to use for swiftlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.swiftlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.terraform_fmt.enable

Whether to enable the terraform_fmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.terraform_fmt.package

Package to use for terraform_fmt by none-ls.

Type: null or package

Default: <derivation terraform-1.8.3>

Declared by:

plugins.none-ls.sources.formatting.terraform_fmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.textlint.enable

Whether to enable the textlint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.textlint.package

Package to use for textlint by none-ls. Not handled in nixvim, either install externally and set to null or set the option with a derivation.

Type: null or package

Declared by:

plugins.none-ls.sources.formatting.textlint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.tidy.enable

Whether to enable the tidy formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.tidy.package

Package to use for tidy by none-ls.

Type: null or package

Default: <derivation html-tidy-5.8.0>

Declared by:

plugins.none-ls.sources.formatting.tidy.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.topiary.enable

Whether to enable the topiary formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.topiary.package

Package to use for topiary by none-ls.

Type: null or package

Default: <derivation topiary-0.3.0>

Declared by:

plugins.none-ls.sources.formatting.topiary.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.treefmt.enable

Whether to enable the treefmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.treefmt.package

Package to use for treefmt by none-ls.

Type: null or package

Default: <derivation treefmt-0.6.1>

Declared by:

plugins.none-ls.sources.formatting.treefmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.typstfmt.enable

Whether to enable the typstfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.typstfmt.package

Package to use for typstfmt by none-ls.

Type: null or package

Default: <derivation typstfmt-0.2.9>

Declared by:

plugins.none-ls.sources.formatting.typstfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.uncrustify.enable

Whether to enable the uncrustify formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.uncrustify.package

Package to use for uncrustify by none-ls.

Type: null or package

Default: <derivation uncrustify-0.79.0>

Declared by:

plugins.none-ls.sources.formatting.uncrustify.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.usort.enable

Whether to enable the usort formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.usort.package

Package to use for usort by none-ls.

Type: null or package

Default: <derivation usort-1.0.7>

Declared by:

plugins.none-ls.sources.formatting.usort.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.verible_verilog_format.enable

Whether to enable the verible_verilog_format formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.verible_verilog_format.package

Package to use for verible_verilog_format by none-ls.

Type: null or package

Default: <derivation verible-0.0.3515>

Declared by:

plugins.none-ls.sources.formatting.verible_verilog_format.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.yamlfix.enable

Whether to enable the yamlfix formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.yamlfix.package

Package to use for yamlfix by none-ls.

Type: null or package

Default: <derivation yamlfix-1.16.0>

Declared by:

plugins.none-ls.sources.formatting.yamlfix.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.yamlfmt.enable

Whether to enable the yamlfmt formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.yamlfmt.package

Package to use for yamlfmt by none-ls.

Type: null or package

Default: <derivation yamlfmt-0.12.1>

Declared by:

plugins.none-ls.sources.formatting.yamlfmt.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.yapf.enable

Whether to enable the yapf formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.yapf.package

Package to use for yapf by none-ls.

Type: null or package

Default: <derivation yapf-0.40.2>

Declared by:

plugins.none-ls.sources.formatting.yapf.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.formatting.zprint.enable

Whether to enable the zprint formatting source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.formatting.zprint.package

Package to use for zprint by none-ls.

Type: null or package

Default: <derivation zprint-1.2.9>

Declared by:

plugins.none-ls.sources.formatting.zprint.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.hover.dictionary.enable

Whether to enable the dictionary hover source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.hover.dictionary.package

Package to use for dictionary by none-ls.

Type: null or package

Default: <derivation curl-8.7.1>

Declared by:

plugins.none-ls.sources.hover.dictionary.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.none-ls.sources.hover.printenv.enable

Whether to enable the printenv hover source for none-ls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.none-ls.sources.hover.printenv.withArgs

Raw Lua code passed as an argument to the source’s with method.

Type: null or lua code string

Default: null

Declared by:

plugins.notify.enable

Whether to enable nvim-notify.

Type: boolean

Default: false

Example: true

Declared by:

plugins.notify.package

Which package to use for the nvim-notify plugin.

Type: package

Default: <derivation vimplugin-nvim-notify-2024-02-17>

Declared by:

plugins.notify.backgroundColour

For stages that change opacity this is treated as the highlight behind the window. Set this to either a highlight group, an RGB hex value e.g. “#000000” or a function returning an RGB code for dynamic values.

Plugin default: "NotifyBackground"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.notify.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.notify.fps

Frames per second for animation stages, higher value means smoother animations but more CPU usage.

Plugin default: 30

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.notify.level

Minimum log level to display. See vim.log.levels.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

plugins.notify.maxHeight

Max number of lines for a message.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.maxWidth

Max number of columns for messages.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.minimumWidth

Minimum width for notification windows.

Plugin default: 50

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.onClose

Function called when a new window is closed.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.notify.onOpen

Function called when a new window is opened, use for changing win settings/config.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.notify.render

Function to render a notification buffer or a built-in renderer name.

Plugin default: default

Type: null or one of “default”, “minimal” or raw lua code

Default: null

Declared by:

plugins.notify.stages

Animation stages. Can be either one of the builtin stages or an array of lua functions.

Plugin default: fade_in_slide_out

Type: null or one of “fade”, “slide”, “fade_in_slide_out”, “static” or list of string

Default: null

Declared by:

plugins.notify.timeout

Default timeout for notification.

Plugin default: 5000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.topDown

Whether or not to position the notifications at the top or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.notify.icons.debug

Icon for the debug level.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.notify.icons.error

Icon for the error level.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.notify.icons.info

Icon for the info level.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.notify.icons.trace

Icon for the trace level.

Plugin default: "✎"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.notify.icons.warn

Icon for the warn level.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

nvim-autopairs

Url: https://github.com/windwp/nvim-autopairs/

Maintainers: Gaetan Lepage

plugins.nvim-autopairs.enable

Whether to enable nvim-autopairs.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-autopairs.package

Which package to use for the nvim-autopairs plugin.

Type: package

Default: <derivation vimplugin-nvim-autopairs-2024-05-16>

Declared by:

plugins.nvim-autopairs.settings

Options provided to the require('nvim-autopairs').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  disable_filetype = [
    "TelescopePrompt"
  ];
  fast_wrap = {
    end_key = "$";
    map = "<M-e>";
  };
}

Declared by:

plugins.nvim-autopairs.settings.enable_abbr

Trigger abbreviation.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.enable_afterquote

Add bracket pairs after quote.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.enable_bracket_in_quote

Enable bracket in quote.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.enable_check_bracket_line

Check bracket in same line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.enable_moveright

Enable moveright.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.break_undo

Switch for basic rule break undo sequence.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.check_ts

Use treesitter to check for a pair.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.disable_filetype

Disabled filetypes.

Plugin default: ["TelescopePrompt" "spectre_panel"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-autopairs.settings.disable_in_macro

Disable when recording or executing a macro.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.disable_in_replace_mode

Disable in replace mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.disable_in_visualblock

Disable when insert after visual block mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.ignored_next_char

Regexp to ignore if it matches the next character.

Plugin default: [=[[%w%%%'%[%"%.%%$]]=]`

Type: null or lua code string

Default: null

Declared by:

plugins.nvim-autopairs.settings.map_bs

Map the <BS> key to delete the pair.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.map_c_h

Map the <C-h> key to delete a pair.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.map_c_w

Map the <C-w> key to delete a pair if possible.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.map_cr

Map the <CR> key to confirm the completion.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.ts_config

Configuration for TreeSitter.

Plugin default:

{
  lua = [
    "string"
    "source"
    "string_content"
  ];
  javascript = [
    "string"
    "template_string"
  ];
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.after_key

After key.

Plugin default: "l"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.before_key

Before key.

Plugin default: "h"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.chars

Characters for which to enable fast wrap.

Plugin default: ["{" "[" "(" "\"" "'"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.cursor_pos_before

Whether the cursor should be placed before or after the substitution.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.end_key

End key.

Plugin default: "$"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.highlight

Which highlight group to use for the match.

Plugin default: "Search"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.highlight_grey

Which highlight group to use for the grey part.

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.keys

Plugin default: "qwertyuiopzxcvbnmasdfghjkl"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.manual_position

Whether to enable manual position.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.map

The key to trigger fast_wrap.

Plugin default: "<M-e>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.pattern

The pattern to match against.

Plugin default: [=[[%'%"%>%]%)%}%,%]]=]`

Type: null or lua code string

Default: null

Declared by:

plugins.nvim-autopairs.settings.fast_wrap.use_virt_lines

Whether to use virt_lines.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.enable

Whether to enable nvim-bqf.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-bqf.package

Which package to use for the nvim-bqf plugin.

Type: package

Default: <derivation vimplugin-nvim-bqf-2024-05-07>

Declared by:

plugins.nvim-bqf.autoEnable

Enable nvim-bqf in quickfix window automatically.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.autoResizeHeight

Resize quickfix window height automatically. Shrink higher height to size of list in quickfix window, otherwise extend height to size of list or to default height (10).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.nvim-bqf.funcMap

The table for {function = key}.

Example (some default values): funcMap = { open = “<CR>”; tab = “t”; sclear = “z<Tab>”; };

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.nvim-bqf.magicWindow

Give the window magic, when the window is split horizontally, keep the distance between the current line and the top/bottom border of neovim unchanged. It’s a bit like a floating window, but the window is indeed a normal window, without any floating attributes.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.extraOpts

Extra options for fzf.

Plugin default: [ "--bind" "ctrl-o:toggle-all" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.actionFor.ctrl-c

Press ctrl-c to close quickfix window and abort fzf.

Plugin default: "closeall"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.actionFor.ctrl-q

Press ctrl-q to toggle sign for the selected items.

Plugin default: "signtoggle"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.actionFor.ctrl-t

Press ctrl-t to open up the item in a new tab.

Plugin default: "tabedit"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.actionFor.ctrl-v

Press ctrl-v to open up the item in a new vertical split.

Plugin default: "vsplit"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.filter.fzf.actionFor.ctrl-x

Press ctrl-x to open up the item in a new horizontal split.

Plugin default: "split"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.autoPreview

Enable preview in quickfix window automatically.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.borderChars

Border and scroll bar chars, they respectively represent: vline, vline, hline, hline, ulcorner, urcorner, blcorner, brcorner, sbar

Plugin default: [ "│" "│" "─" "─" "╭" "╮" "╰" "╯" "█" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-bqf.preview.bufLabel

Add label of current item buffer at the end of the item line.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.delaySyntax

Delay time, to do syntax for previewed buffer, unit is millisecond.

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.shouldPreviewCb

A callback function to decide whether to preview while switching buffer, with (bufnr: number, qwinid: number) parameters.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.nvim-bqf.preview.showTitle

Show the window title.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.winHeight

The height of preview window for horizontal layout. Large value (like 999) perform preview window as a “full” mode.

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.winVheight

The height of preview window for vertical layout.

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-bqf.preview.wrap

Wrap the line, :h wrap for detail.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-colorizer.enable

Whether to enable nvim-colorizer.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-colorizer.package

Which package to use for the nvim-colorizer plugin.

Type: package

Default: <derivation vimplugin-nvim-colorizer.lua-2023-12-23>

Declared by:

plugins.nvim-colorizer.bufTypes

Buftype value is fetched by vim.bo.buftype

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-colorizer.fileTypes

Enable and/or configure highlighting for certain filetypes

Type: null or (list of (string or (submodule)))

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions

Default options

Type: null or (submodule)

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.AARRGGBB

0xAARRGGBB hex codes

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.RGB

#RGB hex codes

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.RRGGBB

#RRGGBB hex codes

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.RRGGBBAA

#RRGGBBAA hex codes

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.css

Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.css_fn

Enable all CSS functions: rgb_fn, hsl_fn

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.hsl_fn

CSS hsl() and hsla() functions

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.mode

Set the display mode

Type: null or one of “foreground”, “background”, “virtualtext”

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.names

“Name” codes like Blue or blue

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.rgb_fn

CSS rgb() and rgba() functions

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.tailwind

Enable tailwind colors

Type: null or boolean or one of “normal”, “lsp”, “both”

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.virtualtext

Set the virtualtext character (only used when mode is set to ‘virtualtext’)

Type: null or string

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.sass.enable

Enable sass colors

Type: null or boolean

Default: null

Declared by:

plugins.nvim-colorizer.userDefaultOptions.sass.parsers

sass parsers settings

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-jdtls.enable

Whether to enable nvim-jdtls.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-jdtls.package

Which package to use for the nvim-jdtls plugin.

Type: package

Default: <derivation vimplugin-nvim-jdtls-2024-05-16>

Declared by:

plugins.nvim-jdtls.cmd

The command that starts the language server.

You should either set a value for this option, or, you can instead set the data (and configuration) options.

plugins.nvim-jdtls = {
  enable = true;
  cmd = [
    (lib.getExe pkgs.jdt-language-server)
    "-data" "/path/to/your/workspace"
    "-configuration" "/path/to/your/configuration"
    "-foo" "bar"
  ];
};

Or,

plugins.nvim-jdtls = {
  enable = true;
  data =  "/path/to/your/workspace";
  configuration = "/path/to/your/configuration";
};

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-jdtls.configuration

Path to the configuration file.

Type: null or string

Default: null

Example: "/home/YOUR_USERNAME/.cache/jdtls/config"

Declared by:

plugins.nvim-jdtls.data

eclipse.jdt.ls stores project specific data within the folder set via the -data flag. If you’re using eclipse.jdt.ls with multiple different projects you must use a dedicated data directory per project.

Type: null or string

Default: null

Example: "/home/YOUR_USERNAME/.cache/jdtls/workspace"

Declared by:

plugins.nvim-jdtls.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.nvim-jdtls.initOptions

Language server initializationOptions You need to extend the bundles with paths to jar files if you want to use additional eclipse.jdt.ls plugins.

See https://github.com/mfussenegger/nvim-jdtls#java-debug-installation

If you don’t plan on using the debugger or other eclipse.jdt.ls plugins, ignore this option

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-jdtls.rootDir

This is the default if not provided, you can remove it. Or adjust as needed. One dedicated LSP server & client will be started per unique root_dir

Plugin default: { __raw = "require('jdtls.setup').find_root({'.git', 'mvnw', 'gradlew'})"; }

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-jdtls.settings

Here you can configure eclipse.jdt.ls specific settings See https://github.com/eclipse/eclipse.jdt.ls/wiki/Running-the-JAVA-LS-server-from-the-command-line#initialize-request for a list of options.

Type: null or (attribute set)

Default: null

Declared by:

nvim-lightbulb

Url: https://github.com/kosayoda/nvim-lightbulb/

Maintainers: Gaetan Lepage

plugins.nvim-lightbulb.enable

Whether to enable nvim-lightbulb.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-lightbulb.package

Which package to use for the nvim-lightbulb plugin.

Type: package

Default: <derivation vimplugin-nvim-lightbulb-2023-07-20>

Declared by:

plugins.nvim-lightbulb.settings

Options provided to the require('nvim-lightbulb').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  autocmd = {
    enabled = true;
    updatetime = 200;
  };
  float = {
    enabled = false;
    text = " 󰌶 ";
    win_opts = {
      border = "rounded";
    };
  };
  line = {
    enabled = false;
  };
  number = {
    enabled = false;
  };
  sign = {
    enabled = false;
    text = "󰌶";
  };
  status_text = {
    enabled = false;
    text = " 󰌶 ";
  };
  virtual_text = {
    enabled = true;
    text = "󰌶";
  };
}

Declared by:

plugins.nvim-lightbulb.settings.action_kinds

Code action kinds to observe. To match all code actions, set to null. Otherwise, set to a list of kinds.

Example:

  [
    "quickfix"
    "refactor.rewrite"
  ]

See: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#codeActionKind

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-lightbulb.settings.hide_in_unfocused_buffer

Whether or not to hide the lightbulb when the buffer is not focused. Only works if configured during NvimLightbulb.setup.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

Whether or not to link the highlight groups automatically. Default highlight group links:

  • LightBulbSign -> DiagnosticSignInfo
  • LightBulbFloatWin -> DiagnosticFloatingInfo
  • LightBulbVirtualText -> DiagnosticVirtualTextInfo
  • LightBulbNumber -> DiagnosticSignInfo
  • LightBulbLine -> CursorLine

Only works if configured during NvimLightbulb.setup.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.priority

Priority of the lightbulb for all handlers except float.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.validate_config

Perform full validation of configuration.

  • “auto” only performs full validation in NvimLightbulb.setup.
  • “always” performs full validation in NvimLightbulb.update_lightbulb as well.
  • “never” disables config validation.

Plugin default: "auto"

Type: null or one of “auto”, “always”, “never” or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.autocmd.enabled

Autocmd configuration. If enabled, automatically defines an autocmd to show the lightbulb. If disabled, you will have to manually call |NvimLightbulb.update_lightbulb|. Only works if configured during NvimLightbulb.setup.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.autocmd.events

See |nvim_create_autocmd|.

Plugin default: ["CursorHold" "CursorHoldI"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-lightbulb.settings.autocmd.pattern

See |nvim_create_autocmd| and |autocmd-pattern|.

Plugin default: ["*"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-lightbulb.settings.autocmd.updatetime

See |updatetime|. Set to a negative value to avoid setting the updatetime.

Plugin default: 200

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.float.enabled

Floating window.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.float.hl

Highlight group to highlight the floating window.

Plugin default: "LightBulbFloatWin"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.float.text

Text to show in the floating window.

Plugin default: "💡"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.float.win_opts

Window options. See |vim.lsp.util.open_floating_preview| and |nvim_open_win|. Note that some options may be overridden by |open_floating_preview|.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.nvim-lightbulb.settings.ignore.actions_without_kind

Ignore code actions without a kind like refactor.rewrite, quickfix.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.ignore.clients

LSP client names to ignore. Example: {“null-ls”, “lua_ls”}

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-lightbulb.settings.ignore.ft

Filetypes to ignore. Example: {“neo-tree”, “lua”}

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.nvim-lightbulb.settings.line.enabled

Content line.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.line.hl

Highlight group to highlight the line if there is a lightbulb.

Plugin default: "LightBulbLine"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.number.enabled

Number column.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.number.hl

Highlight group to highlight the number column if there is a lightbulb.

Plugin default: "LightBulbNumber"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.sign.enabled

Sign column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.sign.hl

Highlight group to highlight the sign column text.

Plugin default: "LightBulbSign"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.sign.text

Text to show in the sign column. Must be between 1-2 characters.

Plugin default: "💡"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.status_text.enabled

Status text. When enabled, will allow using |NvimLightbulb.get_status_text| to retrieve the configured text.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.status_text.text

Text to set if a lightbulb is available.

Plugin default: "💡"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.status_text.text_unavailable

Text to set if a lightbulb is unavailable.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.virtual_text.enabled

Virtual text.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.virtual_text.hl

Highlight group to highlight the virtual text.

Plugin default: "LightBulbVirtualText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.virtual_text.hl_mode

How to combine other highlights with text highlight. See hl_mode of |nvim_buf_set_extmark|.

Plugin default: "combine"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.virtual_text.pos

Position of virtual text given to |nvim_buf_set_extmark|. Can be a number representing a fixed column (see virt_text_pos). Can be a string representing a position (see virt_text_win_col).

Plugin default: "eol"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-lightbulb.settings.virtual_text.text

Text to show in the virt_text.

Plugin default: "💡"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-osc52.enable

Whether to enable nvim-osc52, a plugin to use OSC52 sequences to copy/paste.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-osc52.package

Which package to use for the nvim-osc52 plugin.

Type: package

Default: <derivation vimplugin-nvim-osc52-2024-05-13>

Declared by:

plugins.nvim-osc52.maxLength

Maximum length of selection (0 for no limit)

Plugin default: 0

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-osc52.silent

Disable message on successful copy

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-osc52.trim

Trim text before copy

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-osc52.keymaps.enable

Whether to enable keymaps for copying using OSC52.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-osc52.keymaps.copy

Copy into the system clipboard using OSC52

Type: string

Default: "<leader>y"

Declared by:

plugins.nvim-osc52.keymaps.copyLine

Copy line into the system clipboard using OSC52

Type: string

Default: "<leader>yy"

Declared by:

plugins.nvim-osc52.keymaps.copyVisual

Copy visual selection into the system clipboard using OSC52

Type: string

Default: "<leader>y"

Declared by:

plugins.nvim-osc52.keymaps.silent

Whether nvim-osc52 keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.enable

Whether to enable nvim-tree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-tree.package

Which package to use for the nvim-tree plugin.

Type: package

Default: <derivation vimplugin-nvim-tree.lua-2024-05-14>

Declared by:

plugins.nvim-tree.autoClose

Automatically close

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.autoReloadOnWrite

Reloads the explorer every time a buffer is written to.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.disableNetrw

Disable netrw

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.nvim-tree.hijackCursor

Keeps the cursor on the first letter of the filename when moving in the tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.hijackNetrw

Hijack netrw

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.hijackUnnamedBufferWhenOpening

Opens in place of the unnamed buffer if it’s empty.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.ignoreBufferOnSetup

Will ignore the buffer, when deciding to open the tree on setup.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.ignoreFtOnSetup

List of filetypes that will prevent open_on_setup to open. You can use this option if you don’t want the tree to open in some scenarios (eg using vim startify).

Type: list of string

Default: [ ]

Declared by:

plugins.nvim-tree.onAttach

Function ran when creating the nvim-tree buffer. This can be used to attach keybindings to the tree buffer. When onAttach is “default”, it will use the older mapping strategy, otherwise it will use the newer one.

Example: { __raw = '' function(bufnr) local api = require(“nvim-tree.api”) vim.keymap.set(“n”, “<C-P>”, function() local node = api.tree.get_node_under_cursor() print(node.absolute_path) end, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = “print the node’s absolute path” }) end ''; }

Plugin default: default

Type: null or value “default” (singular enum) or raw lua code

Default: null

Declared by:

plugins.nvim-tree.openOnSetup

Will automatically open the tree when running setup if startup buffer is a directory, is empty or is unnamed. nvim-tree window will be focused.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.openOnSetupFile

Will automatically open the tree when running setup if startup buffer is a file. File window will be focused. File will be found if updateFocusedFile is enabled.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.preferStartupRoot

Prefer startup root directory when updating root directory of the tree. Only relevant when updateFocusedFile.updateRoot is true

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.reloadOnBufenter

Automatically reloads the tree on BufEnter nvim-tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.respectBufCwd

Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.rootDirs

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.selectPrompts

Use |vim.ui.select| style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.sortBy

Changes how files within the same directory are sorted. Can be one of name, case_sensitive, modification_time, extension or a function. Type: string | function(nodes), Default: "name"

Function is passed a table of nodes to be sorted, each node containing:

  • absolute_path: string
  • executable: boolean
  • extension: string
  • link_to: string
  • name: string
  • type: "directory" | "file" | "link"

Example: sort by name length: sortBy = { __raw = '' local sort_by = function(nodes) table.sort(nodes, function(a, b) return #a.name < #b.name end) end ''; };

Plugin default: name

Type: null or one of “name”, “case_sensitive”, “modification_time”, “extension” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.syncRootWithCwd

Changes the tree root directory on DirChanged and refreshes the tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.useSystemClipboard

A boolean value that toggle the use of system clipboard when copy/paste function are invoked. When enabled, copied text will be stored in registers ‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.changeDir.enable

Change the working directory when changing directories in the tree.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.changeDir.global

Use :cd instead of :lcd when changing directories. Consider that this might cause issues with the |nvim-tree.sync_root_with_cwd| option.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.changeDir.restrictAboveCwd

Restrict changing to a directory above the global current working directory.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.expandAll.exclude

A list of directories that should not be expanded automatically. E.g [ ".git" "target" "build" ] etc.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.actions.expandAll.maxFolderDiscovery

Limit the number of folders being explored when expanding every folders. Avoids hanging neovim when running this action on very large folders.

Plugin default: 300

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.filePopup.openWinConfig

Floating window config for file_popup. See |nvim_open_win| for more details. You shouldn’t define "width" and "height" values here. They will be overridden to fit the file_popup content.

Plugin default:

{
  col = 1;
  row = 1;
  relative = "cursor";
  border = "shadow";
  style = "minimal";
}

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-tree.actions.openFile.quitOnOpen

Closes the explorer when opening a file. It will also disable preventing a buffer overriding the tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.openFile.resizeWindow

Resizes the tree when opening a file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.removeFile.closeWindow

Close any window displaying a file when removing the file from the tree.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.windowPicker.enable

Enable the window picker. If the feature is not enabled, files will open in window from which you last opened the tree.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.windowPicker.chars

A string of chars used as identifiers by the window picker.

Plugin default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.actions.windowPicker.exclude

Table of buffer option names mapped to a list of option values that indicates to the picker that the buffer’s window should not be selectable.

Plugin default:

{
  filetype = [ "notify" "lazy" "packer" "qf" "diff" "fugitive" "fugitiveblame" ];
  buftype = [ "nofile" "terminal" "help" ];
};

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.nvim-tree.actions.windowPicker.picker

Change the default window picker, can be a string "default" or a function. The function should return the window id that will open the node, or nil if an invalid window is picked or user cancelled the action.

This can be both a string or a function (see example below). picker = { __raw = “require(‘window-picker’).pick_window”; };

Plugin default: default

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.enable

Show LSP and COC diagnostics in the signcolumn Note that the modified sign will take precedence over the diagnostics signs.

NOTE: it will use the default diagnostic color groups to highlight the signs. If you wish to customize, you can override these groups:

  • NvimTreeLspDiagnosticsError
  • NvimTreeLspDiagnosticsWarning
  • NvimTreeLspDiagnosticsInformation
  • NvimTreeLspDiagnosticsHint

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.debounceDelay

Idle milliseconds between diagnostic event and update.

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.showOnDirs

Show diagnostic icons on parent directories.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.showOnOpenDirs

Show diagnostics icons on directories that are open. Only relevant when diagnostics.showOnDirs is `true

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.icons.error

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.icons.hint

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.icons.info

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.icons.warning

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.diagnostics.severity.max

Maximum severity for which the diagnostics will be displayed. See |diagnostic-severity|.

Type: null or unsigned integer, meaning >=0, or one of “error”, “warn”, “info”, “hint”

Default: "error"

Declared by:

plugins.nvim-tree.diagnostics.severity.min

Minimum severity for which the diagnostics will be displayed. See |diagnostic-severity|.

Type: null or unsigned integer, meaning >=0, or one of “error”, “warn”, “info”, “hint”

Default: "hint"

Declared by:

plugins.nvim-tree.filesystemWatchers.enable

Will use file system watcher (libuv fs_event) to watch the filesystem for changes. Using this will disable BufEnter / BufWritePost events in nvim-tree which were used to update the whole tree. With this feature, the tree will be updated only for the appropriate folder change, resulting in better performance.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.filesystemWatchers.debounceDelay

Idle milliseconds between filesystem change and action.

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.filesystemWatchers.ignoreDirs

List of vim regex for absolute directory paths that will not be watched. Backslashes must be escaped e.g. "my-project/\\.build$". See |string-match|. Useful when path is not in .gitignore or git integration is disabled.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.filters.custom

Custom list of vim regex for file/directory names that will not be shown. Backslashes must be escaped e.g. “^\.git”. See |string-match|. Toggle via the toggle_custom action, default mapping U.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.filters.dotfiles

Do not show dotfiles: files starting with a . Toggle via the toggle_dotfiles action, default mapping H.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.filters.exclude

List of directories or files to exclude from filtering: always show them. Overrides git.ignore, filters.dotfiles and filters.custom.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.filters.gitClean

Do not show files with no git status. This will show ignored files when |nvim-tree.git.ignore| is set, as they are effectively dirty. Toggle via the toggle_git_clean action, default mapping C.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.filters.noBuffer

Do not show files that have no listed buffer. Toggle via the toggle_no_buffer action, default mapping B. For performance reasons this may not immediately update on buffer delete/wipe. A reload or filesystem event will result in an update.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.git.enable

Git integration with icons and colors.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.git.ignore

Ignore files based on .gitignore. Requires git.enable to be true. Toggle via the toggle_git_ignored action, default mapping I.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.git.showOnDirs

Show status icons of children when directory itself has no status icon.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.git.showOnOpenDirs

Show status icons of children on directories that are open. Only relevant when git.showOnDirs is true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.git.timeout

Kills the git process after some time if it takes too long.

Plugin default: 400

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.hijackDirectories.enable

Hijacks new directory buffers when they are opened (:e dir).

Disable this option if you use vim-dirvish or dirbuf.nvim. If hijackNetrw and disableNetrw are false, this feature will be disabled.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.hijackDirectories.autoOpen

Opens the tree if the tree was previously closed.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.liveFilter.alwaysShowFolders

Whether to filter folders or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.liveFilter.prefix

Prefix of the filter displayed in the buffer.

Plugin default: "[FILTER]: "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.enable

Enable logging to a file $XDG_CACHE_HOME/nvim/nvim-tree.log

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.truncate

Remove existing log file at startup.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.all

Everything.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.config

Options and mappings, at startup.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.copyPaste

File copy and paste actions.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.dev

Used for local development only. Not useful for users.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.diagnostics

LSP and COC processing, verbose.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.git

Git processing, verbose.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.profile

Timing of some operations.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.log.types.watcher

|nvim-tree.filesystem_watchers| processing, verbose.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.modified.enable

Indicate which file have unsaved modification.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.modified.showOnDirs

Show modified indication on directory whose children are modified.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.modified.showOnOpenDirs

Show modified indication on open directories. Only relevant when modified.showOnDirs is true.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.notify.threshold

Specify minimum notification level, uses the values from |vim.log.levels|

  • error: hard errors e.g. failure to read from the file system.
  • warning: non-fatal errors e.g. unable to system open a file.
  • info: information only e.g. file copy path confirmation.
  • debug: not used.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

plugins.nvim-tree.renderer.addTrailing

Appends a trailing slash to folder names.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.fullName

Display node whose name length is wider than the width of nvim-tree window in floating window.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.groupEmpty

Compact folders that only contain a single folder into one node in the file tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.highlightGit

Enable file highlight for git attributes using NvimTreeGit* highlight groups. Requires nvim-tree.git.enable This can be used with or without the icons.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.highlightModified

Highlight icons and/or names for modified files using the NvimTreeModified highlight group. Requires nvim-tree.modified.enable This can be used with or without the icons.

Plugin default: "none"

Type: null or one of “none”, “icon”, “name”, “all” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.highlightOpenedFiles

Highlight icons and/or names for opened files using the NvimTreeOpenedFile highlight group.

Plugin default: "none"

Type: null or one of “none”, “icon”, “name”, “all” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentWidth

Number of spaces for an each tree nesting level. Minimum 1.

Plugin default: 2

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.rootFolderLabel

In what format to show root folder. See :help filename-modifiers for available string options.

Set to false to hide the root folder.

This can also be a function(root_cwd) which is passed the absolute path of the root folder and should return a string. e.g.

rootFolderLabel = { __raw = '' my_root_folder_label = function(path) return “…/” … vim.fn.fnamemodify(path, “:t”) end ''; };

Plugin default: :~:s?$?/..?

Type: null or string or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.specialFiles

A list of filenames that gets highlighted with NvimTreeSpecialFile.

Plugin default: [ "Cargo.toml" "Makefile" "README.md" "readme.md" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.renderer.symlinkDestination

Whether to show the destination of the symlink.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.gitPlacement

Place where the git icons will be rendered. Can be "after" or "before" filename (after the file/folders icons) or "signcolumn" (requires |nvim-tree.view.signcolumn| enabled). Note that the diagnostic signs and the modified sign will take precedence over the git signs.

Plugin default: "before"

Type: null or one of “after”, “before”, “signcolumn” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.modifiedPlacement

Place where the modified icon will be rendered. Can be "after" or "before" filename (after the file/folders icons) or "signcolumn" (requires |nvim-tree.view.signcolumn| enabled).

Plugin default: "after"

Type: null or one of “after”, “before”, “signcolumn” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.padding

Inserted between icon and filename.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.symlinkArrow

Used as a separator between symlinks’ source and target.

Plugin default: " ➛ "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.webdevColors

Use the webdev icon colors, otherwise NvimTreeFileIcon.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.default

Glyph for files. Will be overridden by nvim-web-devicons if available.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.modified

Icon to display for modified files.

Plugin default: "●"

Type: null or string or raw lua code

Default: null

Declared by:

Glyph for symlinks to files.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.arrowClosed

Arrow glyphs for closed directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.arrowOpen

Arrow glyphs for open directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.default

Default glyph for directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.empty

Glyph for empty directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.emptyOpen

Glyph for open empty directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.open

Glyph for open directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

Glyph for symlink directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.folder.symlinkOpen

Glyph for open symlink directories.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.deleted

Glyph for deleted nodes.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.ignored

Glyph for deleted nodes.

Plugin default: "◌"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.renamed

Glyph for renamed nodes.

Plugin default: "➜"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.staged

Glyph for staged nodes.

Plugin default: "✓"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.unmerged

Glyph for unmerged nodes.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.unstaged

Glyph for unstaged nodes.

Plugin default: "✗"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.glyphs.git.untracked

Glyph for untracked nodes.

Plugin default: "★"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.show.file

Show an icon before the file name. nvim-web-devicons will be used if available.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.show.folder

Show an icon before the folder name.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.show.folderArrow

Show a small arrow before the folder node. Arrow will be a part of the node when using |renderer.indent_markers|.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.show.git

Show a git status icon, see |renderer.icons.git_placement| Requires git.enable = true

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.icons.show.modified

Show a modified icon, see |renderer.icons.modified_placement| Requires |modified.enable| = true

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.enable

Display indent markers when folders are open

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.inlineArrows

Display folder arrows in the same column as indent marker when using |renderer.icons.show.folder_arrow|.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.icons.bottom

Plugin default: "─"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.icons.corner

Plugin default: "└"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.icons.edge

Plugin default: "│"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.icons.item

Plugin default: "│"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.renderer.indentMarkers.icons.none

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.systemOpen.args

Optional argument list.

Leave empty for OS specific default: Windows: { "/c", "start", '""' }

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.systemOpen.cmd

The open command itself.

Leave empty for OS specific default: UNIX: "xdg-open" macOS: "open" Windows: "cmd"

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.tab.sync.close

Closes the tree across all tabpages when the tree is closed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.tab.sync.ignore

List of filetypes or buffer names on new tab that will prevent |nvim-tree.tab.sync.open| and |nvim-tree.tab.sync.close|

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.tab.sync.open

Opens the tree automatically when switching tabpage or opening a new tabpage if the tree was previously open.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.trash.cmd

The command used to trash items (must be installed on your system). The default is shipped with glib2 which is a common linux package. Only available for UNIX.

Plugin default: "gio trash"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.nvim-tree.ui.confirm.remove

Prompt before removing.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.ui.confirm.trash

Prompt before trashing.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.updateFocusedFile.enable

Update the focused file on BufEnter, un-collapses the folders recursively until it finds the file.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.updateFocusedFile.ignoreList

List of buffer names and filetypes that will not update the root dir of the tree if the file isn’t found under the current root directory. Only relevant when updateFocusedFile.updateRoot and updateFocusedFile.enable are true.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.nvim-tree.updateFocusedFile.updateRoot

Update the root directory of the tree if the file is not under current root directory. It prefers vim’s cwd and root_dirs. Otherwise it falls back to the folder containing the file. Only relevant when updateFocusedFile.enable is true

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.centralizeSelection

When entering nvim-tree, reposition the view so that the current node is initially centralized, see |zz|.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.cursorline

Enable |cursorline| in the tree window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.debounceDelay

Idle milliseconds before some reload / refresh operations. Increase if you experience performance issues around screen refresh.

Plugin default: 15

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.number

Print the line number in front of each line.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.preserveWindowProportions

Preserves window proportions when opening a file. If false, the height and width of windows other than nvim-tree will be equalized.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.relativenumber

Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line will be the line number instead of 0.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.side

Side of the tree, can be "left", "right".

Plugin default: "left"

Type: null or one of “left”, “right” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.signcolumn

Show diagnostic sign column. Value can be "yes", "auto", "no".

Plugin default: "yes"

Type: null or one of “yes”, “auto”, “no” or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.width

Width of the window: can be a % string, a number representing columns or a table. A table indicates that the view should be dynamically sized based on the longest line.

Plugin default: 30

Type: null or string or signed integer or (submodule)

Default: null

Declared by:

plugins.nvim-tree.view.float.enable

Tree window will be floating.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-tree.view.float.openWinConfig

Floating window config for file_popup. See |nvim_open_win| for more details. You shouldn’t define "width" and "height" values here. They will be overridden to fit the file_popup content.

Plugin default:

{
  col = 1;
  row = 1;
  relative = "cursor";
  border = "shadow";
  style = "minimal";
}

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-tree.view.float.quitOnFocusLoss

Close the floating tree window when it loses focus.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.enable

Whether to enable nvim-ufo.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-ufo.enableGetFoldVirtText

Enable a function with lnum as a parameter to capture the virtual text for the folded lines and export the function to get_fold_virt_text field of ctx table as 6th parameter in fold_virt_text_handler

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.package

Which package to use for the nvim-ufo plugin.

Type: package

Default: <derivation vimplugin-nvim-ufo-2024-04-03>

Declared by:

plugins.nvim-ufo.closeFoldKinds

After the buffer is displayed (opened for the first time), close the folds whose range with kind field is included in this option. For now, ‘lsp’ provider’s standardized kinds are ‘comment’, ‘imports’ and ‘region’, run UfoInspect for details if your provider has extended the kinds.

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-ufo.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.nvim-ufo.foldVirtTextHandler

A lua function to customize fold virtual text

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.nvim-ufo.openFoldHlTimeout

Time in millisecond between the range to be highlgihted and to be cleared while opening the folded line, 0 value will disable the highlight

Plugin default: 400

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.providerSelector

A lua function as a selector for fold providers.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.nvim-ufo.preview.mappings

Mappings for preview window

Type: null or (attribute set)

Default: null

Declared by:

plugins.nvim-ufo.preview.winConfig.border

Defines the border to use for preview window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.preview.winConfig.maxheight

The max height of preview window

Plugin default: 20

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.preview.winConfig.winblend

The winblend for preview window, :h winblend

Plugin default: 12

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.nvim-ufo.preview.winConfig.winhighlight

The winhighlight for preview window, :h winhighlight

Plugin default: "Normal:Normal"

Type: null or string or raw lua code

Default: null

Declared by:

obsidian

Url: https://github.com/epwalsh/obsidian.nvim/

Maintainers: Gaetan Lepage

plugins.obsidian.enable

Whether to enable obsidian.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.obsidian.package

Which package to use for the obsidian.nvim plugin.

Type: package

Default: <derivation vimplugin-obsidian.nvim-2024-05-08>

Declared by:

plugins.obsidian.settings

Options provided to the require('obsidian').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  completion = {
    min_chars = 2;
    nvim_cmp = true;
  };
  new_notes_location = "current_dir";
  workspaces = [
    {
      name = "work";
      path = "~/obsidian/work";
    }
    {
      name = "startup";
      path = "~/obsidian/startup";
    }
  ];
}

Declared by:

plugins.obsidian.settings.dir

Alternatively to workspaces - and for backwards compatibility - you can set dir to a single path instead of workspaces.

For example:

  dir = "~/vaults/work";

Type: null or string

Default: null

Declared by:

plugins.obsidian.settings.disable_frontmatter

Boolean or a function that takes a filename and returns a boolean. true indicates that you don’t want obsidian.nvim to manage frontmatter.

Default: false

Type: null or lua function string or boolean

Default: null

Declared by:

plugins.obsidian.settings.follow_url_func

By default when you use :ObsidianFollowLink on a link to an external URL it will be ignored but you can customize this behavior here.

Example:

  function(url)
    -- Open the URL in the default web browser.
    vim.fn.jobstart({"open", url})  -- Mac OS
    -- vim.fn.jobstart({"xdg-open", url})  -- linux
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.image_name_func

Customize the default name or prefix when pasting images via :ObsidianPasteImg.

Example:

  function()
    -- Prefix image names with timestamp.
    return string.format("%s-", os.time())
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.log_level

Set the log level for obsidian.nvim.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

Customize how markdown links are formatted.

  ---@param opts {path: string, label: string, id: string|?}
  ---@return string links are formatted.

Example:

  function(opts)
    return string.format("[%s](%s)", opts.label, opts.path)
  end

Default: See source

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.new_notes_location

Where to put new notes created from completion.

Valid options are

  • “current_dir” - put new notes in same directory as the current buffer.
  • “notes_subdir” - put new notes in the default notes subdirectory.

Plugin default: "current_dir"

Type: null or one of “current_dir”, “notes_subdir” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.note_frontmatter_func

You can customize the frontmatter data.

Example:

  function(note)
    -- Add the title of the note as an alias.
    if note.title then
      note:add_alias(note.title)
    end

    local out = { id = note.id, aliases = note.aliases, tags = note.tags }

    -- `note.metadata` contains any manually added fields in the frontmatter.
    -- So here we just make sure those fields are kept in the frontmatter.
    if note.metadata ~= nil and not vim.tbl_isempty(note.metadata) then
      for k, v in pairs(note.metadata) do
        out[k] = v
      end
    end

    return out
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.note_id_func

Customize how names/IDs for new notes are created.

Example:

  function(title)
    -- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
    -- In this case a note with the title 'My new note' will be given an ID that looks
    -- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
    local suffix = ""
    if title ~= nil then
      -- If title is given, transform it into valid file name.
      suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
    else
      -- If title is nil, just add 4 random uppercase letters to the suffix.
      for _ = 1, 4 do
        suffix = suffix .. string.char(math.random(65, 90))
      end
    end
    return tostring(os.time()) .. "-" .. suffix
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.note_path_func

Customize how note file names are generated given the ID, target directory, and title.

  ---@param spec { id: string, dir: obsidian.Path, title: string|? }
  ---@return string|obsidian.Path The full path to the new note.

Example:

  function(spec)
    -- This is equivalent to the default behavior.
    local path = spec.dir / tostring(spec.id)
    return path:with_suffix(".md")
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.notes_subdir

If you keep notes in a specific subdirectory of your vault.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.open_app_foreground

Set to true to force :ObsidianOpen to bring the app to the foreground.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.open_notes_in

Determines how certain commands open notes.

The valid options are:

  • “current” (the default) - to always open in the current window
  • “vsplit” - to open in a vertical split if there’s not already a vertical split
  • “hsplit” - to open in a horizontal split if there’s not already a horizontal split

Plugin default: "current"

Type: null or one of “current”, “vsplit”, “hsplit” or raw lua code

Default: null

Declared by:

Either ‘wiki’ or ‘markdown’.

Plugin default: "wiki"

Type: null or one of “wiki”, “markdown” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.sort_by

Sort search results by “path”, “modified”, “accessed”, or “created”. The recommend value is “modified” and true for sortReversed, which means, for example, that :ObsidianQuickSwitch will show the notes sorted by latest modified time.

Plugin default: "modified"

Type: null or one of “path”, “modified”, “accessed”, “created” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.sort_reversed

Whether search results should be reversed.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.use_advanced_uri

Set to true to force ‘:ObsidianOpen’ to bring the app to the foreground.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

Customize how wiki links are formatted.

  ---@param opts {path: string, label: string, id: string|?}
  ---@return string

Example:

  function(opts)
    if opts.id == nil then
      return string.format("[[%s]]", opts.label)
    elseif opts.label ~= opts.id then
      return string.format("[[%s|%s]]", opts.id, opts.label)
    else
      return string.format("[[%s]]", opts.id)
    end
  end

Default: See source

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.yaml_parser

Set the YAML parser to use.

The valid options are:

  • “native” - uses a pure Lua parser that’s fast but potentially misses some edge cases.
  • “yq” - uses the command-line tool yq (https://github.com/mikefarah/yq), which is more robust but much slower and needs to be installed separately.

In general you should be using the native parser unless you run into a bug with it, in which case you can temporarily switch to the “yq” parser until the bug is fixed.

Plugin default: "native"

Type: null or one of “native”, “yq” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.attachments.confirm_img_paste

Whether to prompt for confirmation when pasting an image.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.attachments.img_folder

The default folder to place images in via :ObsidianPasteImg.

If this is a relative path it will be interpreted as relative to the vault root. You can always override this per image by passing a full path to the command instead of just a filename.

Plugin default: "assets/imgs"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.attachments.img_text_func

A function that determines the text to insert in the note when pasting an image. It takes two arguments, the obsidian.Client and a plenary Path to the image file.

  @param client obsidian.Client
  @param path Path the absolute path to the image file
  @return string

Plugin default:

function(client, path)
  ---@type string
  local link_path
  local vault_relative_path = client:vault_relative_path(path)
  if vault_relative_path ~= nil then
    -- Use relative path if the image is saved in the vault dir.
    link_path = vault_relative_path
  else
    -- Otherwise use the absolute path.
    link_path = tostring(path)
  end
  local display_name = vim.fs.basename(link_path)
  return string.format("![%s](%s)", display_name, link_path)
end

Type: null or lua function string

Default: null

Declared by:

plugins.obsidian.settings.callbacks.enter_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs when entering a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.callbacks.leave_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs when leaving a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.callbacks.post_set_workspace

fun(client: obsidian.Client, workspace: obsidian.Workspace)

Runs anytime the workspace is set/changed.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.callbacks.post_setup

fun(client: obsidian.Client)

Runs right after the obsidian.Client is initialized.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.callbacks.pre_write_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs right before writing a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.completion.min_chars

Trigger completion at this many chars.

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.completion.nvim_cmp

Set to false to disable completion.

Default: true if nvim-cmp is enabled (plugins.cmp.enable).

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.daily_notes.alias_format

Optional, if you want to change the date format of the default alias of daily notes.

Example: “%B %-d, %Y”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.daily_notes.date_format

Optional, if you want to change the date format for the ID of daily notes.

Example: “%Y-%m-%d”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.daily_notes.folder

Optional, if you keep daily notes in a separate directory.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.daily_notes.template

Optional, if you want to automatically insert a template from your template directory like ‘daily.md’.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings

Configure key mappings.

Plugin default:

{
  gf = {
    action = "require('obsidian').util.gf_passthrough";
    opts = {
      noremap = false;
      expr = true;
      buffer = true;
    };
  };

  "<leader>ch" = {
    action = "require('obsidian').util.toggle_checkbox";
    opts.buffer = true;
  };
}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.action

The lua code for this keymap action.

Type: lua code string

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.buffer

If true, the mapping will be effective in the current buffer only.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.mappings.<name>.opts.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.picker.name

Set your preferred picker.

Type: null or one of “telescope.nvim”, “fzf-lua”, “mini.pick”

Default: null

Declared by:

plugins.obsidian.settings.picker.note_mappings

Optional, configure note mappings for the picker. These are the defaults. Not all pickers support all mappings.

Plugin default:

{
  new = "<C-x>";
  insert_link = "<C-l>";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.picker.tag_mappings

Optional, configure tag mappings for the picker. These are the defaults. Not all pickers support all mappings.

Plugin default:

{
  tag_note = "<C-x>";
  insert_tag = "<C-l>";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.templates.date_format

Which date format to use.

Example: “%Y-%m-%d”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.templates.subdir

The name of the directory where templates are stored.

Example: “templates”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.templates.substitutions

A map for custom variables, the key should be the variable and the value a function.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.templates.time_format

Which time format to use.

Example: “%H:%M”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.enable

Set to false to disable all additional syntax features.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.update_debounce

Update delay after a text change (in milliseconds).

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.bullets.char

Which character to use for the bullets.

Plugin default: "•"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.bullets.hl_group

The name of the highlight group to use for the bullets.

Plugin default: "ObsidianBullet"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.checkboxes

Define how various check-boxes are displayed. You can also add more custom ones…

NOTE: the ‘char’ value has to be a single character, and the highlight groups are defined in the ui.hl_groups option.

Plugin default:

{
  " " = {
    char = "󰄱";
    hl_group = "ObsidianTodo";
  };
  "x" = {
    char = "";
    hl_group = "ObsidianDone";
  };
  ">" = {
    char = "";
    hl_group = "ObsidianRightArrow";
  };
  "~" = {
    char = "󰰱";
    hl_group = "ObsidianTilde";
  };
}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.obsidian.settings.ui.checkboxes.<name>.char

The character to use for this checkbox.

Type: string or raw lua code

Declared by:

plugins.obsidian.settings.ui.checkboxes.<name>.hl_group

The name of the highlight group to use for this checkbox.

Type: string or raw lua code

Declared by:

Which character to use for the external link icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

The name of the highlight group to use for the external link icon.

Plugin default: "ObsidianExtLinkIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.highlight_text.hl_group

The name of the highlight group to use for highlight text.

Plugin default: "ObsidianHighlightText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups

Highlight group definitions.

Plugin default:

{
  ObsidianTodo = {
    bold = true;
    fg = "#f78c6c";
  };
  ObsidianDone = {
    bold = true;
    fg = "#89ddff";
  };
  ObsidianRightArrow = {
    bold = true;
    fg = "#f78c6c";
  };
  ObsidianTilde = {
    bold = true;
    fg = "#ff5370";
  };
  ObsidianRefText = {
    underline = true;
    fg = "#c792ea";
  };
  ObsidianExtLinkIcon = {
    fg = "#c792ea";
  };
  ObsidianTag = {
    italic = true;
    fg = "#89ddff";
  };
  ObsidianHighlightText = {
    bg = "#75662e";
  };
}

Type: null or (attribute set of (attribute set))

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.bold

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.reverse

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.standout

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.hl_groups.<name>.underline

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.ui.reference_text.hl_group

The name of the highlight group to use for reference text.

Plugin default: "ObsidianRefText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.ui.tags.hl_group

The name of the highlight group to use for tags.

Plugin default: "ObsidianTag"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces

A list of vault names and paths. Each path should be the path to the vault root. If you use the Obsidian app, the vault root is the parent directory of the .obsidian folder. You can also provide configuration overrides for each workspace through the overrides field.

Plugin default: []

Type: null or (list of (submodule))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.name

The name for this workspace

Type: string or raw lua code

Declared by:

plugins.obsidian.settings.workspaces.*.path

The of the workspace.

Type: string or raw lua code

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.disable_frontmatter

Boolean or a function that takes a filename and returns a boolean. true indicates that you don’t want obsidian.nvim to manage frontmatter.

Default: false

Type: null or lua function string or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.follow_url_func

By default when you use :ObsidianFollowLink on a link to an external URL it will be ignored but you can customize this behavior here.

Example:

  function(url)
    -- Open the URL in the default web browser.
    vim.fn.jobstart({"open", url})  -- Mac OS
    -- vim.fn.jobstart({"xdg-open", url})  -- linux
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.image_name_func

Customize the default name or prefix when pasting images via :ObsidianPasteImg.

Example:

  function()
    -- Prefix image names with timestamp.
    return string.format("%s-", os.time())
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.log_level

Set the log level for obsidian.nvim.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "info"

Declared by:

Customize how markdown links are formatted.

  ---@param opts {path: string, label: string, id: string|?}
  ---@return string links are formatted.

Example:

  function(opts)
    return string.format("[%s](%s)", opts.label, opts.path)
  end

Default: See source

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.new_notes_location

Where to put new notes created from completion.

Valid options are

  • “current_dir” - put new notes in same directory as the current buffer.
  • “notes_subdir” - put new notes in the default notes subdirectory.

Plugin default: "current_dir"

Type: null or one of “current_dir”, “notes_subdir” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.note_frontmatter_func

You can customize the frontmatter data.

Example:

  function(note)
    -- Add the title of the note as an alias.
    if note.title then
      note:add_alias(note.title)
    end

    local out = { id = note.id, aliases = note.aliases, tags = note.tags }

    -- `note.metadata` contains any manually added fields in the frontmatter.
    -- So here we just make sure those fields are kept in the frontmatter.
    if note.metadata ~= nil and not vim.tbl_isempty(note.metadata) then
      for k, v in pairs(note.metadata) do
        out[k] = v
      end
    end

    return out
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.note_id_func

Customize how names/IDs for new notes are created.

Example:

  function(title)
    -- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
    -- In this case a note with the title 'My new note' will be given an ID that looks
    -- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
    local suffix = ""
    if title ~= nil then
      -- If title is given, transform it into valid file name.
      suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
    else
      -- If title is nil, just add 4 random uppercase letters to the suffix.
      for _ = 1, 4 do
        suffix = suffix .. string.char(math.random(65, 90))
      end
    end
    return tostring(os.time()) .. "-" .. suffix
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.note_path_func

Customize how note file names are generated given the ID, target directory, and title.

  ---@param spec { id: string, dir: obsidian.Path, title: string|? }
  ---@return string|obsidian.Path The full path to the new note.

Example:

  function(spec)
    -- This is equivalent to the default behavior.
    local path = spec.dir / tostring(spec.id)
    return path:with_suffix(".md")
  end

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.notes_subdir

If you keep notes in a specific subdirectory of your vault.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.open_app_foreground

Set to true to force :ObsidianOpen to bring the app to the foreground.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.open_notes_in

Determines how certain commands open notes.

The valid options are:

  • “current” (the default) - to always open in the current window
  • “vsplit” - to open in a vertical split if there’s not already a vertical split
  • “hsplit” - to open in a horizontal split if there’s not already a horizontal split

Plugin default: "current"

Type: null or one of “current”, “vsplit”, “hsplit” or raw lua code

Default: null

Declared by:

Either ‘wiki’ or ‘markdown’.

Plugin default: "wiki"

Type: null or one of “wiki”, “markdown” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.sort_by

Sort search results by “path”, “modified”, “accessed”, or “created”. The recommend value is “modified” and true for sortReversed, which means, for example, that :ObsidianQuickSwitch will show the notes sorted by latest modified time.

Plugin default: "modified"

Type: null or one of “path”, “modified”, “accessed”, “created” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.sort_reversed

Whether search results should be reversed.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.use_advanced_uri

Set to true to force ‘:ObsidianOpen’ to bring the app to the foreground.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

Customize how wiki links are formatted.

  ---@param opts {path: string, label: string, id: string|?}
  ---@return string

Example:

  function(opts)
    if opts.id == nil then
      return string.format("[[%s]]", opts.label)
    elseif opts.label ~= opts.id then
      return string.format("[[%s|%s]]", opts.id, opts.label)
    else
      return string.format("[[%s]]", opts.id)
    end
  end

Default: See source

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.yaml_parser

Set the YAML parser to use.

The valid options are:

  • “native” - uses a pure Lua parser that’s fast but potentially misses some edge cases.
  • “yq” - uses the command-line tool yq (https://github.com/mikefarah/yq), which is more robust but much slower and needs to be installed separately.

In general you should be using the native parser unless you run into a bug with it, in which case you can temporarily switch to the “yq” parser until the bug is fixed.

Plugin default: "native"

Type: null or one of “native”, “yq” or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.attachments.confirm_img_paste

Whether to prompt for confirmation when pasting an image.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.attachments.img_folder

The default folder to place images in via :ObsidianPasteImg.

If this is a relative path it will be interpreted as relative to the vault root. You can always override this per image by passing a full path to the command instead of just a filename.

Plugin default: "assets/imgs"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.attachments.img_text_func

A function that determines the text to insert in the note when pasting an image. It takes two arguments, the obsidian.Client and a plenary Path to the image file.

  @param client obsidian.Client
  @param path Path the absolute path to the image file
  @return string

Plugin default:

function(client, path)
  ---@type string
  local link_path
  local vault_relative_path = client:vault_relative_path(path)
  if vault_relative_path ~= nil then
    -- Use relative path if the image is saved in the vault dir.
    link_path = vault_relative_path
  else
    -- Otherwise use the absolute path.
    link_path = tostring(path)
  end
  local display_name = vim.fs.basename(link_path)
  return string.format("![%s](%s)", display_name, link_path)
end

Type: null or lua function string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.callbacks.enter_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs when entering a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.callbacks.leave_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs when leaving a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.callbacks.post_set_workspace

fun(client: obsidian.Client, workspace: obsidian.Workspace)

Runs anytime the workspace is set/changed.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.callbacks.post_setup

fun(client: obsidian.Client)

Runs right after the obsidian.Client is initialized.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.callbacks.pre_write_note

fun(client: obsidian.Client, note: obsidian.Note)

Runs right before writing a note buffer.

Type: null or lua code string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.completion.min_chars

Trigger completion at this many chars.

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.completion.nvim_cmp

Set to false to disable completion.

Default: true if nvim-cmp is enabled (plugins.cmp.enable).

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.daily_notes.alias_format

Optional, if you want to change the date format of the default alias of daily notes.

Example: “%B %-d, %Y”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.daily_notes.date_format

Optional, if you want to change the date format for the ID of daily notes.

Example: “%Y-%m-%d”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.daily_notes.folder

Optional, if you keep daily notes in a separate directory.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.daily_notes.template

Optional, if you want to automatically insert a template from your template directory like ‘daily.md’.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.mappings

Configure key mappings.

Plugin default:

{
  gf = {
    action = "require('obsidian').util.gf_passthrough";
    opts = {
      noremap = false;
      expr = true;
      buffer = true;
    };
  };

  "<leader>ch" = {
    action = "require('obsidian').util.toggle_checkbox";
    opts.buffer = true;
  };
}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.action

The lua code for this keymap action.

Type: lua code string

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.buffer

If true, the mapping will be effective in the current buffer only.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.mappings.<name>.opts.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.picker.name

Set your preferred picker.

Type: null or one of “telescope.nvim”, “fzf-lua”, “mini.pick”

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.picker.note_mappings

Optional, configure note mappings for the picker. These are the defaults. Not all pickers support all mappings.

Plugin default:

{
  new = "<C-x>";
  insert_link = "<C-l>";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.picker.tag_mappings

Optional, configure tag mappings for the picker. These are the defaults. Not all pickers support all mappings.

Plugin default:

{
  tag_note = "<C-x>";
  insert_tag = "<C-l>";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.templates.date_format

Which date format to use.

Example: “%Y-%m-%d”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.templates.subdir

The name of the directory where templates are stored.

Example: “templates”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.templates.substitutions

A map for custom variables, the key should be the variable and the value a function.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code or raw lua code))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.templates.time_format

Which time format to use.

Example: “%H:%M”

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.enable

Set to false to disable all additional syntax features.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.update_debounce

Update delay after a text change (in milliseconds).

Plugin default: 200

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.bullets.char

Which character to use for the bullets.

Plugin default: "•"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.bullets.hl_group

The name of the highlight group to use for the bullets.

Plugin default: "ObsidianBullet"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.checkboxes

Define how various check-boxes are displayed. You can also add more custom ones…

NOTE: the ‘char’ value has to be a single character, and the highlight groups are defined in the ui.hl_groups option.

Plugin default:

{
  " " = {
    char = "󰄱";
    hl_group = "ObsidianTodo";
  };
  "x" = {
    char = "";
    hl_group = "ObsidianDone";
  };
  ">" = {
    char = "";
    hl_group = "ObsidianRightArrow";
  };
  "~" = {
    char = "󰰱";
    hl_group = "ObsidianTilde";
  };
}

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.checkboxes.<name>.char

The character to use for this checkbox.

Type: string or raw lua code

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.checkboxes.<name>.hl_group

The name of the highlight group to use for this checkbox.

Type: string or raw lua code

Declared by:

Which character to use for the external link icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

The name of the highlight group to use for the external link icon.

Plugin default: "ObsidianExtLinkIcon"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.highlight_text.hl_group

The name of the highlight group to use for highlight text.

Plugin default: "ObsidianHighlightText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.hl_groups

Highlight group definitions.

Plugin default:

{
  ObsidianTodo = {
    bold = true;
    fg = "#f78c6c";
  };
  ObsidianDone = {
    bold = true;
    fg = "#89ddff";
  };
  ObsidianRightArrow = {
    bold = true;
    fg = "#f78c6c";
  };
  ObsidianTilde = {
    bold = true;
    fg = "#ff5370";
  };
  ObsidianRefText = {
    underline = true;
    fg = "#c792ea";
  };
  ObsidianExtLinkIcon = {
    fg = "#c792ea";
  };
  ObsidianTag = {
    italic = true;
    fg = "#89ddff";
  };
  ObsidianHighlightText = {
    bg = "#75662e";
  };
}

Type: null or (attribute set of (attribute set))

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.bg

Color for the background (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.blend

Integer between 0 and 100.

Type: null or integer or floating point number between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.bold

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.cterm

cterm attribute map, like |highlight-args|. If not set, cterm attributes will match those from the attribute map documented above.

Type: null or string or (attribute set)

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.ctermbg

Sets background of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.ctermfg

Sets foreground of cterm color.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.default

Don’t override existing definition.

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.fg

Color for the foreground (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.italic

Type: null or boolean

Default: null

Declared by:

Name of another highlight group to link to.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.nocombine

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.reverse

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.sp

Special color (color name or ‘#RRGGBB’).

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.standout

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.strikethrough

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.undercurl

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.underdashed

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.underdotted

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.underdouble

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.overrides.ui.hl_groups.<name>.underline

Type: null or boolean

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.reference_text.hl_group

The name of the highlight group to use for reference text.

Plugin default: "ObsidianRefText"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.obsidian.settings.workspaces.*.overrides.ui.tags.hl_group

The name of the highlight group to use for tags.

Plugin default: "ObsidianTag"

Type: null or string or raw lua code

Default: null

Declared by:

octo

Url: https://github.com/pwntester/octo.nvim/

Maintainers: svl

plugins.octo.enable

Whether to enable octo.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.octo.package

Which package to use for the octo.nvim plugin.

Type: package

Default: <derivation vimplugin-octo.nvim-2024-04-17>

Declared by:

plugins.octo.settings

Options provided to the require('octo').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  mappings = {
    file_panel = {
      select_prev_entry = "[q";
    };
    issue = {
      react_heart = "<leader>rh";
    };
  };
  mappings_disable_default = true;
  ssh_aliases = {
    "github.com-work" = "github.com";
  };
}

Declared by:

plugins.octo.settings.enable_builtin

Shows a list of builtin actions when no action is provided.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.octo.settings.default_remote

Order to try remotes

Plugin default:

[
  "upstream"
  "origin"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.octo.settings.gh_env

Extra environment variables to pass on to GitHub CLI, can be a table or function returning a table.

Plugin default: { }

Type: null or (attribute set)

Default: null

Declared by:

plugins.octo.settings.github_hostname

Github Enterprise host.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.left_bubble_delimiter

Bubble delimiter.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker

Picker to use.

Plugin default: "telescope"

Type: null or one of “telescope”, “fzf-lua” or raw lua code

Default: null

Declared by:

plugins.octo.settings.reaction_viewer_hint_icon

Marker for user reactions.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.right_bubble_delimiter

Bubble delimiter.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.snippet_context_lines

Number of lines around commented lines.

Plugin default: 4

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.octo.settings.ssh_aliases

SSH aliases.

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.octo.settings.timeline_indent

Timeline indentation.

Plugin default: "2"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.timeline_marker

Timeline marker.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.timeout

Timeout for requests between the remote server.

Plugin default: 5000

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.octo.settings.use_local_fs

Use local files on right side of reviews.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.octo.settings.user_icon

User Icon.

Plugin default: " "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.issues.order_by.direction

See GitHub’s OrderDirection documentation.

Plugin default: "DESC"

Type: null or one of “DESC”, “ASC” or raw lua code

Default: null

Declared by:

plugins.octo.settings.issues.order_by.field

See GitHub’s IssueOrderField documentation.

Plugin default: "CREATED_AT"

Type: null or one of “CREATED_AT”, “COMMENTS”, “UPDATED_AT” or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.use_emojis

Use emojis in picker. Only used by “fzf-lua” picker for now.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.checkout_pr.desc

Description of the mapping.

Plugin default:

''
  Checkout pull request.
''

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.checkout_pr.lhs

Key to map.

Plugin default: "<C-o>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.copy_url.desc

Description of the mapping.

Plugin default:

''
  Copy url to system clipboard.
''

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.copy_url.lhs

Key to map.

Plugin default: "<C-y>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.merge_pr.desc

Description of the mapping.

Plugin default:

''
  Merge pull request.
''

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.merge_pr.lhs

Key to map.

Plugin default: "<C-r>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.open_in_browser.desc

Description of the mapping.

Plugin default:

''
  Open issue in browser.
''

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.picker_config.mappings.open_in_browser.lhs

Key to map.

Plugin default: "<C-b>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.octo.settings.ui.use_sign_column

Show “modified” marks on the sign column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

oil

Url: https://github.com/stevearc/oil.nvim/

Maintainers: Gaetan Lepage

plugins.oil.enable

Whether to enable oil.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.oil.package

Which package to use for the oil.nvim plugin.

Type: package

Default: <derivation vimplugin-oil.nvim-2024-05-16>

Declared by:

plugins.oil.settings

Options provided to the require('oil').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  columns = [
    "icon"
  ];
  keymaps = {
    "<C-c>" = false;
    "<C-l>" = false;
    "<C-r>" = "actions.refresh";
    "<leader>qq" = "actions.close";
    "y." = "actions.copy_entry_path";
  };
  skip_confirm_for_simple_edits = true;
  view_options = {
    show_hidden = false;
  };
  win_options = {
    concealcursor = "ncv";
    conceallevel = 3;
    cursorcolumn = false;
    foldcolumn = "0";
    list = false;
    signcolumn = "no";
    spell = false;
    wrap = false;
  };
}

Declared by:

plugins.oil.settings.cleanup_delay_ms

Oil will automatically delete hidden buffers after this delay. You can set the delay to false to disable cleanup entirely. Note that the cleanup process only starts when none of the oil buffers are currently displayed.

Plugin default: 2000

Type: null or unsigned integer, meaning >=0, or value false (singular enum)

Default: null

Declared by:

plugins.oil.settings.columns

Columns can be specified as a string to use default arguments (e.g. "icon"), or as a table to pass parameters (e.g. {"size", highlight = "Special"})

Default: ["icon"]

Type: list of (string or attribute set of anything or raw lua code)

Default: [ ]

Example:

[
  "type"
  {
    __unkeyed = "icon";
    default_file = "bar";
    directory = "dir";
    highlight = "Foo";
  }
  "size"
  "permissions"
]

Declared by:

plugins.oil.settings.constrain_cursor

Constrain the cursor to the editable parts of the oil buffer. Set to false to disable, or “name” to keep it on the file names.

Plugin default: editable

Type: null or string or value false (singular enum)

Default: null

Declared by:

plugins.oil.settings.default_file_explorer

Oil will take over directory buffers (e.g. vim . or :e src/). Set to false if you still want to use netrw.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.delete_to_trash

Deleted files will be removed with the trash_command (below).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.experimental_watch_for_changes

Set to true to watch the filesystem for changes and reload oil.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.keymaps

Keymaps in oil buffer. Can be any value that vim.keymap.set accepts OR a table of keymap options with a callback (e.g. { callback = function() ... end, desc = "", mode = "n" }). Additionally, if it is a string that matches “actions.<name>”, it will use the mapping at require("oil.actions").<name>. Set to false to remove a keymap. See :help oil-actions for a list of all available actions.

Plugin default:

{
  "g?" = "actions.show_help";
  "<CR>" = "actions.select";
  "<C-s>" = "actions.select_vsplit";
  "<C-h>" = "actions.select_split";
  "<C-t>" = "actions.select_tab";
  "<C-p>" = "actions.preview";
  "<C-c>" = "actions.close";
  "<C-l>" = "actions.refresh";
  "-" = "actions.parent";
  "_" = "actions.open_cwd";
  "`" = "actions.cd";
  "~" = "actions.tcd";
  "gs" = "actions.change_sort";
  "gx" = "actions.open_external";
  "g." = "actions.toggle_hidden";
  "g\\" = "actions.toggle_trash";
}

Type: null or (attribute set of (string or attribute set of anything or value false (singular enum) or raw lua code))

Default: null

Declared by:

plugins.oil.settings.keymaps_help

Configuration for the floating keymaps help window.

Plugin default: {border = "rounded";}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.oil.settings.prompt_save_on_select_new_entry

Selecting a new/moved/renamed file or directory will prompt you to save changes first.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.skip_confirm_for_simple_edits

Skip the confirmation popup for simple operations.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.use_default_keymaps

Set to false to disable all of the above keymaps.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.buf_options.bufhidden

Plugin default: "hide"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.buf_options.buflisted

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.float.border

Defines the border to use for oil.open_float. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.oil.settings.float.max_height

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.float.max_width

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.float.override

This is the config that will be passed to nvim_open_win. Change values here to customize the layout.

Plugin default:

function(conf)
  return conf
end

Type: null or lua function string

Default: null

Declared by:

plugins.oil.settings.float.padding

Padding around the floating window.

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.float.win_options.winblend

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.lsp_file_method.autosave_changes

Set to true to autosave buffers that are updated with LSP willRenameFiles. Set to “unmodified” to only save unmodified buffers.

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.oil.settings.lsp_file_method.timeout_ms

Time to wait for LSP file operations to complete before skipping.

Plugin default: 1000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.preview.border

Plugin default: "rounded"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.preview.height

Optionally define an integer/float for the exact height of the preview window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.oil.settings.preview.max_height

Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. max_height = [80 0.9] means “the lesser of 80 columns or 90% of total”.

Plugin default: 0.9

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.preview.max_width

Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. max_width = [100 0.8] means “the lesser of 100 columns or 80% of total”.

Plugin default: 0.9

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.preview.min_height

Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. min_height = [5 0.1] means “the greater of 5 columns or 10% of total”.

Plugin default: [5 0.1]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.preview.min_width

Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. min_width = [40 0.4] means “the greater of 40 columns or 40% of total”.

Plugin default: [40 0.4]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.preview.update_on_cursor_moved

Whether the preview window is automatically updated when the cursor is moved.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.preview.width

Optionally define an integer/float for the exact width of the preview window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.oil.settings.preview.win_options.winblend

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.progress.border

Plugin default: "rounded"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.progress.height

Optionally define an integer/float for the exact height of the preview window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.oil.settings.progress.max_height

Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. max_height = [80 0.9] means “the lesser of 80 columns or 90% of total”.

Plugin default: 0.9

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.progress.max_width

Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. max_width = [100 0.8] means “the lesser of 100 columns or 80% of total”.

Plugin default: 0.9

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.progress.min_height

Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. min_height = [5 0.1] means “the greater of 5 columns or 10% of total”.

Plugin default: [5 0.1]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.progress.min_width

Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. min_width = [40 0.4] means “the greater of 40 columns or 40% of total”.

Plugin default: [40 0.4]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.oil.settings.progress.minimized_border

Plugin default: "none"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.progress.width

Optionally define an integer/float for the exact width of the preview window.

Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.oil.settings.progress.win_options.winblend

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.ssh.border

Configuration for the floating SSH window.

Plugin default: "rounded"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.view_options.is_always_hidden

This function defines what will never be shown, even when show_hidden is set.

Plugin default:

function(name, bufnr)
  return false
end

Type: null or lua function string

Default: null

Declared by:

plugins.oil.settings.view_options.is_hidden_file

This function defines what is considered a ‘hidden’ file.

Plugin default:

function(name, bufnr)
  return vim.startswith(name, ".")
end

Type: null or lua function string

Default: null

Declared by:

plugins.oil.settings.view_options.natural_order

Sort file names in a more intuitive order for humans. Is less performant, so you may want to set to false if you work with large directories.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.view_options.show_hidden

Show files and directories that start with “.”

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.view_options.sort

Sort order can be “asc” or “desc”. See :help oil-columns to see which columns are sortable.

Plugin default:

[
  ["type" "asc"]
  ["name" "asc"]
]

Type: null or (list of ((list of string) or raw lua code))

Default: null

Declared by:

plugins.oil.settings.win_options.concealcursor

Plugin default: "nvic"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.conceallevel

Plugin default: 3

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.cursorcolumn

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.foldcolumn

Plugin default: "0"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.list

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.signcolumn

Plugin default: "no"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.spell

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.oil.settings.win_options.wrap

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ollama.enable

Whether to enable ollama.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ollama.package

Which package to use for the ollama.nvim plugin.

Type: package

Default: <derivation vimplugin-ollama.nvim-2023-12-22>

Declared by:

plugins.ollama.action

How to handle prompt outputs when not specified by prompt.

See here for more details.

Plugin default: display

Type: null or raw lua code or one of “display”, “replace”, “insert”, “display_replace”, “display_insert”, “display_prompt” or (submodule)

Default: null

Declared by:

plugins.ollama.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.ollama.model

The default model to use.

Plugin default: "mistral"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ollama.prompts

A table of prompts to use for each model. Default prompts are defined here.

Type: attribute set of ((submodule) or value false (singular enum))

Default: { }

Declared by:

plugins.ollama.url

The url to use to connect to the ollama server.

Plugin default: "http://127.0.0.1:11434"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ollama.serve.args

The arguments to pass to the serve command.

Plugin default: ["serve"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.ollama.serve.command

The command to use to start the ollama server.

Plugin default: "ollama"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ollama.serve.onStart

Whether to start the ollama server on startup.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ollama.serve.stopArgs

The arguments to pass to the stop command.

Plugin default: ["-SIGTERM" "ollama"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.ollama.serve.stopCommand

The command to use to stop the ollama server.

Plugin default: "pkill"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.openscad.enable

Whether to enable openscad.nvim, a plugin to manage OpenSCAD files.

Type: boolean

Default: false

Example: true

Declared by:

plugins.openscad.package

Which package to use for the openscad.nvim plugin.

Type: package

Default: <derivation vimplugin-openscad.nvim-2024-04-13>

Declared by:

plugins.openscad.autoOpen

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.openscad.cheatsheetWindowBlend

Plugin default: 15

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.openscad.fuzzyFinder

fuzzy finder to find documentation

Plugin default: "skim"

Type: null or one of “skim”, “fzf” or raw lua code

Default: null

Declared by:

plugins.openscad.loadSnippets

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.openscad.keymaps.enable

Whether to enable keymaps for openscad.

Type: boolean

Default: false

Example: true

Declared by:

plugins.openscad.keymaps.cheatsheetToggle

Toggle cheatsheet window

Plugin default: "<Enter>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.openscad.keymaps.execOpenSCADTrigger

Open file in OpenSCAD

Plugin default: "<A-o>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.openscad.keymaps.helpManualTrigger

Open offline openscad manual in pdf via zathura

Plugin default: "<A-m>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.openscad.keymaps.helpTrigger

Fuzzy find help resource

Plugin default: "<A-h>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.openscad.keymaps.topToggle

toggle htop filtered for openscad processes

Plugin default: "<A-c>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.packer.enable

Whether to enable packer.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.packer.plugins

List of plugins

Type: list of (string or (submodule))

Default: [ ]

Declared by:

plugins.packer.rockPlugins

List of lua rock plugins

Type: list of (string or (attribute set))

Default: [ ]

Example:

''
  [
    "penlight"
    "lua-resty-http"
    "lpeg"
  ]
''

Declared by:

parinfer-rust

Url: https://github.com/eraserhd/parinfer-rust

Maintainers: Gaetan Lepage

plugins.parinfer-rust.enable

Whether to enable parinfer-rust.

Type: boolean

Default: false

Example: true

Declared by:

plugins.parinfer-rust.package

Which package to use for the parinfer-rust plugin.

Type: package

Default: <derivation parinfer-rust-0.4.3>

Declared by:

plugins.parinfer-rust.settings

The configuration options for parinfer-rust without the parinfer_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal parinfer_foo_bar=1
  • hello = "world" -> :setglobal parinfer_hello="world"
  • some_toggle = true -> :setglobal parinfer_some_toggle
  • other_toggle = false -> :setglobal noparinfer_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.parinfer-rust.settings.force_balance

In smart mode and indent mode, parinfer will sometimes leave unbalanced brackets around the cursor and fix them when the cursor moves away. When this option is set to true, the brackets will be fixed immediately (and fixed again when text is inserted).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.parinfer-rust.settings.mode

The mode used to process buffer changes.

Plugin default: "smart"

Type: null or one of “smart”, “indent”, “paren” or raw lua code

Default: null

Declared by:

plugins.persistence.enable

Whether to enable persistence.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.persistence.package

Which package to use for the persistence.nvim plugin.

Type: package

Default: <derivation vimplugin-persistence.nvim-2024-05-16>

Declared by:

plugins.persistence.dir

directory where session files are saved

Plugin default: vim.fn.expand(vim.fn.stdpath("state") .. "/sessions/")

Type: null or string or raw lua code

Default: null

Declared by:

plugins.persistence.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.persistence.options

sessionoptions used for saving

Plugin default: ["buffers" "curdir" "tabpages" "winsize" "skiprtp"]

Type: null or (list of (one of “blank”, “buffers”, “curdir”, “folds”, “globals”, “help”, “localoptions”, “options”, “skiprtp”, “resize”, “sesdir”, “tabpages”, “terminal”, “winpos”, “winsize”))

Default: null

Declared by:

plugins.persistence.preSave

a function to call before saving the session

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.persistence.saveEmpty

don’t save if there are no open file buffers

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.plantuml-syntax.enable

Whether to enable plantuml syntax support.

Type: boolean

Default: false

Example: true

Declared by:

plugins.plantuml-syntax.package

Which package to use for the plantuml-syntax plugin.

Type: package

Default: <derivation vimplugin-plantuml-syntax-2024-05-10>

Declared by:

plugins.plantuml-syntax.executableScript

Set the script to be called with makeprg, default to ‘plantuml’ in PATH

Type: null or string

Default: null

Declared by:

plugins.plantuml-syntax.setMakeprg

Set the makeprg to ‘plantuml’

Type: boolean

Default: true

Declared by:

plugins.presence-nvim.enable

Whether to enable presence-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.presence-nvim.enableLineNumber

Displays the current line number instead of the current project.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.presence-nvim.package

Which package to use for the presence-nvim plugin.

Type: package

Default: <derivation vimplugin-presence.nvim-2023-01-29>

Declared by:

plugins.presence-nvim.autoUpdate

Update activity based on autocmd events. If false, map or manually execute :lua package.loaded.presence:update()

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.presence-nvim.blacklist

A list of strings or Lua patterns that disable Rich Presence if the current file name, path, or workspace matches.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.presence-nvim.buttons

Button configurations which will always appear in Rich Presence.

Can be a list of attribute sets, each with the following attributes:

label: The label of the button. e.g. "GitHub Profile".

url: The URL the button leads to. e.g. "https://github.com/<NAME>".

Can also be a lua function: function(buffer: string, repo_url: string|nil): table)

Plugin default: []

Type: null or raw lua code or list of (submodule)

Default: null

Declared by:

plugins.presence-nvim.clientId

Use your own Discord application client id. (not recommended)

Plugin default: "793271441293967371"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.debounceTimeout

Number of seconds to debounce events. (or calls to :lua package.loaded.presence:update(<filename>, true))

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.presence-nvim.editingText

String rendered when an editable file is loaded in the buffer.

Can also be a lua function: function(filename: string): string

Plugin default: Editing %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.presence-nvim.fileAssets

Custom file asset definitions keyed by file names and extensions.

List elements for each attribute (filetype):

name: The name of the asset shown as the title of the file in Discord.

source: The source of the asset, either an art asset key or the URL of an image asset.

Example:

  {
    # Use art assets uploaded in Discord application for the configured client id
    js = [ "JavaScript" "javascript" ];
    ts = [ "TypeScript" "typescript" ];
    # Use image URLs
    rs = [ "Rust" "https://www.rust-lang.org/logos/rust-logo-512x512.png" ];
    go = [ "Go" "https://go.dev/blog/go-brand/Go-Logo/PNG/Go-Logo_Aqua.png" ];
  };

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.presence-nvim.fileExplorerText

String rendered when browsing a file explorer.

Can also be a lua function: function(file_explorer_name: string): string

Plugin default: Browsing %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.gitCommitText

String rendered when committing changes in git.

Can also be a lua function: function(filename: string): string

Plugin default: Committing changes

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.lineNumberText

String rendered when enableLineNumber is set to true to display the current line number.

Can also be a lua function: function(line_number: number, line_count: number): string

Plugin default: Line %s out of %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.logLevel

Log messages at or above this level.

Plugin default: null

Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code

Default: null

Declared by:

plugins.presence-nvim.mainImage

Main image display.

Plugin default: "neovim"

Type: null or one of “neovim”, “file” or raw lua code

Default: null

Declared by:

plugins.presence-nvim.neovimImageText

Text displayed when hovered over the Neovim image.

Plugin default: "The One True Text Editor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.pluginManagerText

String rendered when managing plugins.

Can also be a lua function: function(plugin_manager_name: string): string

Plugin default: Managing plugins

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.readingText

String rendered when a read-only/unmodifiable file is loaded into the buffer.

Can also be a lua function: function(filename: string): string

Plugin default: Reading %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.showTime

Show the timer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.presence-nvim.workspaceText

String rendered when in a git repository.

Can also be a lua function: function(project_name: string|nil, filename: string): string

Plugin default: Working on %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.project-nvim.enable

Whether to enable project.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.project-nvim.enableTelescope

Whether to enable When set to true, enabled project-nvim telescope integration. .

Type: boolean

Default: false

Example: true

Declared by:

plugins.project-nvim.package

Which package to use for the project-nvim plugin.

Type: package

Default: <derivation vimplugin-project.nvim-2023-04-04>

Declared by:

plugins.project-nvim.dataPath

Path where project.nvim will store the project history for use in telescope.

Plugin default: {__raw = "vim.fn.stdpath('data')";}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.project-nvim.detectionMethods

Methods of detecting the root directory. “lsp” uses the native neovim lsp, while “pattern” uses vim-rooter like glob pattern matching. Here order matters: if one is not detected, the other is used as fallback. You can also delete or rearangne the detection methods.

Plugin default: ["lsp" "pattern"]

Type: null or (list of string)

Default: null

Declared by:

plugins.project-nvim.excludeDirs

Don’t calculate root dir on specific directories.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.project-nvim.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.project-nvim.ignoreLsp

Table of lsp clients to ignore by name.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.project-nvim.manualMode

Manual mode doesn’t automatically change your root directory, so you have the option to manually do so using :ProjectRoot command.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.project-nvim.patterns

All the patterns used to detect root dir, when “pattern” is in detectionMethods.

Plugin default: [".git" "_darcs" ".hg" ".bzr" ".svn" "Makefile" "package.json"]

Type: null or (list of string)

Default: null

Declared by:

plugins.project-nvim.scopeChdir

What scope to change the directory.

Plugin default: "global"

Type: null or one of “global”, “tab”, “win” or raw lua code

Default: null

Declared by:

plugins.project-nvim.showHidden

Show hidden files in telescope.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.project-nvim.silentChdir

When set to false, you will get a message when project.nvim changes your directory.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

qmk

Url: https://github.com/codethread/qmk.nvim/

Maintainers: Gaetan Lepage

plugins.qmk.enable

Whether to enable qmk.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.qmk.package

Which package to use for the qmk.nvim plugin.

Type: package

Default: <derivation vimplugin-qmk.nvim-2024-04-17>

Declared by:

plugins.qmk.settings

Options provided to the require('qmk').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  auto_format_pattern = "*keymap.c";
  comment_preview = {
    keymap_overrides = { };
    position = "top";
    symbols = {
      bl = "└";
      bm = "┴";
      br = "┘";
      horz = "─";
      ml = "├";
      mm = "┼";
      mr = "┤";
      space = " ";
      tl = "┌";
      tm = "┬";
      tr = "┐";
      vert = "│";
    };
  };
  layout = [
    "x x"
    "x^x"
  ];
  name = "LAYOUT_preonic_grid";
  timeout = 5000;
  variant = "qmk";
}

Declared by:

plugins.qmk.settings.auto_format_pattern

The autocommand file pattern to use when applying QMKFormat on save.

Plugin default: "*keymap.c"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.qmk.settings.layout

The keyboard key layout.

The layout config describes your layout as expected by qmk_firmware. As qmk_firmware is simply expecting an array of key codes, the layout is pretty much up to you.

A layout is a list of strings, where each string in the list represents a single row. Rows must all be the same width, and you’ll see they visually align to what your keymap looks like.

Type: list of string

Example:

[
  "x x"
  "x^x"
]

Declared by:

plugins.qmk.settings.name

The name of your layout, for example LAYOUT_preonic_grid for the preonic keyboard, for zmk this can just be anything, it won’t be used.

Type: string

Example: "LAYOUT_preonic_grid"

Declared by:

plugins.qmk.settings.timeout

Duration of vim.notify timeout if using nvim-notify.

Plugin default: 5000

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.qmk.settings.variant

Chooses the expected hardware target.

Plugin default: "qmk"

Type: null or one of “qmk”, “zmk” or raw lua code

Default: null

Declared by:

plugins.qmk.settings.comment_preview.keymap_overrides

A dictionary of key codes to text replacements, any provided value will be merged with the existing dictionary, see key_map.lua for details.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.qmk.settings.comment_preview.position

Control the position of the preview, set to none to disable (inside is only valid for variant=qmk).

Plugin default: "top"

Type: null or one of “top”, “bottom”, “inside”, “none” or raw lua code

Default: null

Declared by:

plugins.qmk.settings.comment_preview.symbols

A dictionary of symbols used for the preview comment border chars see default.lua for details.

Plugin default:

{
  space = " ";
  horz = "─";
  vert = "│";
  tl = "┌";
  tm = "┬";
  tr = "┐";
  ml = "├";
  mm = "┼";
  mr = "┤";
  bl = "└";
  bm = "┴";
  br = "┘";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.quickmath.enable

Whether to enable quickmath.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.quickmath.package

Which package to use for the quickmath.nvim plugin.

Type: package

Default: <derivation vimplugin-quickmath.nvim-2024-02-12>

Declared by:

plugins.quickmath.keymap.key

Keymap to run the :Quickmath command.

Type: null or string

Default: null

Declared by:

plugins.quickmath.keymap.silent

Whether the quickmath keymap should be silent.

Type: boolean

Default: false

Declared by:

plugins.rainbow-delimiters.enable

Whether to enable rainbow-delimiters.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.rainbow-delimiters.package

Which package to use for the rainbow-delimiters.nvim plugin.

Type: package

Default: <derivation vimplugin-rainbow-delimiters.nvim-2024-05-11>

Declared by:

plugins.rainbow-delimiters.blacklist

List of Tree-sitter languages for which to disable rainbow delimiters. Rainbow delimiters will be enabled for all other languages.

Type: null or (list of string)

Default: null

Declared by:

plugins.rainbow-delimiters.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.rainbow-delimiters.highlight

List of names of the highlight groups to use for highlighting, for more information see |rb-delimiters-colors|.

Plugin default:

[
  "RainbowDelimiterRed"
  "RainbowDelimiterYellow"
  "RainbowDelimiterBlue"
  "RainbowDelimiterOrange"
  "RainbowDelimiterGreen"
  "RainbowDelimiterViolet"
  "RainbowDelimiterCyan"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.rainbow-delimiters.query

Attrs mapping Tree-sitter language names to queries. See |rb-delimiters-query| for more information about queries.

Plugin default:

{
  default = "rainbow-delimiters";
  lua = "rainbow-blocks";
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.rainbow-delimiters.strategy

Attrs mapping Tree-sitter language names to strategies. See |rb-delimiters-strategy| for more information about strategies.

Example:

  {
    # Use global strategy by default
    default = "global";

    # Use local for HTML
    html = "local";

    # Pick the strategy for LaTeX dynamically based on the buffer size
    latex.__raw = \'\'
      function()
        -- Disabled for very large files, global strategy for large files,
        -- local strategy otherwise
        if vim.fn.line('$') > 10000 then
            return nil
        elseif vim.fn.line('$') > 1000 then
            return require 'rainbow-delimiters'.strategy['global']
        end
        return require 'rainbow-delimiters'.strategy['local']
      end
    \'\';
  }

Plugin default:

{
  default = "global";
}

Type: null or (attribute set of (raw lua code or one of “global”, “local”, “noop”))

Default: null

Declared by:

plugins.rainbow-delimiters.whitelist

List of Tree-sitter languages for which to enable rainbow delimiters. Rainbow delimiters will be disabled for all other languages.

Type: null or (list of string)

Default: null

Declared by:

plugins.rainbow-delimiters.log.file

Path to the log file, default is rainbow-delimiters.log in your standard log path (see |standard-path|).

Plugin default:

{
  __raw = "vim.fn.stdpath('log') .. '/rainbow-delimiters.log'";
}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rainbow-delimiters.log.level

Only messages equal to or above this value will be logged. The default is to log warnings or above. See |log_levels| for possible values.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: "warn"

Declared by:

refactoring

Url: https://github.com/theprimeagen/refactoring.nvim/

Maintainers: Matt Sturgeon

plugins.refactoring.enable

Whether to enable refactoring.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.refactoring.enableTelescope

Whether to enable telescope integration.

Type: boolean

Default: false

Example: true

Declared by:

plugins.refactoring.package

Which package to use for the refactoring.nvim plugin.

Type: package

Default: <derivation vimplugin-refactoring.nvim-2024-03-15>

Declared by:

plugins.refactoring.settings

Options provided to the require('refactoring').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.refactoring.settings.extract_var_statements

When performing an extract_var refactor operation, you can custom how the new variable would be declared by setting configuration like the below example.

Example:

  {
    # overriding extract statement for go
    go = "%s := %s // poggers";
  }

Plugin default: { }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.refactoring.settings.print_var_statements

In any custom print var statement, it is possible to optionally add a max of two %s patterns, which is where the debug path and the actual variable reference will go, respectively. To add a literal "%s" to the string, escape the sequence like this: %%s. For an example custom print var statement, go to this folder, select your language, and view multiple-statements/print_var.config.

Note: if you have multiple custom statements, the plugin will prompt for which one should be inserted. If you just have one custom statement in your config, it will override the default automatically.

Example:

  {
    # add a custom print var statement for cpp
    cpp = [ "printf(\"a custom statement %%s %s\", %s)" ];
  }

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.refactoring.settings.printf_statements

In any custom printf statement, it is possible to optionally add a max of one %s pattern, which is where the debug path will go. For an example custom printf statement, go to this folder, select your language, and click on multiple-statements/printf.config.

Note: if you have multiple custom statements, the plugin will prompt for which one should be inserted. If you just have one custom statement in your config, it will override the default automatically.

Example:

  {
    # add a custom printf statement for cpp
    cpp = [ "std::cout << \"%s\" << std::endl;" ];
  }

Plugin default: { }

Type: null or (attribute set of ((list of (string or raw lua code)) or raw lua code))

Default: null

Declared by:

plugins.refactoring.settings.prompt_func_param_type

For certain languages like Golang, types are required for functions parameters. Unfortunately, for some parameters there is no way to automatically find their type. In those instances, we want to provide a way to input a type instead of inserting a placeholder value.

Set the relevant language(s) to true to enable prompting for parameter types, e.g:

  {
    go = true;
    cpp = true;
    c = true;
    java = true;
  }


_Plugin default:_

```nix
{
  go = false;
  java = false;
  cpp = false;
  c = false;
  h = false;
  hpp = false;
  cxx = false;
}

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

plugins.refactoring.settings.prompt_func_return_type

For certain languages like Golang, types are required for functions that return an object(s). Unfortunately, for some functions there is no way to automatically find their type. In those instances, we want to provide a way to input a type instead of inserting a placeholder value.

Set the relevant language(s) to true to enable prompting for a return type, e.g:

  {
    go = true;
    cpp = true;
    c = true;
    java = true;
  }

Plugin default:

{
  go = false;
  java = false;
  cpp = false;
  c = false;
  h = false;
  hpp = false;
  cxx = false;
}

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Declared by:

plugins.refactoring.settings.show_success_message

Shows a message with information about the refactor on success. Such as:

  [Refactor] Inlined 3 variable occurrences

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

rest

Url: https://github.com/rest-nvim/rest.nvim/

Maintainers: Gaetan Lepage

plugins.rest.enable

Whether to enable rest.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.rest.package

Which package to use for the rest.nvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-rest.nvim-2.0.1-1-unstable-2024-05-04>

Declared by:

plugins.rest.settings

Options provided to the require('rest').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  client = "curl";
  env_file = ".env";
  keybinds = [
    [
      "<localleader>rr"
      "<cmd>Rest run<cr>"
      "Run request under the cursor"
    ]
    [
      "<localleader>rl"
      "<cmd>Rest run last<cr>"
      "Re-run latest request"
    ]
  ];
  logs = {
    level = "info";
    save = true;
  };
  result = {
    split = {
      horizontal = false;
      in_place = false;
      stay_in_current_window_after_split = true;
    };
  };
}

Declared by:

plugins.rest.settings.client

The HTTP client to be used when running requests.

Plugin default: "curl"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.custom_dynamic_variables

Custom dynamic variables. Keys are variable names and values are lua functions.

default: {}

Type: null or (attribute set of lua function string) or raw lua code

Default: null

Example:

{
  "\$randomInt" = ''
    function()
      return math.random(0, 1000)
    end
  '';
  "\$timestamp" = "os.time";
}

Declared by:

plugins.rest.settings.encode_url

Encode URL before making request.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.env_edit_command

Neovim command to edit an environment file.

Plugin default: "tabedit"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.env_file

Environment variables file to be used for the request variables in the document.

Plugin default: ".env"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.env_pattern

Environment variables file pattern for telescope.nvim.

Plugin default: "\\.env$"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.keybinds

Declare some keybindings. Format: list of 3 strings lists: key, action and description.

Plugin default:

[
  [
    "<localleader>rr"
    "<cmd>Rest run<cr>"
    "Run request under the cursor"
  ]
  [
    "<localleader>rl"
    "<cmd>Rest run last<cr>"
    "Re-run latest request"
  ]
]

Type: null or (list of ((list of string) or raw lua code))

Default: null

Declared by:

plugins.rest.settings.skip_ssl_verification

Skip SSL verification, useful for unknown certificates.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.highlight.enable

Whether current request highlighting is enabled or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.highlight.timeout

Duration time of the request highlighting in milliseconds.

Plugin default: 750

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.rest.settings.logs.level

The logging level name, see :h vim.log.levels.

Plugin default: info

Type: null or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: null

Declared by:

plugins.rest.settings.logs.save

Whether to save log messages into a .log file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.decode_url

Whether to decode the request URL query parameters to improve readability.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.formatters.html

HTML formatter.

Plugin default:

''
  {
    __raw = \'\'
      function(body)
        if vim.fn.executable("tidy") == 0 then
          return body, { found = false, name = "tidy" }
        end
        local fmt_body = vim.fn.system({
          "tidy",
          "-i",
          "-q",
          "--tidy-mark",      "no",
          "--show-body-only", "auto",
          "--show-errors",    "0",
          "--show-warnings",  "0",
          "-",
        }, body):gsub("\n$", "")
  
        return fmt_body, { found = true, name = "tidy" }
      end
    \'\';
  }
''

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.formatters.json

JSON formatter.

Plugin default: "jq"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.show_info.curl_command

Display the cURL command that was used for the request.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.show_info.headers

Display the request headers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.show_info.http_info

Display the request HTTP information.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.show_info.url

Display the request URL.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.statistics.enable

Whether to enable statistics or not.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.behavior.statistics.stats

See https://curl.se/libcurl/c/curl_easy_getinfo.html.

Plugin default:

[
  {
    __unkeyed = "total_time";
    title = "Time taken:";
  }
  {
    __unkeyed = "size_download_t";
    title = "Download size:";
  }
]

Type: null or (list of ((attribute set of string) or raw lua code))

Default: null

Declared by:

plugins.rest.settings.result.keybinds.buffer_local

Enable keybinds only in request result buffer.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.keybinds.next

Mapping for cycle to next result pane.

Plugin default: "L"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.keybinds.prev

Mapping for cycle to previous result pane.

Plugin default: "H"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.split.horizontal

Open request results in a horizontal split.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.split.in_place

Keep the HTTP file buffer above|left when split horizontal|vertical.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rest.settings.result.split.stay_in_current_window_after_split

Stay in the current window (HTTP file) or change the focus to the results window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.enable

Whether to enable rust tools plugins.

Type: boolean

Default: false

Example: true

Declared by:

plugins.rust-tools.package

Which package to use for the rust-tools plugin.

Type: package

Default: <derivation vimplugin-rust-tools.nvim-2024-01-03>

Declared by:

plugins.rust-tools.executor

how to execute terminal commands

Plugin default: "termopen"

Type: null or one of “termopen”, “quickfix” or raw lua code

Default: null

Declared by:

plugins.rust-tools.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.rust-tools.onInitialized

Callback to execute once rust-analyzer is done initializing the workspace The callback receives one parameter indicating the health of the server: “ok” | “warning” | “error”

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.rust-tools.reloadWorkspaceFromCargoToml

Automatically call RustReloadWorkspace when writing to a Cargo.toml file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.serverPackage

Which package to use for rust-analyzer. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation rust-analyzer-2024-04-29>

Declared by:

plugins.rust-tools.crateGraph.enabledGraphvizBackends

List of backends found on: https://graphviz.org/docs/outputs/ Is used for input validation and autocompletion

Plugin default: null

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.crateGraph.backend

Backend used for displaying the graph see: https://graphviz.org/docs/outputs/

Plugin default: "x11"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rust-tools.crateGraph.full

true for all crates.io and external crates, false only the local crates

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.crateGraph.output

where to store the output, nil for no output stored

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rust-tools.hoverActions.autoFocus

whether the hover action window gets automatically focused

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.hoverActions.border

Defines the border to use for rust-tools hover window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default:

[
  [ "╭" "FloatBorder" ]
  [ "─" "FloatBorder" ]
  [ "╮" "FloatBorder" ]
  [ "│" "FloatBorder" ]
  [ "╯" "FloatBorder" ]
  [ "─" "FloatBorder" ]
  [ "╰" "FloatBorder" ]
  [ "│" "FloatBorder" ]
]

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.rust-tools.hoverActions.maxHeight

Maximal height of the hover window. null means no max.

Plugin default: null

Type: null or signed integer

Default: null

Declared by:

plugins.rust-tools.hoverActions.maxWidth

Maximal width of the hover window. null means no max.

Plugin default: null

Type: null or signed integer

Default: null

Declared by:

plugins.rust-tools.inlayHints.auto

automatically set inlay hints (type hints)

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.highlight

The color of the hints

Plugin default: "Comment"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.maxLenAlign

whether to align to the length of the longest line in the file

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.maxLenAlignPadding

padding from the left if max_len_align is true

Plugin default: 1

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.onlyCurrentLine

Only show for current line

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.otherHintsPrefix

prefix for all the other hints (type, chaining)

Plugin default: "=> "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.parameterHintsPrefix

prefix for parameter hints

Plugin default: "<- "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.rightAlign

whether to align to the extreme right or not

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.rightAlignPadding

padding from the right if right_align is true

Plugin default: 7

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.rust-tools.inlayHints.showParameterHints

whether to show parameter hints with the inlay hints or not

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.server.checkOnSave

Run the check command for diagnostics on save.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.linkedProjects

Disable project auto-discovery in favor of explicitly specified set of projects.

Elements must be paths pointing to Cargo.toml, rust-project.json, .rs files (which will be treated as standalone files) or JSON objects in rust-project.json format.

default:

[ ]

Type: null or (list of (string or attribute set of anything))

Default: null

Declared by:

plugins.rust-tools.server.numThreads

How many worker threads in the main loop. The default null means to pick automatically.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.standalone

standalone file support setting it to false may improve startup time

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rust-tools.server.assist.emitMustUse

Whether to insert #[must_use] when generating as_ methods for enum variants.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.assist.expressionFillDefault

Placeholder expression to use for missing expressions in assists.

Values:

  • todo: Fill missing expressions with the todo macro
  • default: Fill missing expressions with reasonable defaults, new or default constructors.
"todo"

Type: null or one of “todo”, “default”

Default: null

Declared by:

plugins.rust-tools.server.cachePriming.enable

Warm up caches on project load.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cachePriming.numThreads

How many worker threads to handle priming caches. The default 0 means to pick automatically.

default:

0

Type: null or integer or floating point number between 0 and 255 (both inclusive)

Default: null

Declared by:

plugins.rust-tools.server.cargo.allTargets

Pass --all-targets to cargo invocation.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.autoreload

Automatically refresh project info via cargo metadata on Cargo.toml or .cargo/config.toml changes.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.cfgs

List of cfg options to enable with the given values.

default:

{
  debug_assertions = null;
  miri = null;
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.cargo.extraArgs

Extra arguments that are passed to every cargo invocation.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.cargo.extraEnv

Extra environment variables that will be set when running cargo, rustc or other commands within the workspace. Useful for setting RUSTFLAGS.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.cargo.features

List of features to activate.

Set this to "all" to pass --all-features to cargo.

default:

[ ]

Type: null or value “all” (singular enum) or list of string

Default: null

Declared by:

plugins.rust-tools.server.cargo.noDefaultFeatures

Whether to pass --no-default-features to cargo.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.sysroot

Relative path to the sysroot, or “discover” to try to automatically find it via “rustc --print sysroot”.

Unsetting this disables sysroot loading.

This option does not take effect until rust-analyzer is restarted.

default:

"discover"

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.cargo.sysrootQueryMetadata

Whether to run cargo metadata on the sysroot library allowing rust-analyzer to analyze third-party dependencies of the standard libraries.

This will cause cargo to create a lockfile in your sysroot directory. rust-analyzer will attempt to clean up afterwards, but nevertheless requires the location to be writable to.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.sysrootSrc

Relative path to the sysroot library sources. If left unset, this will default to {cargo.sysroot}/lib/rustlib/src/rust/library.

This option does not take effect until rust-analyzer is restarted.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.cargo.target

Compilation target override (target triple).

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.cargo.targetDir

Optional path to a rust-analyzer specific target directory. This prevents rust-analyzer’s cargo check and initial build-script and proc-macro building from locking the Cargo.lock at the expense of duplicating build artifacts.

Set to true to use a subdirectory of the existing target directory or set to a path relative to the workspace to use that path.

default:

null

Type: null or null or boolean or string

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.enable

Run build scripts (build.rs) for more precise code analysis.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.invocationLocation

Specifies the working directory for running build scripts.

  • “workspace”: run build scripts for a workspace in the workspace’s root directory. This is incompatible with #rust-analyzer.cargo.buildScripts.invocationStrategy# set to once.
  • “root”: run build scripts in the project’s root directory. This config only has an effect when #rust-analyzer.cargo.buildScripts.overrideCommand# is set.

Values:

  • workspace: The command will be executed in the corresponding workspace root.
  • root: The command will be executed in the project root.
"workspace"

Type: null or one of “workspace”, “root”

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.invocationStrategy

Specifies the invocation strategy to use when running the build scripts command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when #rust-analyzer.cargo.buildScripts.overrideCommand# is set.

Values:

  • per_workspace: The command will be executed for each workspace.
  • once: The command will be executed once.
"per_workspace"

Type: null or one of “per_workspace”, “once”

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.overrideCommand

Override the command rust-analyzer uses to run build scripts and build procedural macros. The command is required to output json and should therefore include --message-format=json or a similar option.

If there are multiple linked projects/workspaces, this command is invoked for each of them, with the working directory being the workspace root (i.e., the folder containing the Cargo.toml). This can be overwritten by changing #rust-analyzer.cargo.buildScripts.invocationStrategy# and #rust-analyzer.cargo.buildScripts.invocationLocation#.

By default, a cargo invocation will be constructed for the configured targets and features, with the following base command line:

cargo check --quiet --workspace --message-format=json --all-targets

.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.rebuildOnSave

Rerun proc-macros building/build-scripts running when proc-macro or build-script sources change and are saved.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.cargo.buildScripts.useRustcWrapper

Use RUSTC_WRAPPER=rust-analyzer when running build scripts to avoid checking unnecessary things.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.check.allTargets

Check all targets and tests (--all-targets). Defaults to #rust-analyzer.cargo.allTargets#.

default:

null

Type: null or null or boolean

Default: null

Declared by:

plugins.rust-tools.server.check.command

Cargo command to use for cargo check.

default:

"check"

Type: null or string

Default: null

Declared by:

plugins.rust-tools.server.check.extraArgs

Extra arguments for cargo check.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.check.extraEnv

Extra environment variables that will be set when running cargo check. Extends #rust-analyzer.cargo.extraEnv#.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.check.features

List of features to activate. Defaults to #rust-analyzer.cargo.features#.

Set to "all" to pass --all-features to Cargo.

default:

null

Type: null or value “all” (singular enum) or list of string or null

Default: null

Declared by:

plugins.rust-tools.server.check.ignore

List of cargo check (or other command specified in check.command) diagnostics to ignore.

For example for cargo check: dead_code, unused_imports, unused_variables,…

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.check.invocationLocation

Specifies the working directory for running checks.

  • “workspace”: run checks for workspaces in the corresponding workspaces’ root directories. This falls back to “root” if #rust-analyzer.check.invocationStrategy# is set to once.
  • “root”: run checks in the project’s root directory. This config only has an effect when #rust-analyzer.check.overrideCommand# is set.

Values:

  • workspace: The command will be executed in the corresponding workspace root.
  • root: The command will be executed in the project root.
"workspace"

Type: null or one of “workspace”, “root”

Default: null

Declared by:

plugins.rust-tools.server.check.invocationStrategy

Specifies the invocation strategy to use when running the check command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when #rust-analyzer.check.overrideCommand# is set.

Values:

  • per_workspace: The command will be executed for each workspace.
  • once: The command will be executed once.
"per_workspace"

Type: null or one of “per_workspace”, “once”

Default: null

Declared by:

plugins.rust-tools.server.check.noDefaultFeatures

Whether to pass --no-default-features to Cargo. Defaults to #rust-analyzer.cargo.noDefaultFeatures#.

default:

null

Type: null or null or boolean

Default: null

Declared by:

plugins.rust-tools.server.check.overrideCommand

Override the command rust-analyzer uses instead of cargo check for diagnostics on save. The command is required to output json and should therefore include --message-format=json or a similar option (if your client supports the colorDiagnosticOutput experimental capability, you can use --message-format=json-diagnostic-rendered-ansi).

If you’re changing this because you’re using some tool wrapping Cargo, you might also want to change #rust-analyzer.cargo.buildScripts.overrideCommand#.

If there are multiple linked projects/workspaces, this command is invoked for each of them, with the working directory being the workspace root (i.e., the folder containing the Cargo.toml). This can be overwritten by changing #rust-analyzer.check.invocationStrategy# and #rust-analyzer.check.invocationLocation#.

If $saved_file is part of the command, rust-analyzer will pass the absolute path of the saved file to the provided command. This is intended to be used with non-Cargo build systems. Note that $saved_file is experimental and may be removed in the futureg.

An example command would be:

cargo check --workspace --message-format=json --all-targets

.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.check.targets

Check for specific targets. Defaults to #rust-analyzer.cargo.target# if empty.

Can be a single target, e.g. "x86_64-unknown-linux-gnu" or a list of targets, e.g. ["aarch64-apple-darwin", "x86_64-apple-darwin"].

Aliased as "checkOnSave.targets".

default:

null

Type: null or null or string or list of string

Default: null

Declared by:

plugins.rust-tools.server.check.workspace

Whether --workspace should be passed to cargo check. If false, -p <package> will be passed instead.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.limit

Maximum number of completions to return. If None, the limit is infinite.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.completion.autoimport.enable

Toggles the additional completions that automatically add imports when completed. Note that your client must specify the additionalTextEdits LSP client capability to truly have this feature enabled.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.autoself.enable

Toggles the additional completions that automatically show method calls and field accesses with self prefixed to them when inside a method.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.callable.snippets

Whether to add parenthesis and argument snippets when completing function.

Values:

  • fill_arguments: Add call parentheses and pre-fill arguments.
  • add_parentheses: Add call parentheses.
  • none: Do no snippet completions for callables.
"fill_arguments"

Type: null or one of “fill_arguments”, “add_parentheses”, “none”

Default: null

Declared by:

plugins.rust-tools.server.completion.fullFunctionSignatures.enable

Whether to show full function/method signatures in completion docs.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.postfix.enable

Whether to show postfix snippets like dbg, if, not, etc.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.privateEditable.enable

Enables completions of private items and fields that are defined in the current workspace even if they are not visible at the current position.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.completion.snippets.custom

Custom completion snippets.

default:

{
  "Arc::new" = {
    body = "Arc::new(\${receiver})";
    description = "Put the expression into an `Arc`";
    postfix = "arc";
    requires = "std::sync::Arc";
    scope = "expr";
  };
  "Box::pin" = {
    body = "Box::pin(\${receiver})";
    description = "Put the expression into a pinned `Box`";
    postfix = "pinbox";
    requires = "std::boxed::Box";
    scope = "expr";
  };
  Err = {
    body = "Err(\${receiver})";
    description = "Wrap the expression in a `Result::Err`";
    postfix = "err";
    scope = "expr";
  };
  Ok = {
    body = "Ok(\${receiver})";
    description = "Wrap the expression in a `Result::Ok`";
    postfix = "ok";
    scope = "expr";
  };
  "Rc::new" = {
    body = "Rc::new(\${receiver})";
    description = "Put the expression into an `Rc`";
    postfix = "rc";
    requires = "std::rc::Rc";
    scope = "expr";
  };
  Some = {
    body = "Some(\${receiver})";
    description = "Wrap the expression in an `Option::Some`";
    postfix = "some";
    scope = "expr";
  };
}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.completion.termSearch.enable

Whether to enable term search based snippets like Some(foo.bar().baz()).

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.enable

Whether to show native rust-analyzer diagnostics.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.disabled

List of rust-analyzer diagnostics to disable.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.remapPrefix

Map of prefixes to be substituted when parsing diagnostic file paths. This should be the reverse mapping of what is passed to rustc as --remap-path-prefix.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.warningsAsHint

List of warnings that should be displayed with hint severity.

The warnings will be indicated by faded text or three dots in code and will not show up in the Problems Panel.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.warningsAsInfo

List of warnings that should be displayed with info severity.

The warnings will be indicated by a blue squiggly underline in code and a blue icon in the Problems Panel.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.experimental.enable

Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.diagnostics.styleLints.enable

Whether to run additional style lints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.files.excludeDirs

These directories will be ignored by rust-analyzer. They are relative to the workspace root, and globs are not supported. You may also need to add the folders to Code’s files.watcherExclude.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.files.watcher

Controls file watching implementation.

Values:

  • client: Use the client (editor) to watch files for changes
  • server: Use server-side file watching
"client"

Type: null or one of “client”, “server”

Default: null

Declared by:

plugins.rust-tools.server.highlightRelated.breakPoints.enable

Enables highlighting of related references while the cursor is on break, loop, while, or for keywords.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.highlightRelated.closureCaptures.enable

Enables highlighting of all captures of a closure while the cursor is on the | or move keyword of a closure.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.highlightRelated.exitPoints.enable

Enables highlighting of all exit points while the cursor is on any return, ?, fn, or return type arrow (->).

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.highlightRelated.references.enable

Enables highlighting of related references while the cursor is on any identifier.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.highlightRelated.yieldPoints.enable

Enables highlighting of all break points for a loop or block context while the cursor is on any async or await keywords.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.enable

Whether to show HoverActions in Rust files.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.debug.enable

Whether to show Debug action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.gotoTypeDef.enable

Whether to show Go to Type Definition action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.implementations.enable

Whether to show Implementations action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.references.enable

Whether to show References action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.actions.run.enable

Whether to show Run action. Only applies when #rust-analyzer.hover.actions.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.documentation.enable

Whether to show documentation on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.documentation.keywords.enable

Whether to show keyword hover popups. Only applies when #rust-analyzer.hover.documentation.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.links.enable

Use markdown syntax for links on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.memoryLayout.enable

Whether to show memory layout data on hover.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.memoryLayout.alignment

How to render the align information in a memory layout hover.

default:

"hexadecimal"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.rust-tools.server.hover.memoryLayout.niches

How to render the niche information in a memory layout hover.

default:

false

Type: null or null or boolean

Default: null

Declared by:

plugins.rust-tools.server.hover.memoryLayout.offset

How to render the offset information in a memory layout hover.

default:

"hexadecimal"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.rust-tools.server.hover.memoryLayout.size

How to render the size information in a memory layout hover.

default:

"both"

Type: null or null or one of “both”, “decimal”, “hexadecimal”

Default: null

Declared by:

plugins.rust-tools.server.hover.show.enumVariants

How many variants of an enum to display when hovering on. Show none if empty.

default:

5

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.hover.show.fields

How many fields of a struct, variant or union to display when hovering on. Show none if empty.

default:

5

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.hover.show.traitAssocItems

How many associated items of a trait to display when hovering a trait.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.imports.preferNoStd

Prefer to unconditionally use imports of the core and alloc crate, over the std crate.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.imports.preferPrelude

Whether to prefer import paths containing a prelude module.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.imports.prefix

The path structure for newly inserted paths to use.

Values:

  • plain: Insert import paths relative to the current module, using up to one super prefix if the parent module contains the requested item.
  • self: Insert import paths relative to the current module, using up to one super prefix if the parent module contains the requested item. Prefixes self in front of the path if it starts with a module.
  • crate: Force import paths to be absolute by always starting them with crate or the extern crate name they come from.
"plain"

Type: null or one of “plain”, “self”, “crate”

Default: null

Declared by:

plugins.rust-tools.server.imports.granularity.enforce

Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.imports.granularity.group

How imports should be grouped into use statements.

Values:

  • preserve: Do not change the granularity of any imports and preserve the original structure written by the developer.
  • crate: Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.
  • module: Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.
  • item: Flatten imports so that each has its own use statement.
  • one: Merge all imports into a single use statement as long as they have the same visibility and attributes.
"crate"

Type: null or one of “preserve”, “crate”, “module”, “item”, “one”

Default: null

Declared by:

plugins.rust-tools.server.imports.group.enable

Group inserted imports by the following order. Groups are separated by newlines.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.imports.merge.glob

Whether to allow import insertion to merge new imports into single path glob imports like use std::fmt::*;.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.closureStyle

Closure notation in type and chaining inlay hints.

Values:

  • impl_fn: impl_fn: impl FnMut(i32, u64) -> i8
  • rust_analyzer: rust_analyzer: |i32, u64| -> i8
  • with_id: with_id: {closure#14352}, where that id is the unique number of the closure in r-a internals
  • hide: hide: Shows ... for every closure type
"impl_fn"

Type: null or one of “impl_fn”, “rust_analyzer”, “with_id”, “hide”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.maxLength

Maximum length for inlay hints. Set to null to have an unlimited length.

default:

25

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.renderColons

Whether to render leading colons for type hints, and trailing colons for parameter hints.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.bindingModeHints.enable

Whether to show inlay type hints for binding modes.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.chainingHints.enable

Whether to show inlay type hints for method chains.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.closingBraceHints.enable

Whether to show inlay hints after a closing } to indicate what item it belongs to.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.closingBraceHints.minLines

Minimum number of lines required before the } until the hint is shown (set to 0 or 1 to always show them).

default:

25

Type: null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.closureCaptureHints.enable

Whether to show inlay hints for closure captures.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.closureReturnTypeHints.enable

Whether to show inlay type hints for return types of closures.

Values:

  • always: Always show type hints for return types of closures.
  • never: Never show type hints for return types of closures.
  • with_block: Only show type hints for return types of closures with blocks.
"never"

Type: null or one of “always”, “never”, “with_block”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.discriminantHints.enable

Whether to show enum variant discriminant hints.

Values:

  • always: Always show all discriminant hints.
  • never: Never show discriminant hints.
  • fieldless: Only show discriminant hints on fieldless enum variants.
"never"

Type: null or one of “always”, “never”, “fieldless”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.enable

Whether to show inlay hints for type adjustments.

Values:

  • always: Always show all adjustment hints.
  • never: Never show adjustment hints.
  • reborrow: Only show auto borrow and dereference adjustment hints.
"never"

Type: null or one of “always”, “never”, “reborrow”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe

Whether to hide inlay hints for type adjustments outside of unsafe blocks.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.mode

Whether to show inlay hints as postfix ops (.* instead of *, etc).

Values:

  • prefix: Always show adjustment hints as prefix (*expr).
  • postfix: Always show adjustment hints as postfix (expr.*).
  • prefer_prefix: Show prefix or postfix depending on which uses less parenthesis, preferring prefix.
  • prefer_postfix: Show prefix or postfix depending on which uses less parenthesis, preferring postfix.
"prefix"

Type: null or one of “prefix”, “postfix”, “prefer_prefix”, “prefer_postfix”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.implicitDrops.enable

Whether to show implicit drop hints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.lifetimeElisionHints.enable

Whether to show inlay type hints for elided lifetimes in function signatures.

Values:

  • always: Always show lifetime elision hints.
  • never: Never show lifetime elision hints.
  • skip_trivial: Only show lifetime elision hints if a return type is involved.
"never"

Type: null or one of “always”, “never”, “skip_trivial”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.lifetimeElisionHints.useParameterNames

Whether to prefer using parameter names as the name for elided lifetime hints if possible.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.parameterHints.enable

Whether to show function parameter name inlay hints at the call site.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.rangeExclusiveHints.enable

Whether to show exclusive range inlay hints.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.reborrowHints.enable

Whether to show inlay hints for compiler inserted reborrows. This setting is deprecated in favor of #rust-analyzer.inlayHints.expressionAdjustmentHints.enable#.

Values:

  • always: Always show reborrow hints.
  • never: Never show reborrow hints.
  • mutable: Only show mutable reborrow hints.
"never"

Type: null or one of “always”, “never”, “mutable”

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.typeHints.enable

Whether to show inlay type hints for variables.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.typeHints.hideClosureInitialization

Whether to hide inlay type hints for let statements that initialize to a closure. Only applies to closures with blocks, same as #rust-analyzer.inlayHints.closureReturnTypeHints.enable#.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.inlayHints.typeHints.hideNamedConstructor

Whether to hide inlay type hints for constructors.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.interpret.tests

Enables the experimental support for interpreting tests.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.joinLines.joinAssignments

Join lines merges consecutive declaration and initialization of an assignment.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.joinLines.joinElseIf

Join lines inserts else between consecutive ifs.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.joinLines.removeTrailingComma

Join lines removes trailing commas.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.joinLines.unwrapTrivialBlock

Join lines unwraps trivial blocks.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.enable

Whether to show CodeLens in Rust files.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.forceCustomCommands

Internal config: use custom client-side commands even when the client doesn’t set the corresponding capability.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.location

Where to render annotations.

Values:

  • above_name: Render annotations above the name of the item.
  • above_whole_item: Render annotations above the whole item, including documentation comments and attributes.
"above_name"

Type: null or one of “above_name”, “above_whole_item”

Default: null

Declared by:

plugins.rust-tools.server.lens.debug.enable

Whether to show Debug lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.implementations.enable

Whether to show Implementations lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.references.adt.enable

Whether to show References lens for Struct, Enum, and Union. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.references.enumVariant.enable

Whether to show References lens for Enum Variants. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.references.method.enable

Whether to show Method References lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.references.trait.enable

Whether to show References lens for Trait. Only applies when #rust-analyzer.lens.enable# is set.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lens.run.enable

Whether to show Run lens. Only applies when #rust-analyzer.lens.enable# is set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.lru.capacity

Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.

default:

null

Type: null or null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.lru.query.capacities

Sets the LRU capacity of the specified queries.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.notifications.cargoTomlNotFound

Whether to show can't find Cargo.toml error message.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.notifications.unindexedProject

Whether to send an UnindexedProject notification to the client.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.procMacro.enable

Enable support for procedural macros, implies #rust-analyzer.cargo.buildScripts.enable#.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.procMacro.ignored

These proc-macros will be ignored when trying to expand them.

This config takes a map of crate names with the exported proc-macro names to ignore as values.

default:

{ }

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.rust-tools.server.procMacro.server

Internal config, path to proc-macro server executable.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.procMacro.attributes.enable

Expand attribute macros. Requires #rust-analyzer.procMacro.enable# to be set.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.references.excludeImports

Exclude imports from find-all-references.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.references.excludeTests

Exclude tests from find-all-references.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.runnables.command

Command to be executed instead of ‘cargo’ for runnables.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.runnables.extraArgs

Additional arguments to be passed to cargo for runnables such as tests or binaries. For example, it may be --release.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.runnables.extraTestBinaryArgs

Additional arguments to be passed through Cargo to launched tests, benchmarks, or doc-tests.

Unless the launched target uses a custom test harness, they will end up being interpreted as options to rustc’s built-in test harness (“libtest”).

default:

[
  "--show-output"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.rustc.source

Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or “discover” to try to automatically find it if the rustc-dev component is installed.

Any project which uses rust-analyzer with the rustcPrivate crates must set [package.metadata.rust-analyzer] rustc_private=true to use it.

This option does not take effect until rust-analyzer is restarted.

default:

null

Type: null or null or string

Default: null

Declared by:

plugins.rust-tools.server.rustfmt.extraArgs

Additional arguments to rustfmt.

default:

[ ]

Type: null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.rustfmt.overrideCommand

Advanced option, fully override the command rust-analyzer uses for formatting. This should be the equivalent of rustfmt here, and not that of cargo fmt. The file contents will be passed on the standard input and the formatted result will be read from the standard output.

default:

null

Type: null or null or (list of string)

Default: null

Declared by:

plugins.rust-tools.server.rustfmt.rangeFormatting.enable

Enables the use of rustfmt’s unstable range formatting command for the textDocument/rangeFormatting request. The rustfmt option is unstable and only available on a nightly build.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.nonStandardTokens

Whether the server is allowed to emit non-standard tokens and modifiers.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.doc.comment.inject.enable

Inject additional highlighting into doc comments.

When enabled, rust-analyzer will highlight rust source in doc comments as well as intra doc links.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.operator.enable

Use semantic tokens for operators.

When disabled, rust-analyzer will emit semantic tokens only for operator tokens when they are tagged with modifiers.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.operator.specialization.enable

Use specialized semantic tokens for operators.

When enabled, rust-analyzer will emit special token types for operator tokens instead of the generic operator token type.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.punctuation.enable

Use semantic tokens for punctuation.

When disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when they are tagged with modifiers or have a special role.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.punctuation.separate.macro.bang

When enabled, rust-analyzer will emit a punctuation semantic token for the ! of macro calls.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.punctuation.specialization.enable

Use specialized semantic tokens for punctuation.

When enabled, rust-analyzer will emit special token types for punctuation tokens instead of the generic punctuation token type.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.semanticHighlighting.strings.enable

Use semantic tokens for strings.

In some editors (e.g. vscode) semantic tokens override other highlighting grammars. By disabling semantic tokens for strings, other grammars can be used to highlight their contents.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.signatureInfo.detail

Show full signature of the callable. Only shows parameters if disabled.

Values:

  • full: Show the entire signature.
  • parameters: Show only the parameters.
"full"

Type: null or one of “full”, “parameters”

Default: null

Declared by:

plugins.rust-tools.server.signatureInfo.documentation.enable

Show documentation.

default:

true

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.typing.autoClosingAngleBrackets.enable

Whether to insert closing angle brackets when typing an opening angle bracket of a generic argument list.

default:

false

Type: null or boolean

Default: null

Declared by:

plugins.rust-tools.server.workspace.symbol.search.kind

Workspace symbol search kind.

Values:

  • only_types: Search for types only.
  • all_symbols: Search for all symbols kinds.
"only_types"

Type: null or one of “only_types”, “all_symbols”

Default: null

Declared by:

plugins.rust-tools.server.workspace.symbol.search.limit

Limits the number of items returned from a workspace symbol search (Defaults to 128). Some clients like vs-code issue new searches on result filtering and don’t require all results to be returned in the initial search. Other clients requires all results upfront and might require a higher limit.

default:

128

Type: null or signed integer

Default: null

Declared by:

plugins.rust-tools.server.workspace.symbol.search.scope

Workspace symbol search scope.

Values:

  • workspace: Search in current workspace only.
  • workspace_and_dependencies: Search in current workspace and dependencies.
"workspace"

Type: null or one of “workspace”, “workspace_and_dependencies”

Default: null

Declared by:

rustaceanvim

Url: https://github.com/mrcjkb/rustaceanvim/

Maintainers: Gaetan Lepage

plugins.rustaceanvim.enable

Whether to enable rustaceanvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.rustaceanvim.package

Which package to use for the rustaceanvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-rustaceanvim-4.22.8-1-unstable-2024-05-16>

Declared by:

plugins.rustaceanvim.rustAnalyzerPackage

Which package to use for rust-analyzer. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation rust-analyzer-2024-04-29>

Declared by:

plugins.rustaceanvim.settings

Options provided to the require('rustaceanvim').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  server = {
    cmd = [
      "rustup"
      "run"
      "nightly"
      "rust-analyzer"
    ];
    settings = {
      rust-analyzer = {
        check = {
          command = "clippy";
        };
        inlayHints = {
          lifetimeElisionHints = {
            enable = "always";
          };
        };
      };
    };
    standalone = false;
  };
}

Declared by:

plugins.rustaceanvim.settings.dap.adapter

Defaults to creating the rt_lldb adapter, which is a DapServerConfig if codelldb is detected, and a DapExecutableConfig if lldb is detected. Set to false to disable.

Type: null or lua function string or value false (singular enum) or (attribute set of anything)

Default: null

Declared by:

plugins.rustaceanvim.settings.dap.autoload_configurations

Whether to autoload nvim-dap configurations when rust-analyzer has attached.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.server.auto_attach

Whether to automatically attach the LSP client. Defaults to true if the rust-analyzer executable is found.

This can also be the definition of a function (fun():boolean).

Plugin default:

  function(bufnr)
    if #vim.bo[bufnr].buftype > 0 then
      return false
    end
    local path = vim.api.nvim_buf_get_name(bufnr)
    if not os.is_valid_file_path(path) then
      return false
    end
    local cmd = types.evaluate(RustaceanConfig.server.cmd)
    ---@cast cmd string[]
    local rs_bin = cmd[1]
    return vim.fn.executable(rs_bin) == 1
  end

Type: null or lua function string or boolean

Default: null

Declared by:

plugins.rustaceanvim.settings.server.cmd

Command and arguments for starting rust-analyzer.

This can also be the definition of a function: fun(project_root:string|nil,default_settings:table):table

Plugin default:

  function()
    return { 'rust-analyzer', '--log-file', RustaceanConfig.server.logfile }
  end

Type: null or lua function string or list of string

Default: null

Declared by:

plugins.rustaceanvim.settings.server.load_vscode_settings

Whether to search (upward from the buffer) for rust-analyzer settings in .vscode/settings json. If found, loaded settings will override configured options.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.server.logfile

The path to the rust-analyzer log file.

Plugin default: "{__raw = \"vim.fn.tempname() .. '-rust-analyzer.log'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.server.on_attach

Function to call on attach. If plugins.lsp is enabled, it defaults to the Nixvim global __lspOnAttach function. Otherwise it defaults to null.

Type: null or lua code string

Default: null

Declared by:

plugins.rustaceanvim.settings.server.settings

Setting passed to rust-analyzer. Defaults to a function that looks for a rust-analyzer.json file or returns an empty table. See https://rust-analyzer.github.io/manual.html#configuration.

This can also be the definition of a function: fun(project_root:string|nil, default_settings: table|nil):table

Plugin default:

  function(project_root, default_settings)
    return require('rustaceanvim.config.server').load_rust_analyzer_settings(project_root, { default_settings = default_settings })
  end

Type: null or lua function string or (submodule)

Default: null

Declared by:

plugins.rustaceanvim.settings.server.standalone

Standalone file support (enabled by default). Disabling it may improve rust-analyzer’s startup time.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.enable_clippy

Whether to enable clippy checks on save if a clippy installation is detected.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.enable_nextest

Whether to enable nextest. If enabled, cargo test commands will be transformed to cargo nextest run commands. Defaults to true if cargo-nextest is detected. Ignored if cargo_override is set.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.cargo_override

Set this to override the ‘cargo’ command for runnables, debuggables (etc., e.g. to "cross"). If set, this takes precedence over enable_nextest.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_test_executor

The executor to use for runnables that are crate test suites (--all-targets). Either a test executor alias or an attrs with the execute_command key.

Type: null or one of “termopen”, “quickfix”, “toggleterm”, “vimux”, “neotest”, “background” or (submodule)

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.executor

The executor to use for runnables/debuggables. Either an executor alias or an attrs with the execute_command key.

Plugin default: termopen

Type: null or one of “termopen”, “quickfix”, “toggleterm”, “vimux”, “neotest” or (submodule)

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.on_initialized

fun(health:RustAnalyzerInitializedStatus) Function that is invoked when the LSP server has finished initializing.

Type: null or lua code string

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.open_url

If set, overrides how to open URLs. fun(url:string):nil

Plugin default: require('rustaceanvim.os').open_url

Type: null or lua function string

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.reload_workspace_from_cargo_toml

Automatically call RustReloadWorkspace when writing to a Cargo.toml file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.test_executor

The executor to use for runnables that are tests/testables Either a test executor alias or an attrs with the execute_command key.

Type: null or one of “termopen”, “quickfix”, “toggleterm”, “vimux”, “neotest”, “background” or (submodule)

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.code_actions.group_icon

Text appended to a group action.

Plugin default: " ▶"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.code_actions.ui_select_fallback

Whether to fall back to vim.ui.select if there are no grouped code actions.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_graph.enabled_graphviz_backends

Override the enabled graphviz backends list, used for input validation and autocompletion.

Plugin default:

[
  "bmp" "cgimage" "canon" "dot" "gv" "xdot" "xdot1.2" "xdot1.4" "eps" "exr" "fig" "gd"
  "gd2" "gif" "gtk" "ico" "cmap" "ismap" "imap" "cmapx" "imap_np" "cmapx_np" "jpg"
  "jpeg" "jpe" "jp2" "json" "json0" "dot_json" "xdot_json" "pdf" "pic" "pct" "pict"
  "plain" "plain-ext" "png" "pov" "ps" "ps2" "psd" "sgi" "svg" "svgz" "tga" "tiff"
  "tif" "tk" "vml" "vmlz" "wbmp" "webp" "xlib" "x11"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_graph.backend

Backend used for displaying the graph. See: https://graphviz.org/docs/outputs

Plugin default: "x11"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_graph.full

true for all crates.io and external crates, false only the local crates.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_graph.output

Where to store the output. No output if unset. Relative path from cwd.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.crate_graph.pipe

Override the pipe symbol in the shell command. Useful if using a shell that is not supported by this plugin.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.float_win_config.auto_focus

Whether the window gets automatically focused.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.float_win_config.open_split

Whether splits opened from floating preview are vertical.

Plugin default: "horizontal"

Type: null or one of “horizontal”, “vertical” or raw lua code

Default: null

Declared by:

plugins.rustaceanvim.settings.tools.hover_actions.replace_builtin_hover

Whether to replace Neovim’s built-in vim.lsp.buf.hover with hover actions.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

sandwich

The settings option will not let you define the options starting with sandwich#. For those, you can directly use the globals option:

  globals."sandwich#magicchar#f#patterns" = [
    {
      header.__raw = "[[\<\%(\h\k*\.\)*\h\k*]]";
      bra = "(";
      ket = ")";
      footer = "";
    }
  ];

Url: https://github.com/machakann/vim-sandwich/

Maintainers: Gaetan Lepage

plugins.sandwich.enable

Whether to enable vim-sandwich.

Type: boolean

Default: false

Example: true

Declared by:

plugins.sandwich.package

Which package to use for the sandwich plugin.

Type: package

Default: <derivation vimplugin-vim-sandwich-2024-03-20>

Declared by:

plugins.sandwich.settings

The configuration options for sandwich without the sandwich_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal sandwich_foo_bar=1
  • hello = "world" -> :setglobal sandwich_hello="world"
  • some_toggle = true -> :setglobal sandwich_some_toggle
  • other_toggle = false -> :setglobal nosandwich_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  no_default_key_mappings = true;
  no_tex_ftplugin = true;
  no_vim_ftplugin = true;
}

Declared by:

plugins.sandwich.settings.no_default_key_mappings

Whether to disable the default mappings.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

schemastore

Url: https://github.com/b0o/SchemaStore.nvim/

Maintainers: Gaetan Lepage

plugins.schemastore.enable

Whether to enable SchemaStore.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.schemastore.package

Which package to use for the schemastore plugin.

Type: package

Default: <derivation vimplugin-SchemaStore.nvim-2024-05-14>

Declared by:

plugins.schemastore.json.enable

Whether to enable the json schemas in jsonls.

Type: boolean

Default: true

Example: false

Declared by:

plugins.schemastore.json.settings

Options supplied to the require('schemastore').json.schemas function.

Type: attribute set of anything

Default: { }

Example:

{
  extra = [
    {
      description = "My custom JSON schema";
      fileMatch = "foo.json";
      name = "foo.json";
      url = "https://example.com/schema/foo.json";
    }
    {
      description = "My other custom JSON schema";
      fileMatch = [
        "bar.json"
        ".baar.json"
      ];
      name = "bar.json";
      url = "https://example.com/schema/bar.json";
    }
  ];
  replace = {
    "package.json" = {
      description = "package.json overridden";
      fileMatch = [
        "package.json"
      ];
      name = "package.json";
      url = "https://example.com/package.json";
    };
  };
}

Declared by:

plugins.schemastore.json.settings.extra

Additional schemas to include.

Plugin default: [ ]

Type: null or (list of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.ignore

A list of strings representing the names of schemas to ignore. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.replace

An attrs of elements representing schemas to replace with a custom schema.

The string key is the name of the schema to replace, the table value is the schema definition. If a schema with the given name isn’t found, the custom schema will not be returned.

Plugin default: { }

Type: null or (attribute set of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.select

A list of strings representing the names of schemas to select. If this option is not present, all schemas are returned. If it is present, only the selected schemas are returned. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.schemastore.yaml.enable

Whether to enable the yaml schemas in yamlls.

Type: boolean

Default: true

Example: false

Declared by:

plugins.schemastore.yaml.settings

Options supplied to the require('schemastore').yaml.schemas function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.schemastore.yaml.settings.extra

Additional schemas to include.

Plugin default: [ ]

Type: null or (list of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.yaml.settings.ignore

A list of strings representing the names of schemas to ignore. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.schemastore.yaml.settings.replace

An attrs of elements representing schemas to replace with a custom schema.

The string key is the name of the schema to replace, the table value is the schema definition. If a schema with the given name isn’t found, the custom schema will not be returned.

Plugin default: { }

Type: null or (attribute set of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.yaml.settings.select

A list of strings representing the names of schemas to select. If this option is not present, all schemas are returned. If it is present, only the selected schemas are returned. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

sleuth

Url: https://github.com/tpope/vim-sleuth/

Maintainers: Gaetan Lepage

plugins.sleuth.enable

Whether to enable vim-sleuth.

Type: boolean

Default: false

Example: true

Declared by:

plugins.sleuth.package

Which package to use for the sleuth plugin.

Type: package

Default: <derivation vimplugin-vim-sleuth-2023-01-10>

Declared by:

plugins.sleuth.settings

The configuration options for sleuth without the sleuth_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal sleuth_foo_bar=1
  • hello = "world" -> :setglobal sleuth_hello="world"
  • some_toggle = true -> :setglobal sleuth_some_toggle
  • other_toggle = false -> :setglobal nosleuth_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  gitcommit_heuristics = false;
  heuristics = true;
  no_filetype_indent_on = true;
}

Declared by:

plugins.sleuth.settings.heuristics

Whether to enable/disable heuristics by default.

You can also disable heuristics for individual filetypes:

  settings = {
    heuristics = true;
    gitcommit_heuristics = false;
  };

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.sleuth.settings.no_filetype_indent_on

Sleuth forces |:filetype-indent-on| by default, which enables file-type specific indenting algorithms and is highly recommended.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

smart-splits

Url: https://github.com/mrjones2014/smart-splits.nvim/

Maintainers: Gabriel Arazas

plugins.smart-splits.enable

Whether to enable smart-splits.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.smart-splits.package

Which package to use for the smart-splits.nvim plugin.

Type: package

Default: <derivation vimplugin-smart-splits.nvim-2024-05-14>

Declared by:

plugins.smart-splits.settings

Options provided to the require('smart-splits').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  ignored_events = [
    "BufEnter"
    "WinEnter"
  ];
  resize_mode = {
    quit_key = "<ESC>";
    resize_keys = [
      "h"
      "j"
      "k"
      "l"
    ];
    silent = true;
  };
}

Declared by:

plugins.sniprun.enable

Whether to enable sniprun.

Type: boolean

Default: false

Example: true

Declared by:

plugins.sniprun.package

Which package to use for the sniprun plugin.

Type: package

Default: <derivation vimplugin-sniprun-1.3.13>

Declared by:

plugins.sniprun.borders

Defines the border to use for floating windows. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: single

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.sniprun.display

You can combo different display modes as desired and with the ‘Ok’ or ‘Err’ suffix to filter only successful runs (or errored-out runs respectively)

Example:

[
  "Classic"                    # display results in the command-line  area
  "VirtualTextOk"              # display ok results as virtual text (multiline is shortened)

  # "VirtualText"              # display results as virtual text
  # "TempFloatingWindow"       # display results in a floating window
  # "LongTempFloatingWindow"   # same as above, but only long results. To use with VirtualText[Ok/Err]
  # "Terminal"                 # display results in a vertical split
  # "TerminalWithCode"         # display results and code history in a vertical split
  # "NvimNotify"               # display with the nvim-notify plugin
  # "Api"                      # return output to a programming interface
]

Plugin default: ["Classic" "VirtualTextOk"]

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.sniprun.interpreterOptions

interpreter-specific options, see docs / :SnipInfo <name>

Plugin default: {}

Type: null or (attribute set)

Default: null

Declared by:

plugins.sniprun.liveDisplay

Display modes used in live_mode

Plugin default: ["VirtualTextOk"]

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.liveModeToggle

Live mode toggle, see Usage - Running for more info.

Plugin default: "off"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.replDisable

Disable REPL-like behavior for the given interpreters

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.replEnable

Enable REPL-like behavior for the given interpreters

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.selectedInterpreters

use those instead of the default for the current filetype

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.showNoOutput

You can use the same keys to customize whether a sniprun producing no output should display nothing or ‘(no output)’.

Plugin default: ["Classic" "TempFloatingWindow"]

Type: null or (list of string)

Default: null

Declared by:

plugins.sniprun.displayOptions.notificationTimeout

Timeout for nvim_notify output.

Plugin default: 5

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.sniprun.displayOptions.terminalWidth

Change the terminal display option width.

Plugin default: 45

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinErr.bg

Background color

Plugin default: "#881515"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinErr.ctermbg

Foreground color

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinErr.ctermfg

Foreground color

Plugin default: "DarkRed"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinErr.fg

Foreground color

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinOk.bg

Background color

Plugin default: "#66eeff"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinOk.ctermbg

Foreground color

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinOk.ctermfg

Foreground color

Plugin default: "Cyan"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunFloatingWinOk.fg

Foreground color

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextErr.bg

Background color

Plugin default: "#000000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextErr.ctermbg

Foreground color

Plugin default: "DarkRed"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextErr.ctermfg

Foreground color

Plugin default: "Black"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextErr.fg

Foreground color

Plugin default: "#881515"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextOk.bg

Background color

Plugin default: "#000000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextOk.ctermbg

Foreground color

Plugin default: "Cyan"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextOk.ctermfg

Foreground color

Plugin default: "Black"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.sniprun.snipruncolors.SniprunVirtualTextOk.fg

Foreground color

Plugin default: "#66eeff"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.specs.enable

Whether to enable specs-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.specs.package

Which package to use for the specs-nvim plugin.

Type: package

Default: <derivation vimplugin-specs.nvim-2022-09-20>

Declared by:

plugins.specs.blend

This option has no description.

Type: signed integer

Default: 10

Declared by:

plugins.specs.color

This option has no description.

Type: null or string

Default: null

Declared by:

plugins.specs.delay

Delay in milliseconds

Type: signed integer

Default: 0

Declared by:

plugins.specs.ignored_buffertypes

This option has no description.

Type: list of string

Default:

[
  "nofile"
]

Declared by:

plugins.specs.ignored_filetypes

This option has no description.

Type: list of string

Default: [ ]

Declared by:

plugins.specs.increment

Increment in milliseconds

Type: signed integer

Default: 10

Declared by:

plugins.specs.min_jump

This option has no description.

Type: signed integer

Default: 30

Declared by:

plugins.specs.show_jumps

This option has no description.

Type: boolean

Default: true

Declared by:

plugins.specs.width

This option has no description.

Type: signed integer

Default: 10

Declared by:

plugins.specs.fader

This option has no description.

Type: submodule

Default:

{
  builtin = "linear_fader";
}

Declared by:

plugins.specs.fader.builtin

This option has no description.

Type: null or one of “linear_fader”, “exp_fader”, “pulse_fader”, “empty_fader”

Default: "linear_fader"

Declared by:

plugins.specs.fader.custom

This option has no description.

Type: strings concatenated with “\n”

Default: ""

Example:

''
  function(blend, cnt)
    if cnt > 100 then
        return 80
    else return nil end
  end
''

Declared by:

plugins.specs.resizer

This option has no description.

Type: submodule

Default:

{
  builtin = "shrink_resizer";
}

Declared by:

plugins.specs.resizer.builtin

This option has no description.

Type: null or one of “shrink_resizer”, “slide_resizer”, “empty_resizer”

Default: "shrink_resizer"

Declared by:

plugins.specs.resizer.custom

This option has no description.

Type: strings concatenated with “\n”

Default: ""

Example:

''
  function(width, ccol, cnt)
      if width-cnt > 0 then
          return {width+cnt, ccol}
      else return nil end
  end
''

Declared by:

spectre

You may want to set the package for your find/replace tool(s) like shown below:

  plugins.spectre.findPackage = pkgs.rg;
  plugins.spectre.replacePackage = pkgs.gnused;

Url: https://github.com/nvim-pack/nvim-spectre/

Maintainers: Gaetan Lepage

plugins.spectre.enable

Whether to enable nvim-spectre.

Type: boolean

Default: false

Example: true

Declared by:

plugins.spectre.package

Which package to use for the nvim-spectre plugin.

Type: package

Default: <derivation vimplugin-nvim-spectre-2024-04-29>

Declared by:

plugins.spectre.findPackage

Which package to install for the find command. Defaults to pkgs.$\{settings.default.find.cmd}.

Set to null to prevent the installation.

Type: null or package

Default: null

Declared by:

plugins.spectre.replacePackage

Which package to install for the find command. Defaults to pkgs.$\{settings.default.replace.cmd}.

Set to null to prevent the installation.

Type: null or package

Default: null

Declared by:

plugins.spectre.settings

Options provided to the require('spectre').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  default = {
    find = {
      cmd = "rg";
      options = [
        "word"
        "hidden"
      ];
    };
    replace = {
      cmd = "sed";
    };
  };
  find_engine = {
    rg = {
      args = [
        "--color=never"
        "--no-heading"
        "--with-filename"
        "--line-number"
        "--column"
      ];
      cmd = "rg";
      options = {
        hidden = {
          desc = "hidden file";
          icon = "[H]";
          value = "--hidden";
        };
        ignore-case = {
          desc = "ignore case";
          icon = "[I]";
          value = "--ignore-case";
        };
        line = {
          desc = "match in line";
          icon = "[L]";
          value = "-x";
        };
        word = {
          desc = "match in word";
          icon = "[W]";
          value = "-w";
        };
      };
    };
  };
  is_insert_mode = false;
  live_update = true;
}

Declared by:

plugins.spectre.settings.color_devicons

Whether to enable color devicons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.highlight

Highlight groups.

Plugin default:

{
  headers = "SpectreHeader";
  ui = "SpectreBody";
  filename = "SpectreFile";
  filedirectory = "SpectreDir";
  search = "SpectreSearch";
  border = "SpectreBorder";
  replace = "SpectreReplace";
}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.is_block_ui_break

Mapping backspace and enter key to avoid ui break.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.is_insert_mode

Start open panel in insert mode.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.is_open_target_win

Open file on opener window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.line_sep

Line separator.

Plugin default: "└──────────────────────────────────────────────────────"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.line_sep_start

Start of the line separator

Plugin default: "┌──────────────────────────────────────────────────────"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.live_update

Auto execute search again when you write to any file in vim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.lnum_for_results

Show line number for search/replace results.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spectre.settings.open_cmd

The open command.

Plugin default: "vnew"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.replace_vim_cmd

The replace command to use within vim.

Plugin default: "cdo"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.result_padding

Result padding string.

Plugin default: "│ "

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.default.find.cmd

Which find engine to use. Pick one from the find_engine list.

Plugin default: "rg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.default.find.options

Options to use for this engine.

Plugin default: ["ignore-case"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.default.replace.cmd

Which find engine to use. Pick one from the replace_engine list.

Plugin default: "rg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.default.replace.options

Options to use for this engine.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.find_engine

Definition of the find engines.

default: see here

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.spectre.settings.find_engine.<name>.args

List of arguments to provide to the engine.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.find_engine.<name>.cmd

Executable to run.

Type: string

Declared by:

plugins.spectre.settings.find_engine.<name>.options

The options for this engine.

Plugin default: {}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.mapping

Keymaps declaration.

default: see here

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.spectre.settings.mapping.<name>.cmd

Command to run.

Type: string

Example: "<cmd>lua require('spectre').tab()<cr>"

Declared by:

plugins.spectre.settings.mapping.<name>.desc

Description for this mapping.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.spectre.settings.mapping.<name>.map

Keyboard shortcut.

Type: string

Declared by:

plugins.spectre.settings.replace_engine

Definition of the replace engines.

default: see here

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.spectre.settings.replace_engine.<name>.args

List of arguments to provide to the engine.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.spectre.settings.replace_engine.<name>.cmd

Executable to run.

Type: string

Declared by:

plugins.spectre.settings.replace_engine.<name>.options

The options for this engine.

Plugin default: {}

Type: null or (attribute set of ((submodule) or raw lua code))

Default: null

Declared by:

plugins.spider.enable

Whether to enable spider.

Type: boolean

Default: false

Example: true

Declared by:

plugins.spider.package

Which package to use for the spider plugin.

Type: package

Default: <derivation vimplugin-nvim-spider-2024-04-27>

Declared by:

plugins.spider.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.spider.skipInsignificantPunctuation

Whether to skip insignificant punctuation.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.spider.keymaps.motions

Mappings for spider motions. The keys are the motion and the values are the keyboard shortcuts. The shortcut might not necessarily be the same as the motion name.

Type: attribute set of string

Default: { }

Example:

{
  b = "b";
  e = "e";
  ge = "ge";
  w = "w";
}

Declared by:

plugins.spider.keymaps.silent

Whether spider keymaps should be silent.

Type: boolean

Default: false

Declared by:

startify

Url: https://github.com/mhinz/vim-startify/

Maintainers: Gaetan Lepage

plugins.startify.enable

Whether to enable vim-startify.

Type: boolean

Default: false

Example: true

Declared by:

plugins.startify.package

Which package to use for the startify plugin.

Type: package

Default: <derivation vimplugin-vim-startify-2023-09-20>

Declared by:

plugins.startify.settings

The configuration options for startify without the startify_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal startify_foo_bar=1
  • hello = "world" -> :setglobal startify_hello="world"
  • some_toggle = true -> :setglobal startify_some_toggle
  • other_toggle = false -> :setglobal nostartify_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  change_to_dir = false;
  custom_header = [
    ""
    "     ███╗   ██╗██╗██╗  ██╗██╗   ██╗██╗███╗   ███╗"
    "     ████╗  ██║██║╚██╗██╔╝██║   ██║██║████╗ ████║"
    "     ██╔██╗ ██║██║ ╚███╔╝ ██║   ██║██║██╔████╔██║"
    "     ██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║"
    "     ██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║"
    "     ╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝  ╚═══╝  ╚═╝╚═╝     ╚═╝"
  ];
  fortune_use_unicode = true;
}

Declared by:

plugins.startify.settings.enable_special

Show <empty buffer> and <quit>.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.enable_unsafe

Enable the option only in case you think Vim starts too slowly (because of :Startify) or if you often edit files on remote filesystems.

It’s called unsafe because it improves the time :Startify needs to execute by reducing the amount of syscalls to the underlying operating system, but sacrifices the precision of shown entries.

This could lead to inconsistences in the shown :Startify entries (e.g. the same file could be shown twice, because one time file was opened via absolute path and another time via symlink).

Currently this option does this:

  • don’t resolves symlinks (readlink(2))
  • don’t check every file if it’s readable (stat(2))
  • don’t filter through the bookmark list

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.bookmarks

A list of files or directories to bookmark. The list can contain two kinds of types. Either a path (str) or an attrs where the key is the custom index and the value is the path.

Plugin default: []

Type: null or (list of (string or raw lua code or (attribute set) or raw lua code))

Default: null

Declared by:

plugins.startify.settings.change_cmd

The default command for switching directories.

Valid values:

  • cd
  • lcd
  • tcd

Affects change_to_dir and change_to_vcs_root.

Plugin default: "lcd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startify.settings.change_to_dir

When opening a file or bookmark, change to its directory.

You want to disable this, if you’re using |'autochdir'| as well.

NOTE: It defaults to true, because that was already the behaviour at the time this option was introduced.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.change_to_vcs_root

When opening a file or bookmark, seek and change to the root directory of the VCS (if there is one).

At the moment only git, hg, bzr and svn are supported.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.commands

A list of commands to execute on selection. Leading colons are optional. It supports optional custom indices and/or command descriptions.

Example:

  [
    ":help reference"
    ["Vim Reference" "h ref"]
    {h = "h ref";}
    {m = ["My magical function" "call Magic()"];}
  ]

Plugin default: []

Type: null or (list of (string or attribute set of (string or list of string) or list of string or raw lua code))

Default: null

Declared by:

Same as the custom header, but shown at the bottom of the startify buffer.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Declared by:

plugins.startify.settings.custom_header

Define your own header.

This option takes a list of strings, whereas each string will be put on its own line. If it is a simple string, it should evaluate to a list of strings.

Example:

  [
    ""
    "     ███╗   ██╗██╗██╗  ██╗██╗   ██╗██╗███╗   ███╗"
    "     ████╗  ██║██║╚██╗██╔╝██║   ██║██║████╗ ████║"
    "     ██╔██╗ ██║██║ ╚███╔╝ ██║   ██║██║██╔████╔██║"
    "     ██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║"
    "     ██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║"
    "     ╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝  ╚═══╝  ╚═╝╚═╝     ╚═╝"
  ]

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Declared by:

plugins.startify.settings.custom_header_quotes

Example:

  [
    ["quote #1"]
    ["quote #2" "using" "three lines"]
  ]

Plugin default: []

Type: null or (list of ((list of string) or raw lua code))

Default: null

Declared by:

plugins.startify.settings.custom_indices

Use any list of strings as indices instead of increasing numbers. If there are more startify entries than actual items in the custom list, the remaining entries will be filled using the default numbering scheme starting from 0.

Thus you can create your own indexing scheme that fits your keyboard layout. You don’t want to leave the home row, do you?!

Example:

  ["f" "g" "h"]

Plugin default: []

Type: null or (list of string) or raw lua code

Default: null

Declared by:

plugins.startify.settings.disable_at_vimenter

Don’t run Startify at Vim startup. You can still call it anytime via :Startify.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.files_number

The number of files to list.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.startify.settings.fortune_use_unicode

By default, the fortune header uses ASCII characters, because they work for everyone. If you set this option to true and your ‘encoding’ is “utf-8”, Unicode box-drawing characters will be used instead.

This is not the default, because users of East Asian languages often set ‘ambiwidth’ to “double” or make their terminal emulator treat characters of ambiguous width as double width. Both would make the drawn box look funny.

For more information: http://unicode.org/reports/tr11

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.lists

Startify displays lists. Each list consists of a type and optionally a header and custom indices.

Default:

  [
    {
      type = "files";
      header = ["   MRU"];
    }
    {
      type = "dir";
      header = [{__raw = "'   MRU' .. vim.loop.cwd()";}];
    }
    {
      type = "sessions";
      header = ["   Sessions"];
    }
    {
      type = "bookmarks";
      header = ["   Bookmarks"];
    }
    {
      type = "commands";
      header = ["   Commands"];
    }
  ]

Type: list of (lua code string or (attribute set of anything))

Default: [ ]

Declared by:

plugins.startify.settings.padding_left

The number of spaces used for left padding.

Plugin default: 3

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.startify.settings.relative_path

If the file is in or below the current working directory, use a relative path. Otherwise an absolute path is used. The latter prevents hard to grasp entries like ../../../../../foo.

NOTE: This only applies to the “files” list, since the “dir” list is relative by nature.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_autoload

If this option is enabled and you start Vim in a directory that contains a Session.vim, that session will be loaded automatically. Otherwise it will be shown as the top entry in the Startify buffer.

The same happens when you |:cd| to a directory that contains a Session.vim and execute |:Startify|.

It also works if you open a bookmarked directory. See the bookmarks option.

This is great way to create a portable project folder!

NOTE: This option is affected by session_delete_buffers.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_before_save

This is a list of commands to be executed before saving a session.

Example: ["silent! tabdo NERDTreeClose"]

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.startify.settings.session_delete_buffers

Delete all buffers when loading or closing a session:

  • When using |startify-:SLoad|.
  • When using |startify-:SClose|.
  • When using session_autoload.
  • When choosing a session from the Startify buffer.

NOTE: Buffers with unsaved changes are silently ignored.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_dir

The directory to save/load sessions to/from.

Plugin default: "~/.vim/session"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_number

The maximum number of sessions to display. Makes the most sense together with session_sort.

Plugin default: 999

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_persistence

Automatically update sessions in two cases:

  • Before leaving Vim
  • Before loading a new session via :SLoad

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.session_remove_lines

Lines matching any of the patterns in this list, will be removed from the session file.

Example:

  ["setlocal" "winheight"]

Internally this simply does:

  • :global/setlocal/delete
  • :global/winheight/delete

So you can use any |pattern|.

NOTE: Take care not to mess up any expressions within the session file, otherwise you’ll probably get problems when trying to load it.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.startify.settings.session_savecmds

Include a list of cmdline commands which Vim will run upon loading the session.

Example:

  [
    "silent !pdfreader ~/latexproject/main.pdf &"
  ]

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.startify.settings.session_savevars

Include a list of variables in here which you would like Startify to save into the session file in addition to what Vim normally saves into the session file.

Example:

  [
   "g:startify_session_savevars"
   "g:startify_session_savecmds"
   "g:random_plugin_use_feature"
  ]

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.startify.settings.session_sort

Sort sessions by modification time (when the session files were written) rather than alphabetically.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.skiplist

A list of Vim regular expressions that is used to filter recently used files. See |pattern.txt| for what patterns can be used.

The following patterns are filtered by default:

  • 'runtime/doc/.*\.txt$'
  • 'bundle/.*/doc/.*\.txt$'
  • 'plugged/.*/doc/.*\.txt$'
  • '/.git/'
  • 'fugitiveblame$'
  • escape(fnamemodify(resolve($VIMRUNTIME), ':p'), '\') .'doc/.*\.txt$'

NOTE: Due to the nature of patterns, you can’t just use “~/mysecret” but have to use “$HOME .‘/mysecret.txt’”. The former would do something entirely different: |/\~|.

NOTE: When using backslashes as path separators, escape them. Otherwise using “C:\this\vim\path\is\problematic” would not match what you would expect, since |/\v| is a pattern, too.

Example:

  [
   "\.vimgolf"
   "^/tmp"
   "/project/.*/documentation"
  ]

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.startify.settings.skiplist_server

Do not create the startify buffer, if this is a Vim server instance with a name contained in this list.

Example: ["GVIM"]

Plugin default: []

Type: null or (list of (string or raw lua code or raw lua code))

Default: null

Declared by:

plugins.startify.settings.update_oldfiles

Usually |v:oldfiles| only gets updated when Vim exits. Using this option updates it on-the-fly, so that :Startify is always up-to-date.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startify.settings.use_env

Show environment variables in path, if their name is shorter than their value. See |startify-colors| for highlighting them.

$PWD and $OLDPWD are ignored.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.enable

Whether to enable startup.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.startup.package

Which package to use for the startup.nvim plugin.

Type: package

Default: <derivation vimplugin-startup.nvim-2023-12-20>

Declared by:

plugins.startup.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.startup.parts

List all sections in order.

Type: list of string

Default: [ ]

Example:

[
  "section_1"
  "section_2"
]

Declared by:

plugins.startup.theme

Use a pre-defined theme.

Plugin default: "dashboard"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.userMappings

Add your own mappings as key-command pairs.

Type: attribute set of string

Default: { }

Example:

{
  "<leader>ff" = "<cmd>Telescope find_files<CR>";
  "<leader>lg" = "<cmd>Telescope live_grep<CR>";
}

Declared by:

plugins.startup.colors.background

The background color.

Plugin default: "#1f2227"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.colors.foldedSection

The color of folded sections. This can also be changed with the StartupFoldedSection highlight group.

Plugin default: "#56b6c2"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.mappings.executeCommand

Keymapping to execute a command.

Plugin default: "<CR>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.mappings.openFile

Keymapping to open a file.

Plugin default: "o"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.mappings.openFileSplit

Keymapping to open a file in a split.

Plugin default: "<c-o>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.mappings.openHelp

Keymapping to open help.

Plugin default: "?"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.mappings.openSection

Keymapping to open a section.

Plugin default: "<TAB>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.options.after

A function that gets executed at the end.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.startup.options.cursorColumn

  • if < 1, fraction of screen width
  • if > 1 numbers of column

Plugin default: 0.5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or (positive integer, meaning >0)

Default: null

Declared by:

plugins.startup.options.disableStatuslines

Disable status-, buffer- and tablines.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.options.emptyLinesBetweenMappings

Add an empty line between mapping/commands.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.options.mappingKeys

Display mapping (e.g. <leader>ff).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.options.paddings

Amount of empty lines before each section (must be equal to amount of sections).

Plugin default: []

Type: null or (list of (unsigned integer, meaning >=0))

Default: null

Declared by:

plugins.startup.sections

Type: attribute set of (submodule)

Default: { }

Example:

{
  body = {
    align = "center";
    content = [
      [
        " Find File"
        "Telescope find_files"
        "<leader>ff"
      ]
      [
        "󰍉 Find Word"
        "Telescope live_grep"
        "<leader>lg"
      ]
      [
        " Recent Files"
        "Telescope oldfiles"
        "<leader>of"
      ]
      [
        " File Browser"
        "Telescope file_browser"
        "<leader>fb"
      ]
      [
        " Colorschemes"
        "Telescope colorscheme"
        "<leader>cs"
      ]
      [
        " New File"
        "lua require'startup'.new_file()"
        "<leader>nf"
      ]
    ];
    defaultColor = "";
    foldSection = true;
    highlight = "String";
    margin = 5;
    oldfilesAmount = 0;
    title = "Basic Commands";
    type = "mapping";
  };
  header = {
    align = "center";
    content = {
      __raw = "require('startup.headers').hydra_header";
    };
    defaultColor = "";
    foldSection = false;
    highlight = "Statement";
    margin = 5;
    oldfilesAmount = 0;
    title = "Header";
    type = "text";
  };
}

Declared by:

plugins.startup.sections.<name>.align

How to align the section.

Plugin default: "center"

Type: null or one of “center”, “left”, “right” or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.defaultColor

A hex color that gets used if you don’t specify highlight.

Plugin default: "#FF0000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.foldSection

Whether to fold or not.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.highlight

Highlight group in which the section text should be highlighted.

Type: null or string

Default: null

Declared by:

plugins.startup.sections.<name>.margin

The margin for left or right alignment.

  • if < 1 fraction of screen width
  • if > 1 numbers of column

Plugin default: 5

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or (positive integer, meaning >0)

Default: null

Declared by:

plugins.startup.sections.<name>.oldfilesAmount

The amount of oldfiles to be displayed.

Plugin default: 5

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.oldfilesDirectory

if the oldfiles of the current directory should be displayed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.title

Title for the folded section.

Plugin default: "title"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.startup.sections.<name>.type

  • “text” -> text that will be displayed
  • “mapping” -> create mappings for commands that can be used. use mappings.executeCommand on the commands to execute.
  • “oldfiles” -> display oldfiles (can be opened with mappings.openFile/openFileSplit)

Plugin default: "text"

Type: null or one of “text”, “mapping”, “oldfiles” or raw lua code

Default: null

Declared by:

statuscol

Url: https://github.com/luukvbaal/statuscol.nvim/

Maintainers: Gaetan Lepage

plugins.statuscol.enable

Whether to enable statuscol.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.statuscol.package

Which package to use for the statuscol.nvim plugin.

Type: package

Default: <derivation vimplugin-statuscol.nvim-2024-04-19>

Declared by:

plugins.statuscol.settings

Options provided to the require('statuscol').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  bt_ignore = null;
  clickhandlers = {
    FoldClose = "require('statuscol.builtin').foldclose_click";
    FoldOpen = "require('statuscol.builtin').foldopen_click";
    FoldOther = "require('statuscol.builtin').foldother_click";
    Lnum = "require('statuscol.builtin').lnum_click";
  };
  clickmod = "c";
  ft_ignore = null;
  relculright = true;
  segments = [
    {
      click = "v:lua.ScFa";
      text = [
        "%C"
      ];
    }
    {
      click = "v:lua.ScSa";
      text = [
        "%s"
      ];
    }
    {
      click = "v:lua.ScLa";
      condition = [
        true
        {
          __raw = "require('statuscol.builtin').not_empty";
        }
      ];
      text = [
        {
          __raw = "require('statuscol.builtin').lnumfunc";
        }
        " "
      ];
    }
  ];
  setopt = true;
  thousands = ".";
}

Declared by:

plugins.statuscol.settings.bt_ignore

Lua table with ‘buftype’ values for which statuscolumn will be unset.

Plugin default: null

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.statuscol.settings.clickhandlers

Builtin click handlers.

Type: attribute set of lua function string

Default: { }

Example:

{
  FoldClose = "require('statuscol.builtin').foldclose_click";
  FoldOpen = "require('statuscol.builtin').foldopen_click";
  FoldOther = "require('statuscol.builtin').foldother_click";
  Lnum = "require('statuscol.builtin').lnum_click";
}

Declared by:

plugins.statuscol.settings.clickmod

Modifier used for certain actions in the builtin clickhandlers: a for Alt, c for Ctrl and m for Meta.

Plugin default: "c"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.statuscol.settings.ft_ignore

Lua table with ‘filetype’ values for which statuscolumn will be unset.

Plugin default: null

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.statuscol.settings.relculright

Whether to right-align the cursor line number with relativenumber set.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.statuscol.settings.segments

The statuscolumn can be customized through the segments option.

Plugin default:

[
  {
    text = ["%C"];
    click = "v:lua.ScFa";
  }
  {
    text = ["%s"];
    click = "v:lua.ScSa";
  }
  {
    text = [
      {__raw = "require('statuscol.builtin').lnumfunc";}
      " "
    ];
    condition = [
      true
      {__raw = "require('statuscol.builtin').not_empty";}
    ];
    click = "v:lua.ScLa";
  }
]

Type: null or (list of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.statuscol.settings.setopt

Whether to set the statuscolumn option, may be set to false for those who want to use the click handlers in their own statuscolumn: _G.Sc[SFL]a(). Although I recommend just using the segments field below to build your statuscolumn to benefit from the performance optimizations in this plugin.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.statuscol.settings.thousands

false or line number thousands separator string (“.” / “,”).

Plugin default: false

Type: null or string or value false (singular enum)

Default: null

Declared by:

surround

Url: https://github.com/tpope/vim-surround/

Maintainers: Gaetan Lepage

plugins.surround.enable

Whether to enable surround.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.surround.package

Which package to use for the surround plugin.

Type: package

Default: <derivation vimplugin-vim-surround-2022-10-25>

Declared by:

tagbar

Url: https://github.com/preservim/tagbar/

Maintainers: Gaetan Lepage

plugins.tagbar.enable

Whether to enable tagbar.

Type: boolean

Default: false

Example: true

Declared by:

plugins.tagbar.package

Which package to use for the tagbar plugin.

Type: package

Default: <derivation vimplugin-tagbar-2024-01-26>

Declared by:

plugins.tagbar.settings

The configuration options for tagbar without the tagbar_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal tagbar_foo_bar=1
  • hello = "world" -> :setglobal tagbar_hello="world"
  • some_toggle = true -> :setglobal tagbar_some_toggle
  • other_toggle = false -> :setglobal notagbar_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  autoclose = false;
  autofocus = false;
  autoshowtag = true;
  foldlevel = 2;
  iconchars = [
    ""
    ""
  ];
  position = "right";
  visibility_symbols = {
    private = "󰛑 ";
    protected = "󱗤 ";
    public = "󰡭 ";
  };
}

Declared by:

telescope

Url: https://github.com/nvim-telescope/telescope.nvim/

Maintainers: Gaetan Lepage

plugins.telescope.enable

Whether to enable telescope.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.enabledExtensions

A list of enabled extensions.

You should only use this option directly if the Telescope extension you wish to enable is not natively supported by nixvim.

Most extensions are available as plugins.telescope.extensions.<name>.enable, although some plugins that do more than just provide Telescope extensions may use plugins.<name>.enableTelescope instead.

If you add an extension to this list manually, it is your responsibility to ensure the relevant plugin is also added to extraPackages.

Type: list of string

Default: [ ]

Declared by:

plugins.telescope.package

Which package to use for the telescope.nvim plugin.

Type: package

Default: <derivation vimplugin-lua5.1-telescope.nvim-scm-1-unstable-2024-05-16>

Declared by:

plugins.telescope.highlightTheme

The colorscheme to use for syntax highlighting

Type: null or string

Default: null

Declared by:

plugins.telescope.keymaps

Keymaps for telescope.

Type: attribute set of (string or (submodule))

Default: { }

Example:

{
  "<C-p>" = {
    action = "git_files";
    options = {
      desc = "Telescope Git Files";
    };
  };
  "<leader>fg" = "live_grep";
}

Declared by:

plugins.telescope.extensions.file-browser.enable

Whether to enable the file-browser telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.file-browser.package

Which package to use for the file-browser plugin.

Type: package

Default: <derivation vimplugin-telescope-file-browser.nvim-2024-04-23>

Declared by:

plugins.telescope.extensions.file-browser.settings

settings for the file-browser telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  file_browser = {
    hijack_netrw = true;
    theme = "ivy";
  };
}

Declared by:

plugins.telescope.extensions.file-browser.settings.add_dirs

Whether the file browser shows folders.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.auto_depth

Unlimit or set depth to auto_depth & unset grouped on prompt for file_browser.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.browse_files

A custom lua function to override for the file browser.

Plugin default: require('telescope._extensions.file_browser.finders').browse_files

Type: null or lua function string

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.browse_folders

A custom lua function to override for the folder browser.

Plugin default: require('telescope._extensions.file_browser.finders').browse_folders

Type: null or lua function string

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.collapse_dirs

Skip with only a single (possibly hidden) sub-dir in file_browser.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.cwd

Directory to browse folders from. vim.fn.expanded automatically.

Plugin default: "{__raw = \"vim.loop.cwd()\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.cwd_to_path

Whether folder browser is launched from path rather than cwd.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.depth

File tree depth to display, false for unlimited depth.

Plugin default: 1

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.dir_icon

Change the icon for a directory.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.dir_icon_hl

Change the highlight group of dir icon.

Plugin default: "Default"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.display_stat

Ordered stat; see upstream for more info.

Plugin default:

{
  date = true;
  size = true;
  mode = true;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.files

Start in file (true) or folder (false) browser.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.git_status

Show the git status of files (true if git is found).

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.grouped

Group initial sorting by directories and then files.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.hidden

Determines whether to show hidden files or not.

Plugin default:

{
  file_browser = false;
  folder_browser = false;
}

Type: null or boolean or (submodule)

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.hide_parent_dir

Hide ../ in the file browser.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.hijack_netrw

Use telescope file browser when opening directory paths.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.path

Directory to browse files from. vim.fn.expanded automatically.

Plugin default: "{__raw = \"vim.loop.cwd()\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.prompt_path

Show the current relative path from cwd as the prompt prefix.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.quiet

Suppress any notification from file_browser actions.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.respect_gitignore

Induces slow-down w/ plenary finder (true if fd available).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.select_buffer

Select current buffer if possible. May imply hidden=true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.theme

Custom theme, will use your global theme by default.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.use_fd

Use fd if available over plenary.scandir.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.mappings.i

Keymaps in insert mode.

Default:

  {
  "<A-c>" = "require('telescope._extensions.file_browser.actions').create";
  "<S-CR>" = "require('telescope._extensions.file_browser.actions').create_from_prompt";
  "<A-r>" = "require('telescope._extensions.file_browser.actions').rename";
  "<A-m>" = "require('telescope._extensions.file_browser.actions').move";
  "<A-y>" = "require('telescope._extensions.file_browser.actions').copy";
  "<A-d>" = "require('telescope._extensions.file_browser.actions').remove";
  "<C-o>" = "require('telescope._extensions.file_browser.actions').open";
  "<C-g>" = "require('telescope._extensions.file_browser.actions').goto_parent_dir";
  "<C-e>" = "require('telescope._extensions.file_browser.actions').goto_home_dir";
  "<C-w>" = "require('telescope._extensions.file_browser.actions').goto_cwd";
  "<C-t>" = "require('telescope._extensions.file_browser.actions').change_cwd";
  "<C-f>" = "require('telescope._extensions.file_browser.actions').toggle_browser";
  "<C-h>" = "require('telescope._extensions.file_browser.actions').toggle_hidden";
  "<C-s>" = "require('telescope._extensions.file_browser.actions').toggle_all";
  "<bs>" = "require('telescope._extensions.file_browser.actions').backspace";
}

Type: attribute set of lua function string

Default: { }

Declared by:

plugins.telescope.extensions.file-browser.settings.mappings.n

Keymaps in normal mode.

Default:

  {
  "c" = "require('telescope._extensions.file_browser.actions').create";
  "r" = "require('telescope._extensions.file_browser.actions').rename";
  "m" = "require('telescope._extensions.file_browser.actions').move";
  "y" = "require('telescope._extensions.file_browser.actions').copy";
  "d" = "require('telescope._extensions.file_browser.actions').remove";
  "o" = "require('telescope._extensions.file_browser.actions').open";
  "g" = "require('telescope._extensions.file_browser.actions').goto_parent_dir";
  "e" = "require('telescope._extensions.file_browser.actions').goto_home_dir";
  "w" = "require('telescope._extensions.file_browser.actions').goto_cwd";
  "t" = "require('telescope._extensions.file_browser.actions').change_cwd";
  "f" = "require('telescope._extensions.file_browser.actions').toggle_browser";
  "h" = "require('telescope._extensions.file_browser.actions').toggle_hidden";
  "s" = "require('telescope._extensions.file_browser.actions').toggle_all";
}

Type: attribute set of lua function string

Default: { }

Declared by:

plugins.telescope.extensions.frecency.enable

Whether to enable the frecency telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.frecency.package

Which package to use for the frecency plugin.

Type: package

Default: <derivation vimplugin-telescope-frecency.nvim-2024-05-01>

Declared by:

plugins.telescope.extensions.frecency.settings

settings for the frecency telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  db_root = "/home/my_username/path/to/db_root";
  disable_devicons = false;
  ignore_patterns = [
    "*.git/*"
    "*/tmp/*"
  ];
  show_scores = false;
  show_unindexed = true;
  workspaces = {
    conf = "/home/my_username/.config";
    data = "/home/my_username/.local/share";
    project = "/home/my_username/projects";
    wiki = "/home/my_username/wiki";
  };
}

Declared by:

plugins.telescope.extensions.frecency.settings.auto_validate

If true, it removes stale entries count over than db_validate_threshold.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.db_root

Path to parent directory of custom database location. Defaults to $XDG_DATA_HOME/nvim if unset.

Plugin default: "{__raw = \"vim.fn.stdpath 'data'\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.db_safe_mode

If true, it shows confirmation dialog by vim.ui.select() before validating DB.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.db_validate_threshold

It will removes over than this count in validating DB.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.default_workspace

Default workspace tag to filter by e.g. 'CWD' to filter by default to the current directory. Can be overridden at query time by specifying another filter like ':*:'.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.disable_devicons

Disable devicons (if available).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.filter_delimiter

Delimiters to indicate the filter like :CWD:.

Plugin default: ":"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.hide_current_buffer

If true, it does not show the current buffer in candidates.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.ignore_patterns

Patterns in this table control which files are indexed (and subsequently which you’ll see in the finder results).

Plugin default:

[
  "*.git/*"
  "*/tmp/*"
  "term://*"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.max_timestamps

Set the max count of timestamps DB keeps when you open files. It ignores the value and use 10 if you set less than or equal to 0.

CAUTION: When you reduce the value of this option, it removes old timestamps when you open the file. It is reasonable to set this value more than or equal to the default value: 10.

Plugin default: 10

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.show_filter_column

Show the path of the active filter before file paths. In default, it uses the tail of paths for 'LSP' and 'CWD' tags. You can configure this by setting a table for this option.

Plugin default: true

Type: null or boolean or list of string

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.show_scores

To see the scores generated by the algorithm in the results, set this to true.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.show_unindexed

Determines if non-indexed files are included in workspace filter results.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.workspace_scan_cmd

This option can be set values as "LUA"|string[]|null. With the default value: null, it uses these way below to make entries for workspace files. It tries in order until it works successfully.

  1. rg -.g '!.git' --files
  2. fdfind -Htf
  3. fd -Htf
  4. Native Lua code (old way)

If you like another commands, set them to this option, like

  workspace_scan_cmd = ["find" "." "-type" "f"];

If you prefer Native Lua code, set workspace_scan_cmd.__raw = "LUA".

Type: null or raw lua code or list of string

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.workspaces

This attrs contains mappings of workspace_tag -> workspace_directory. The key corresponds to the :tag_name used to select the filter in queries. The value corresponds to the top level directory by which results will be filtered.

Plugin default: {}

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.telescope.extensions.fzf-native.enable

Whether to enable the fzf-native telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.fzf-native.package

Which package to use for the fzf-native plugin.

Type: package

Default: <derivation vimplugin-telescope-fzf-native.nvim-2024-03-05>

Declared by:

plugins.telescope.extensions.fzf-native.settings

settings for the fzf-native telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  case_mode = "ignore_case";
  fuzzy = false;
  override_file_sorter = false;
  override_generic_sorter = true;
}

Declared by:

plugins.telescope.extensions.fzf-native.settings.case_mode

Case mode.

Plugin default: "smart_case"

Type: null or one of “smart_case”, “ignore_case”, “respect_case” or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.fzf-native.settings.fuzzy

Whether to fuzzy search. False will do exact matching.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.fzf-native.settings.override_file_sorter

Override the file sorter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.fzf-native.settings.override_generic_sorter

Override the generic sorter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.fzy-native.enable

Whether to enable the fzy-native telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.fzy-native.package

Which package to use for the fzy-native plugin.

Type: package

Default: <derivation vimplugin-telescope-fzy-native.nvim-2022-09-11>

Declared by:

plugins.telescope.extensions.fzy-native.settings

settings for the fzy-native telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  override_file_sorter = true;
  override_generic_sorter = false;
}

Declared by:

plugins.telescope.extensions.fzy-native.settings.override_file_sorter

Whether to override the file sorter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.fzy-native.settings.override_generic_sorter

Whether to override the generic sorter.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.media-files.enable

Whether to enable the media-files telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.media-files.package

Which package to use for the media-files plugin.

Type: package

Default: <derivation vimplugin-telescope-media-files.nvim-2023-02-19>

Declared by:

plugins.telescope.extensions.media-files.dependencies.chafa.enable

Whether to install the chafa dependency. Required for image support.

Type: boolean

Default: true

Declared by:

plugins.telescope.extensions.media-files.dependencies.chafa.package

The package to use for the chafa dependency.

Type: package

Default: <derivation chafa-1.14.0>

Declared by:

plugins.telescope.extensions.media-files.dependencies.epub-thumbnailer.enable

Whether to install the epub-thumbnailer dependency. Required for epub preview support

Type: boolean

Default: false

Declared by:

plugins.telescope.extensions.media-files.dependencies.epub-thumbnailer.package

The package to use for the epub-thumbnailer dependency.

Type: package

Default: <derivation epub-thumbnailer-0-unstable-2024-03-26>

Declared by:

plugins.telescope.extensions.media-files.dependencies.ffmpegthumbnailer.enable

Whether to install the ffmpegthumbnailer dependency. Required for video preview support.

Type: boolean

Default: false

Declared by:

plugins.telescope.extensions.media-files.dependencies.ffmpegthumbnailer.package

The package to use for the ffmpegthumbnailer dependency.

Type: package

Default: <derivation ffmpegthumbnailer-unstable-2024-01-04>

Declared by:

plugins.telescope.extensions.media-files.dependencies.fontpreview.enable

Whether to install the fontpreview dependency. Required for font preview support.

Type: boolean

Default: false

Declared by:

plugins.telescope.extensions.media-files.dependencies.fontpreview.package

The package to use for the fontpreview dependency.

Type: package

Default: <derivation fontpreview-1.0.6>

Declared by:

plugins.telescope.extensions.media-files.dependencies.imageMagick.enable

Whether to install the ImageMagick dependency. Required for svg previews.

Type: boolean

Default: false

Declared by:

plugins.telescope.extensions.media-files.dependencies.imageMagick.package

The package to use for the ImageMagick dependency.

Type: package

Default: <derivation imagemagick-7.1.1-32>

Declared by:

plugins.telescope.extensions.media-files.dependencies.pdftoppm.enable

Whether to install the pdmtoppm dependency. Required for pdf preview support.

Type: boolean

Default: false

Declared by:

plugins.telescope.extensions.media-files.dependencies.pdftoppm.package

The package to use for the pdmtoppm dependency.

Type: package

Default: <derivation poppler-utils-24.02.0>

Declared by:

plugins.telescope.extensions.media-files.settings

settings for the media-files telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  filetypes = [
    "png"
    "webp"
    "jpg"
    "jpeg"
  ];
  find_cmd = "rg";
}

Declared by:

plugins.telescope.extensions.media-files.settings.filetypes

Filetypes whitelist.

Plugin default:

[
  "png"
  "jpg"
  "gif"
  "mp4"
  "webm"
  "pdf"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.telescope.extensions.media-files.settings.find_cmd

Which find command to use.

Plugin default: "fd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.ui-select.enable

Whether to enable the ui-select telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.ui-select.package

Which package to use for the ui-select plugin.

Type: package

Default: <derivation vimplugin-telescope-ui-select.nvim-2023-12-04>

Declared by:

plugins.telescope.extensions.ui-select.settings

settings for the ui-select telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  specific_opts = {
    codeactions = false;
  };
}

Declared by:

plugins.telescope.extensions.undo.enable

Whether to enable the undo telescope extension.

Type: boolean

Default: false

Example: true

Declared by:

plugins.telescope.extensions.undo.package

Which package to use for the undo plugin.

Type: package

Default: <derivation vimplugin-telescope-undo.nvim-2024-05-01>

Declared by:

plugins.telescope.extensions.undo.settings

settings for the undo telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  diff_context_lines = 8;
  entry_format = "state #$ID";
  mappings = {
    i = {
      "<c-cr>" = "require('telescope-undo.actions').restore";
      "<cr>" = "require('telescope-undo.actions').yank_additions";
      "<s-cr>" = "require('telescope-undo.actions').yank_deletions";
    };
    n = {
      Y = "require('telescope-undo.actions').yank_deletions";
      u = "require('telescope-undo.actions').restore";
      y = "require('telescope-undo.actions').yank_additions";
    };
  };
  side_by_side = true;
  time_format = "!%Y-%m-%dT%TZ";
  use_custom_command = [
    "bash"
    "-c"
    "echo '$DIFF' | delta"
  ];
  use_delta = true;
}

Declared by:

plugins.telescope.extensions.undo.settings.diff_context_lines

Defaults to the scrolloff.

Plugin default: vim.o.scrolloff

Type: null or lua code string or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.entry_format

The format to show on telescope for the different versions of the file.

Plugin default: "state #$ID, $STAT, $TIME"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.side_by_side

If set to true tells delta to render diffs side-by-side. Thus, requires delta to be used. Be aware that delta always uses its own configuration, so it might be that you’re getting the side-by-side view even if this is set to false.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.time_format

Can be set to a Lua date format string.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.use_custom_command

Should be in this format: [ "bash" "-c" "echo '$DIFF' | delta" ]

Type: null or (list of string)

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.use_delta

When set to true, delta is used for fancy diffs in the preview section. If set to false, telescope-undo will not use delta even when available and fall back to a plain diff with treesitter highlights.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.undo.settings.mappings.i

Keymaps in insert mode.

Default:

  {
  "<cr>" = "require('telescope-undo.actions').yank_additions";
  "<s-cr>" = "require('telescope-undo.actions').yank_deletions";
  "<c-cr>" = "require('telescope-undo.actions').restore";
}

Type: attribute set of lua function string

Default: { }

Declared by:

plugins.telescope.extensions.undo.settings.mappings.n

Keymaps in normal mode.

Default:

  {
  "y" = "require('telescope-undo.actions').yank_additions";
  "Y" = "require('telescope-undo.actions').yank_deletions";
  "u" = "require('telescope-undo.actions').restore";
}

Type: attribute set of lua function string

Default: { }

Declared by:

plugins.telescope.settings

Options provided to the require('telescope').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  defaults = {
    file_ignore_patterns = [
      "^.git/"
      "^.mypy_cache/"
      "^__pycache__/"
      "^output/"
      "^data/"
      "%.ipynb"
    ];
    layout_config = {
      prompt_position = "top";
    };
    mappings = {
      i = {
        "<A-j>" = {
          __raw = "require('telescope.actions').move_selection_next";
        };
        "<A-k>" = {
          __raw = "require('telescope.actions').move_selection_previous";
        };
      };
    };
    selection_caret = "> ";
    set_env = {
      COLORTERM = "truecolor";
    };
    sorting_strategy = "ascending";
  };
}

Declared by:

plugins.telescope.settings.defaults

Default configuration for telescope.

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.telescope.settings.pickers

Default configuration for builtin pickers.

Type: null or (attribute set of anything)

Default: null

Declared by:

texpresso

Url: https://github.com/let-def/texpresso.vim/

Maintainers: Nick Hu

plugins.texpresso.enable

Whether to enable texpresso.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.texpresso.package

Which package to use for the texpresso plugin.

Type: package

Default: <derivation vimplugin-texpresso.vim-2024-04-30>

Declared by:

plugins.texpresso.texpressoPackage

Which package to use for texpresso. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation texpresso-0-unstable-2024-05-09>

Declared by:

tmux-navigator

When combined with a set of tmux key bindings, the plugin will allow you to navigate seamlessly between vim splits and tmux panes using a consistent set of hotkeys.

WARNING: to work correctly, you must configure tmux separately.

Usage

This plugin provides the following mappings which allow you to move between vim splits and tmux panes seamlessly.

  • <ctrl-h> => Left
  • <ctrl-j> => Down
  • <ctrl-k> => Up
  • <ctrl-l> => Right
  • <ctrl-\> => Previous split

To use alternative key mappings, see plugins.tmux-navigator.settings.no_mappings.

Configure tmux

There are two main ways to configure tmux. Either install the tmuxPlugins.vim-tmux-navigator plugin or add a snippet to your tmux config:

  # Smart pane switching with awareness of vim splits.
  # See: https://github.com/christoomey/vim-tmux-navigator
  is_vim="ps -o state= -o comm= -t '#{pane_tty}' \
    | grep -iqE '^[^TXZ ]+ +(\\S+\\/)?g?(view|l?n?vim?x?|fzf)(diff)?$'"

  bind-key -n 'C-h' if-shell "$is_vim" 'send-keys C-h'  'select-pane -L'
  bind-key -n 'C-j' if-shell "$is_vim" 'send-keys C-j'  'select-pane -D'
  bind-key -n 'C-k' if-shell "$is_vim" 'send-keys C-k'  'select-pane -U'
  bind-key -n 'C-l' if-shell "$is_vim" 'send-keys C-l'  'select-pane -R'

  # Forwarding <C-\\> needs different syntax, depending on tmux version
  tmux_version='$(tmux -V | sed -En "s/^tmux ([0-9]+(.[0-9]+)?).*/\1/p")'
  if-shell -b '[ "$(echo "$tmux_version < 3.0" | bc)" = 1 ]' \
    "bind-key -n 'C-\\' if-shell \"$is_vim\" 'send-keys C-\\'  'select-pane -l'"
  if-shell -b '[ "$(echo "$tmux_version >= 3.0" | bc)" = 1 ]' \
    "bind-key -n 'C-\\' if-shell \"$is_vim\" 'send-keys C-\\\\'  'select-pane -l'"

  bind-key -T copy-mode-vi 'C-h' select-pane -L
  bind-key -T copy-mode-vi 'C-j' select-pane -D
  bind-key -T copy-mode-vi 'C-k' select-pane -U
  bind-key -T copy-mode-vi 'C-l' select-pane -R
  bind-key -T copy-mode-vi 'C-\' select-pane -l

See the upstream docs for more info.

Url: https://github.com/christoomey/vim-tmux-navigator/

Maintainers: Matt Sturgeon

plugins.tmux-navigator.enable

Whether to enable vim-tmux-navigator.

Type: boolean

Default: false

Example: true

Declared by:

plugins.tmux-navigator.package

Which package to use for the tmux-navigator plugin.

Type: package

Default: <derivation vimplugin-vim-tmux-navigator-2024-04-13>

Declared by:

plugins.tmux-navigator.settings

The configuration options for tmux-navigator without the tmux_navigator_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal tmux_navigator_foo_bar=1
  • hello = "world" -> :setglobal tmux_navigator_hello="world"
  • some_toggle = true -> :setglobal tmux_navigator_some_toggle
  • other_toggle = false -> :setglobal notmux_navigator_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.tmux-navigator.settings.disable_when_zoomed

By default, if you zoom the tmux pane running vim and then attempt to navigate “past” the edge of the vim session, tmux will unzoom the pane. This is the default tmux behavior, but may be confusing if you’ve become accustomed to navigation “wrapping” around the sides due to this plugin.

This option disables the unzooming behavior, keeping all navigation within vim until the tmux pane is explicitly unzoomed.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.tmux-navigator.settings.no_mappings

By default <C-h>, <C-j>, <C-k>, <C-l>, & <C-\\> are mapped to navigating left, down, up, right, & previous, respectively.

This option disables those default mappings being created.

You can use the plugin’s five commands to define your own custom mappings:

  keymaps = [
    {
      key = "<C-w>h";
      action = "<cmd>TmuxNavigateLeft<cr>";
    }
    {
      key = "<C-w>j";
      action = "<cmd>TmuxNavigateDown<cr>";
    }
    {
      key = "<C-w>k";
      action = "<cmd>TmuxNavigateUp<cr>";
    }
    {
      key = "<C-w>l";
      action = "<cmd>TmuxNavigateRight<cr>";
    }
    {
      key = "<C-w>\\";
      action = "<cmd>TmuxNavigatePrevious<cr>";
    }
  ];

You will also need to update your tmux bindings to match.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.tmux-navigator.settings.no_wrap

By default, if you try to move past the edge of the screen, tmux/vim will “wrap” around to the opposite side.

This option disables “wrapping” in vim, but tmux will need to be configured separately.

Tmux doesn’t have a “no_wrap” option, so whatever key bindings you have need to conditionally wrap based on position on screen:

  is_vim="ps -o state= -o comm= -t '#{pane_tty}' \
    | grep -iqE '^[^TXZ ]+ +(\\S+\\/)?g?(view|l?n?vim?x?|fzf)(diff)?$'"

  bind-key -n 'C-h' if-shell "$is_vim" { send-keys C-h } { if-shell -F '#{pane_at_left}'   {} { select-pane -L } }
  bind-key -n 'C-j' if-shell "$is_vim" { send-keys C-j } { if-shell -F '#{pane_at_bottom}' {} { select-pane -D } }
  bind-key -n 'C-k' if-shell "$is_vim" { send-keys C-k } { if-shell -F '#{pane_at_top}'    {} { select-pane -U } }
  bind-key -n 'C-l' if-shell "$is_vim" { send-keys C-l } { if-shell -F '#{pane_at_right}'  {} { select-pane -R } }

  bind-key -T copy-mode-vi 'C-h' if-shell -F '#{pane_at_left}'   {} { select-pane -L }
  bind-key -T copy-mode-vi 'C-j' if-shell -F '#{pane_at_bottom}' {} { select-pane -D }
  bind-key -T copy-mode-vi 'C-k' if-shell -F '#{pane_at_top}'    {} { select-pane -U }
  bind-key -T copy-mode-vi 'C-l' if-shell -F '#{pane_at_right}'  {} { select-pane -R }

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.tmux-navigator.settings.preserve_zoom

As noted in disable_when_zoomed, navigating from a vim pane to another tmux pane normally causes the window to be unzoomed. Some users may prefer the behavior of tmux’s -Z option to select-pane, which keeps the window zoomed if it was zoomed.

This option enables that behavior.

Naturally, if disable_when_zoomed is enabled, this option will have no effect.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.tmux-navigator.settings.save_on_switch

You can configure the plugin to write the current buffer, or all buffers, when navigating from vim to tmux.

null: don’t save on switch (default value) 1: :update (write the current buffer, but only if changed) 2: :wall (write all buffers)

Type: null or one of 1, 2

Default: null

Declared by:

plugins.todo-comments.enable

Whether to enable todo-comments.

Type: boolean

Default: false

Example: true

Declared by:

plugins.todo-comments.package

Which package to use for the todo-comments plugin.

Type: package

Default: <derivation vimplugin-todo-comments.nvim-2024-03-27>

Declared by:

plugins.todo-comments.colors

List of named colors where we try to extract the guifg from the list of highlight groups or use the hex color if hl not found as a fallback.

Default:

{
  error = [ "DiagnosticError" "ErrorMsg" "#DC2626" ];
  warning = [ "DiagnosticWarn" "WarningMsg" "#FBBF24" ];
  info = [ "DiagnosticInfo" "#2563EB" ];
  hint = [ "DiagnosticHint" "#10B981" ];
  default = [ "Identifier" "#7C3AED" ];
  test = [ "Identifier" "#FF00FF" ];
};

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.todo-comments.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.todo-comments.mergeKeywords

When true, custom keywords will be merged with the default

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.ripgrepPackage

Which package (if any) to be added for file search support in todo-comments.

Type: null or package

Default: <derivation ripgrep-14.1.0>

Declared by:

plugins.todo-comments.signPriority

Sign priority.

Plugin default: 8

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.todo-comments.signs

Show icons in the signs column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.guiStyle.bg

The gui style to use for the bg highlight group.

Plugin default: "BOLD"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.guiStyle.fg

The gui style to use for the fg highlight group.

Plugin default: "NONE"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.after

“fg” or “bg” or empty.

Plugin default: "fg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.before

“fg” or “bg” or empty.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.commentsOnly

Uses treesitter to match keywords in comments only.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.exclude

List of file types to exclude highlighting.

Type: null or (list of string)

Default: null

Declared by:

plugins.todo-comments.highlight.keyword

“fg”, “bg”, “wide”, “wide_bg”, “wide_fg” or empty. (wide and wide_bg is the same as bg, but will also highlight surrounding characters, wide_fg acts accordingly but with fg).

Plugin default: "wide"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.maxLineLen

Ignore lines longer than this.

Plugin default: 400

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.multiline

Enable multiline todo comments.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.multilineContext

Extra lines that will be re-evaluated when changing a line.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.multilinePattern

Lua pattern to match the next multiline from the start of the matched keyword.

Plugin default: "^."

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.highlight.pattern

Pattern or list of patterns, used for highlighting (vim regex)

Note: the provided pattern will be embedded as such: [[PATTERN]].

Plugin default: .*<(KEYWORDS)\s*:

Type: null or string or list of string

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList

Keymap settings for the :TodoLocList function.

Type: null or (submodule)

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.cwd

Specify the directory to search for comments

Type: null or string

Default: null

Example: "~/projects/foobar"

Declared by:

plugins.todo-comments.keymaps.todoLocList.key

Key for the TodoLocList function.

Type: string

Declared by:

plugins.todo-comments.keymaps.todoLocList.keywords

Comma separated list of keywords to filter results by. Keywords are case-sensitive.

Type: null or string

Default: null

Example: "TODO,FIX"

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoLocList.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix

Keymap settings for the :TodoQuickFix function.

Type: null or (submodule)

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.cwd

Specify the directory to search for comments

Type: null or string

Default: null

Example: "~/projects/foobar"

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.key

Key for the TodoQuickFix function.

Type: string

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.keywords

Comma separated list of keywords to filter results by. Keywords are case-sensitive.

Type: null or string

Default: null

Example: "TODO,FIX"

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoQuickFix.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope

Keymap settings for the :TodoTelescope function.

Type: null or (submodule)

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.cwd

Specify the directory to search for comments

Type: null or string

Default: null

Example: "~/projects/foobar"

Declared by:

plugins.todo-comments.keymaps.todoTelescope.key

Key for the TodoTelescope function.

Type: string

Declared by:

plugins.todo-comments.keymaps.todoTelescope.keywords

Comma separated list of keywords to filter results by. Keywords are case-sensitive.

Type: null or string

Default: null

Example: "TODO,FIX"

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTelescope.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble

Keymap settings for the :TodoTrouble function.

Type: null or (submodule)

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.cwd

Specify the directory to search for comments

Type: null or string

Default: null

Example: "~/projects/foobar"

Declared by:

plugins.todo-comments.keymaps.todoTrouble.key

Key for the TodoTrouble function.

Type: string

Declared by:

plugins.todo-comments.keymaps.todoTrouble.keywords

Comma separated list of keywords to filter results by. Keywords are case-sensitive.

Type: null or string

Default: null

Example: "TODO,FIX"

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.buffer

Make the mapping buffer-local. Equivalent to adding <buffer> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.desc

A textual description of this keybind, to be shown in which-key, if you have it.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.noremap

Whether to use the noremap variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.remap

Make the mapping recursive. Inverses noremap.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.script

Equivalent to adding <script> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keymaps.todoTrouble.options.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.todo-comments.keywords

Configurations for keywords to be recognized as todo comments.

Default:

{
  FIX = {
    icon = " "; # Icon used for the sign, and in search results.
    color = "error"; # Can be a hex color, or a named color.
    alt = [ "FIXME" "BUG" "FIXIT" "ISSUE" ]; # A set of other keywords that all map to this FIX keywords.
  };
  TODO = { icon = " "; color = "info"; };
  HACK = { icon = " "; color = "warning"; };
  WARN = { icon = " "; color = "warning"; alt = [ "WARNING" "XXX" ]; };
  PERF = { icon = " "; alt = [ "OPTIM" "PERFORMANCE" "OPTIMIZE" ]; };
  NOTE = { icon = " "; color = "hint"; alt = [ "INFO" ]; };
  TEST = { icon = "⏲ "; color = "test"; alt = [ "TESTING" "PASSED" "FAILED" ]; };
};

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.alt

A set of other keywords that all map to this FIX keywords.

Type: null or (list of string)

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.color

Can be a hex color, or a named color.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.icon

Icon used for the sign, and in search results.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.signs

Configure signs for some keywords individually.

Type: null or boolean

Default: null

Declared by:

plugins.todo-comments.search.args

Arguments to use for the search command in list form.

Default:

[
  "--color=never"
  "--no-heading"
  "--with-filename"
  "--line-number"
  "--column"
];

Type: null or (list of string)

Default: null

Declared by:

plugins.todo-comments.search.command

Command to use for searching for keywords.

Plugin default: "rg"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.todo-comments.search.pattern

Regex that will be used to match keywords. Don’t replace the (KEYWORDS) placeholder.

Note: the provided pattern will be embedded as such: [[PATTERN]].

Plugin default: "\\b(KEYWORDS):"

Type: null or string or raw lua code

Default: null

Declared by:

toggleterm

Url: https://github.com/akinsho/toggleterm.nvim/

Maintainers: Gaetan Lepage

plugins.toggleterm.enable

Whether to enable toggleterm.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.toggleterm.package

Which package to use for the toggleterm.nvim plugin.

Type: package

Default: <derivation vimplugin-toggleterm.nvim-2024-04-22>

Declared by:

plugins.toggleterm.settings

Options provided to the require('toggleterm').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  direction = "float";
  float_opts = {
    border = "curved";
    height = 30;
    width = 130;
  };
  open_mapping = "[[<c->]]";
}

Declared by:

plugins.toggleterm.settings.auto_scroll

Automatically scroll to the bottom on terminal output.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.autochdir

When neovim changes it current directory the terminal will change it’s own when next it’s opened.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.close_on_exit

Close the terminal window when the process exits.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.direction

The direction the terminal should be opened in.

Plugin default: "horizontal"

Type: null or one of “vertical”, “horizontal”, “tab”, “float” or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.hide_numbers

Hide the number column in toggleterm buffers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.highlights

Highlights which map a highlight group name to an attrs of it’s values.

Plugin default:

{
  NormalFloat.link = "Normal";
  FloatBorder.link = "Normal";
  StatusLine.gui = "NONE";
  StatusLineNC = {
    cterm = "italic";
    gui = "NONE";
  };
}

Type: null or (attribute set of ((attribute set) or raw lua code))

Default: null

Declared by:

plugins.toggleterm.settings.insert_mappings

Whether or not the open mapping applies in insert mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.on_close

Function to run when the terminal closes.

fun(t: Terminal)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.on_create

Function to run when the terminal is first created.

fun(t: Terminal)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.on_exit

Function to run when terminal process exits.

fun(t: Terminal, job: number, exit_code: number, name: string)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.on_open

Function to run when the terminal opens.

fun(t: Terminal)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.on_stderr

Callback for processing output on stderr.

fun(t: Terminal, job: number, data: string[], name: string)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.on_stdout

Callback for processing output on stdout.

fun(t: Terminal, job: number, data: string[], name: string)

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.open_mapping

Setting the open_mapping key to use for toggling the terminal(s) will set up mappings for normal mode.

Type: null or lua code string

Default: null

Declared by:

plugins.toggleterm.settings.persist_mode

If set to true (default) the previous terminal mode will be remembered.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.persist_size

Whether the terminal size should persist.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.shade_filetypes

Shade filetypes.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.toggleterm.settings.shade_terminals

NOTE: This option takes priority over highlights specified so if you specify Normal highlights you should set this to false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.shading_factor

The percentage by which to lighten terminal background.

default: -30 (gets multiplied by -3 if background is light).

Type: null or signed integer

Default: null

Declared by:

plugins.toggleterm.settings.shell

Change the default shell.

Plugin default: "{__raw = \"vim.o.shell\";}"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.size

Size of the terminal. size can be a number or a function.

Example:

  size = 20

OR

size = \'\'
  function(term)
    if term.direction == "horizontal" then
      return 15
    elseif term.direction == "vertical" then
      return vim.o.columns * 0.4
    end
  end
\'\';

Plugin default: 12

Type: null or lua function string or signed integer or floating point number

Default: null

Declared by:

plugins.toggleterm.settings.start_in_insert

Whether to start toggleterm in insert mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.terminal_mappings

Whether or not the open mapping applies in the opened terminals.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.border

border = “single” | “double” | “shadow” | “curved” | … other options supported by win open. The border key is almost the same as ‘nvim_open_win’. The ‘curved’ border is a custom border type not natively supported but implemented in this plugin.

Type: null or string or list of string or list of list of string

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.col

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.height

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.row

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.title_pos

Plugin default: "left"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.width

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.winblend

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.float_opts.zindex

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

plugins.toggleterm.settings.winbar.enabled

Whether to enable winbar.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.toggleterm.settings.winbar.name_formatter

func(term: Terminal):string

Example:

  function(term)
    return fmt("%d:%s", term.id, term:_display_name())
  end

Plugin default:

function(term)
  return term.name
end

Type: null or lua function string

Default: null

Declared by:

transparent

Url: https://github.com/xiyaowong/transparent.nvim/

Maintainers: Gaetan Lepage

plugins.transparent.enable

Whether to enable transparent.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.transparent.package

Which package to use for the transparent.nvim plugin.

Type: package

Default: <derivation vimplugin-transparent.nvim-2023-11-12>

Declared by:

plugins.transparent.settings

Options provided to the require('transparent').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  exclude_groups = [ ];
  extra_groups = [
    "BufferLineTabClose"
    "BufferLineBufferSelected"
    "BufferLineFill"
    "BufferLineBackground"
    "BufferLineSeparator"
    "BufferLineIndicatorSelected"
  ];
}

Declared by:

plugins.transparent.settings.exclude_groups

Groups that you don’t want to clear.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.transparent.settings.extra_groups

Additional groups that should be cleared.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.transparent.settings.groups

The list of transparent groups.

Plugin default:

[
  "Normal"
  "NormalNC"
  "Comment"
  "Constant"
  "Special"
  "Identifier"
  "Statement"
  "PreProc"
  "Type"
  "Underlined"
  "Todo"
  "String"
  "Function"
  "Conditional"
  "Repeat"
  "Operator"
  "Structure"
  "LineNr"
  "NonText"
  "SignColumn"
  "CursorLine"
  "CursorLineNr"
  "StatusLine"
  "StatusLineNC"
  "EndOfBuffer"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.treesitter.enable

Whether to enable tree-sitter syntax highlighting.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter.package

Plugin to use for nvim-treesitter. If using nixGrammars, it should include a withPlugins function

Type: package

Default: <derivation vimplugin-nvim-treesitter-2024-05-16>

Declared by:

plugins.treesitter.customCaptures

Custom capture group highlighting

Type: attribute set of string

Default: { }

Declared by:

plugins.treesitter.disabledLanguages

A list of languages to disable

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter.ensureInstalled

Either “all” or a list of languages

Type: value “all” (singular enum) or list of string

Default: "all"

Declared by:

plugins.treesitter.folding

Whether to enable tree-sitter based folding.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter.gccPackage

Which package (if any) to be added as the GCC compiler. This is required to build grammars if you are not using nixGrammars. To disable the installation of GCC, set this option to null.

Type: null or package

Default: null

Declared by:

plugins.treesitter.grammarPackages

Grammar packages to install

Type: list of package

Default:

[
  <derivation ada-grammar-0.0.0+rev=ba0894e>
  <derivation agda-grammar-0.0.0+rev=d3dc807>
  <derivation angular-grammar-0.0.0+rev=10f21f3>
  <derivation apex-grammar-0.0.0+rev=c99ad4b>
  <derivation arduino-grammar-0.0.0+rev=babb6d4>
  <derivation asm-grammar-0.0.0+rev=b0306e9>
  <derivation astro-grammar-0.0.0+rev=4be1807>
  <derivation authzed-grammar-0.0.0+rev=1dec7e1>
  <derivation awk-grammar-0.0.0+rev=ba74721>
  <derivation bash-grammar-0.0.0+rev=2fbd860>
  <derivation bass-grammar-0.0.0+rev=28dc705>
  <derivation beancount-grammar-0.0.0+rev=c25f803>
  <derivation bibtex-grammar-0.0.0+rev=ccfd77d>
  <derivation bicep-grammar-0.0.0+rev=0092c7d>
  <derivation bitbake-grammar-0.0.0+rev=a5d04fd>
  <derivation blueprint-grammar-0.0.0+rev=60ba737>
  <derivation c-grammar-0.0.0+rev=82fb86a>
  <derivation c_sharp-grammar-0.0.0+rev=82fa8f0>
  <derivation cairo-grammar-0.0.0+rev=6238f60>
  <derivation capnp-grammar-0.0.0+rev=7b0883c>
  <derivation chatito-grammar-0.0.0+rev=a461f20>
  <derivation clojure-grammar-0.0.0+rev=3a1ace9>
  <derivation cmake-grammar-0.0.0+rev=20ffd6d>
  <derivation comment-grammar-0.0.0+rev=5d8b29f>
  <derivation commonlisp-grammar-0.0.0+rev=bf2a65b>
  <derivation cooklang-grammar-0.0.0+rev=4ebe237>
  <derivation corn-grammar-0.0.0+rev=604d73c>
  <derivation cpon-grammar-0.0.0+rev=594289e>
  <derivation cpp-grammar-0.0.0+rev=2369fa9>
  <derivation css-grammar-0.0.0+rev=f6be52c>
  <derivation csv-grammar-0.0.0+rev=7eb7297>
  <derivation cuda-grammar-0.0.0+rev=e7878a9>
  <derivation cue-grammar-0.0.0+rev=8a5f273>
  <derivation d-grammar-0.0.0+rev=750dde9>
  <derivation dart-grammar-0.0.0+rev=ac0bb84>
  <derivation devicetree-grammar-0.0.0+rev=fb07e60>
  <derivation dhall-grammar-0.0.0+rev=affb6ee>
  <derivation diff-grammar-0.0.0+rev=629676f>
  <derivation disassembly-grammar-0.0.0+rev=0229c02>
  <derivation djot-grammar-0.0.0+rev=0e9a836>
  <derivation dockerfile-grammar-0.0.0+rev=087daa2>
  <derivation dot-grammar-0.0.0+rev=9ab8555>
  <derivation doxygen-grammar-0.0.0+rev=4a30eba>
  <derivation dtd-grammar-0.0.0+rev=648183d>
  <derivation earthfile-grammar-0.0.0+rev=cc99a3f>
  <derivation ebnf-grammar-0.0.0+rev=8e635b0>
  <derivation eds-grammar-0.0.0+rev=fde6202>
  <derivation eex-grammar-0.0.0+rev=f742f2f>
  <derivation elixir-grammar-0.0.0+rev=de690fa>
  <derivation elm-grammar-0.0.0+rev=09dbf22>
  <derivation elsa-grammar-0.0.0+rev=0a66b2b>
  <derivation elvish-grammar-0.0.0+rev=5e7210d>
  <derivation embedded_template-grammar-0.0.0+rev=38d5004>
  <derivation erlang-grammar-0.0.0+rev=868306b>
  <derivation facility-grammar-0.0.0+rev=a525796>
  <derivation faust-grammar-0.0.0+rev=f3b9274>
  <derivation fennel-grammar-0.0.0+rev=8ad1770>
  <derivation fidl-grammar-0.0.0+rev=0a8910f>
  <derivation firrtl-grammar-0.0.0+rev=8503d3a>
  <derivation fish-grammar-0.0.0+rev=a78aef9>
  <derivation foam-grammar-0.0.0+rev=04664b4>
  <derivation forth-grammar-0.0.0+rev=9018923>
  <derivation fortran-grammar-0.0.0+rev=f73d473>
  <derivation fsh-grammar-0.0.0+rev=fad2e17>
  <derivation func-grammar-0.0.0+rev=f780ca5>
  <derivation fusion-grammar-0.0.0+rev=19db2f4>
  <derivation gdscript-grammar-0.0.0+rev=1f1e782>
  <derivation gdshader-grammar-0.0.0+rev=ffd9f95>
  <derivation git_config-grammar-0.0.0+rev=9c2a1b7>
  <derivation git_rebase-grammar-0.0.0+rev=d8a4207>
  <derivation gitattributes-grammar-0.0.0+rev=41940e1>
  <derivation gitcommit-grammar-0.0.0+rev=edd817e>
  <derivation gitignore-grammar-0.0.0+rev=f4685bf>
  <derivation gleam-grammar-0.0.0+rev=8432ffe>
  <derivation glimmer-grammar-0.0.0+rev=6b25d26>
  <derivation glsl-grammar-0.0.0+rev=8c9fb41>
  <derivation gn-grammar-0.0.0+rev=bc06955>
  <derivation gnuplot-grammar-0.0.0+rev=3c895f5>
  <derivation go-grammar-0.0.0+rev=7ee8d92>
  <derivation godot_resource-grammar-0.0.0+rev=2ffb90d>
  <derivation gomod-grammar-0.0.0+rev=bbe2fe3>
  <derivation gosum-grammar-0.0.0+rev=e2ac513>
  <derivation gotmpl-grammar-0.0.0+rev=17144a7>
  <derivation gowork-grammar-0.0.0+rev=949a8a4>
  <derivation gpg-grammar-0.0.0+rev=f99323f>
  <derivation graphql-grammar-0.0.0+rev=5e66e96>
  <derivation groovy-grammar-0.0.0+rev=6c5c881>
  <derivation gstlaunch-grammar-0.0.0+rev=549aef2>
  <derivation hack-grammar-0.0.0+rev=fca1e29>
  <derivation hare-grammar-0.0.0+rev=0705249>
  <derivation haskell-grammar-0.0.0+rev=a50070d>
  <derivation haskell_persistent-grammar-0.0.0+rev=577259b>
  <derivation hcl-grammar-0.0.0+rev=e936d3f>
  <derivation heex-grammar-0.0.0+rev=b5ad6e3>
  <derivation helm-grammar-0.0.0+rev=17144a7>
  <derivation hjson-grammar-0.0.0+rev=02fa3b7>
  <derivation hlsl-grammar-0.0.0+rev=feea0ff>
  <derivation hlsplaylist-grammar-0.0.0+rev=64f1902>
  <derivation hocon-grammar-0.0.0+rev=c390f10>
  <derivation hoon-grammar-0.0.0+rev=a24c5a3>
  <derivation html-grammar-0.0.0+rev=e4d834e>
  <derivation htmldjango-grammar-0.0.0+rev=ea71012>
  <derivation http-grammar-0.0.0+rev=8d22f33>
  <derivation hurl-grammar-0.0.0+rev=ad705af>
  <derivation hyprlang-grammar-0.0.0+rev=e5da7d0>
  <derivation idl-grammar-0.0.0+rev=006a526>
  <derivation ini-grammar-0.0.0+rev=bcb84a2>
  <derivation inko-grammar-0.0.0+rev=4cef9aa>
  <derivation ispc-grammar-0.0.0+rev=9b2f9ae>
  <derivation janet_simple-grammar-0.0.0+rev=51271e2>
  <derivation java-grammar-0.0.0+rev=953abfc>
  <derivation javascript-grammar-0.0.0+rev=e88537c>
  <derivation jq-grammar-0.0.0+rev=13990f5>
  <derivation jsdoc-grammar-0.0.0+rev=49fde20>
  <derivation json-grammar-0.0.0+rev=94f5c52>
  <derivation json5-grammar-0.0.0+rev=ab0ba82>
  <derivation jsonc-grammar-0.0.0+rev=02b0165>
  <derivation jsonnet-grammar-0.0.0+rev=d34615f>
  <derivation julia-grammar-0.0.0+rev=acd5ca1>
  <derivation just-grammar-0.0.0+rev=fd814fc>
  <derivation kconfig-grammar-0.0.0+rev=486fea7>
  <derivation kdl-grammar-0.0.0+rev=49fb89a>
  <derivation kotlin-grammar-0.0.0+rev=c9cb850>
  <derivation koto-grammar-0.0.0+rev=919440e>
  <derivation kusto-grammar-0.0.0+rev=8353a12>
  <derivation lalrpop-grammar-0.0.0+rev=854a40e>
  <derivation latex-grammar-0.0.0+rev=cd82eb4>
  <derivation ledger-grammar-0.0.0+rev=8a841fb>
  <derivation leo-grammar-0.0.0+rev=304611b>
  <derivation linkerscript-grammar-0.0.0+rev=f99011a>
  <derivation liquid-grammar-0.0.0+rev=2933698>
  <derivation liquidsoap-grammar-0.0.0+rev=a9b8012>
  <derivation llvm-grammar-0.0.0+rev=1b96e58>
  <derivation lua-grammar-0.0.0+rev=a24dab1>
  <derivation luadoc-grammar-0.0.0+rev=873612a>
  <derivation luap-grammar-0.0.0+rev=31461ae>
  <derivation luau-grammar-0.0.0+rev=5b088fa>
  <derivation m68k-grammar-0.0.0+rev=d097b12>
  <derivation make-grammar-0.0.0+rev=a4b9187>
  <derivation markdown-grammar-0.0.0+rev=7fe453b>
  <derivation markdown_inline-grammar-0.0.0+rev=7fe453b>
  <derivation matlab-grammar-0.0.0+rev=79d8b25>
  <derivation menhir-grammar-0.0.0+rev=be8866a>
  <derivation mermaid-grammar-0.0.0+rev=90ae195>
  <derivation meson-grammar-0.0.0+rev=bd17c82>
  <derivation mlir-grammar-0.0.0+rev=a708e9b>
  <derivation muttrc-grammar-0.0.0+rev=90ef608>
  <derivation nasm-grammar-0.0.0+rev=570f3d7>
  <derivation nickel-grammar-0.0.0+rev=58baf89>
  <derivation nim-grammar-0.0.0+rev=961c279>
  <derivation nim_format_string-grammar-0.0.0+rev=d45f750>
  <derivation ninja-grammar-0.0.0+rev=0a95cfd>
  <derivation nix-grammar-0.0.0+rev=b3cda61>
  <derivation norg-grammar-0.0.0+rev=aa1a1a7>
  <derivation nqc-grammar-0.0.0+rev=14e6da1>
  <derivation objc-grammar-0.0.0+rev=62e61b6>
  <derivation objdump-grammar-0.0.0+rev=28d3b2e>
  <derivation ocaml-grammar-0.0.0+rev=0b12614>
  <derivation ocaml_interface-grammar-0.0.0+rev=0b12614>
  <derivation ocamllex-grammar-0.0.0+rev=4b9898c>
  <derivation odin-grammar-0.0.0+rev=f25b8c5>
  <derivation org-grammar-0.0.0+rev=64cfbc2>
  <derivation pascal-grammar-0.0.0+rev=a9ee969>
  <derivation passwd-grammar-0.0.0+rev=2023939>
  <derivation pem-grammar-0.0.0+rev=217ff2a>
  <derivation perl-grammar-0.0.0+rev=d4ebabd>
  <derivation php-grammar-0.0.0+rev=27afeb0>
  <derivation php_only-grammar-0.0.0+rev=27afeb0>
  <derivation phpdoc-grammar-0.0.0+rev=1d0e255>
  <derivation pioasm-grammar-0.0.0+rev=924aada>
  <derivation po-grammar-0.0.0+rev=bd860a0>
  <derivation pod-grammar-0.0.0+rev=39da859>
  <derivation poe_filter-grammar-0.0.0+rev=592476d>
  <derivation pony-grammar-0.0.0+rev=73ff874>
  <derivation printf-grammar-0.0.0+rev=0e0acea>
  <derivation prisma-grammar-0.0.0+rev=eca2596>
  <derivation promql-grammar-0.0.0+rev=77625d7>
  <derivation properties-grammar-0.0.0+rev=9d09f5f>
  <derivation proto-grammar-0.0.0+rev=e9f6b43>
  <derivation prql-grammar-0.0.0+rev=09e158c>
  <derivation psv-grammar-0.0.0+rev=7eb7297>
  <derivation pug-grammar-0.0.0+rev=a7ff31a>
  <derivation puppet-grammar-0.0.0+rev=584522f>
  <derivation purescript-grammar-0.0.0+rev=daf9b3e>
  <derivation pymanifest-grammar-0.0.0+rev=e3b82b7>
  <derivation python-grammar-0.0.0+rev=71778c2>
  <derivation ql-grammar-0.0.0+rev=42becd6>
  <derivation qmldir-grammar-0.0.0+rev=6b2b5e4>
  <derivation qmljs-grammar-0.0.0+rev=2c57cac>
  <derivation query-grammar-0.0.0+rev=d25e8d1>
  <derivation r-grammar-0.0.0+rev=3914005>
  <derivation racket-grammar-0.0.0+rev=171f52a>
  <derivation rasi-grammar-0.0.0+rev=43196d9>
  <derivation rbs-grammar-0.0.0+rev=e5e807a>
  <derivation re2c-grammar-0.0.0+rev=47aa19c>
  <derivation readline-grammar-0.0.0+rev=3d4768b>
  <derivation regex-grammar-0.0.0+rev=47007f1>
  <derivation rego-grammar-0.0.0+rev=9ac75e7>
  <derivation requirements-grammar-0.0.0+rev=8666a4d>
  <derivation rnoweb-grammar-0.0.0+rev=1a74dc0>
  <derivation robot-grammar-0.0.0+rev=322e4cc>
  <derivation roc-grammar-0.0.0+rev=7df2c08>
  <derivation ron-grammar-0.0.0+rev=7893855>
  <derivation rst-grammar-0.0.0+rev=5120f6e>
  <derivation ruby-grammar-0.0.0+rev=788a63c>
  <derivation rust-grammar-0.0.0+rev=9c84af0>
  <derivation scala-grammar-0.0.0+rev=b76db43>
  <derivation scfg-grammar-0.0.0+rev=6deae0c>
  <derivation scheme-grammar-0.0.0+rev=8f9dff3>
  <derivation scss-grammar-0.0.0+rev=c478c68>
  <derivation slang-grammar-0.0.0+rev=6858753>
  <derivation slint-grammar-0.0.0+rev=0701312>
  <derivation smali-grammar-0.0.0+rev=fdfa6a1>
  <derivation smithy-grammar-0.0.0+rev=fa898ac>
  <derivation snakemake-grammar-0.0.0+rev=ba1b386>
  <derivation solidity-grammar-0.0.0+rev=b5a23ea>
  <derivation soql-grammar-0.0.0+rev=c99ad4b>
  <derivation sosl-grammar-0.0.0+rev=c99ad4b>
  <derivation sourcepawn-grammar-0.0.0+rev=4c62065>
  <derivation sparql-grammar-0.0.0+rev=05f949d>
  <derivation sql-grammar-0.0.0+rev=25f94f9>
  <derivation squirrel-grammar-0.0.0+rev=0a50d31>
  <derivation ssh_config-grammar-0.0.0+rev=77450e8>
  <derivation starlark-grammar-0.0.0+rev=b31a616>
  <derivation strace-grammar-0.0.0+rev=d819cdd>
  <derivation styled-grammar-0.0.0+rev=c68a457>
  <derivation supercollider-grammar-0.0.0+rev=affa438>
  <derivation surface-grammar-0.0.0+rev=f4586b3>
  <derivation svelte-grammar-0.0.0+rev=2c97326>
  <derivation swift-grammar-0.0.0+rev=c9c669b>
  <derivation sxhkdrc-grammar-0.0.0+rev=440d5f9>
  <derivation systemtap-grammar-0.0.0+rev=1af543a>
  <derivation t32-grammar-0.0.0+rev=6182836>
  <derivation tablegen-grammar-0.0.0+rev=b117088>
  <derivation tact-grammar-0.0.0+rev=034df21>
  <derivation tcl-grammar-0.0.0+rev=8784024>
  <derivation teal-grammar-0.0.0+rev=33482c9>
  <derivation templ-grammar-0.0.0+rev=d631f60>
  <derivation terraform-grammar-0.0.0+rev=e936d3f>
  <derivation textproto-grammar-0.0.0+rev=8dacf02>
  <derivation thrift-grammar-0.0.0+rev=68fd0d8>
  <derivation tiger-grammar-0.0.0+rev=a7f11d9>
  <derivation tlaplus-grammar-0.0.0+rev=ef18145>
  <derivation tmux-grammar-0.0.0+rev=9138ea5>
  <derivation todotxt-grammar-0.0.0+rev=3937c5c>
  <derivation toml-grammar-0.0.0+rev=16a30c8>
  <derivation tsv-grammar-0.0.0+rev=7eb7297>
  <derivation tsx-grammar-0.0.0+rev=4ad3010>
  <derivation turtle-grammar-0.0.0+rev=085437f>
  <derivation twig-grammar-0.0.0+rev=eaf80e6>
  <derivation typescript-grammar-0.0.0+rev=4ad3010>
  <derivation typespec-grammar-0.0.0+rev=fd9a83c>
  <derivation typoscript-grammar-0.0.0+rev=43b221c>
  <derivation typst-grammar-0.0.0+rev=3924cb9>
  <derivation udev-grammar-0.0.0+rev=8f58696>
  <derivation ungrammar-grammar-0.0.0+rev=debd26f>
  <derivation unison-grammar-0.0.0+rev=59d36a0>
  <derivation usd-grammar-0.0.0+rev=4e0875f>
  <derivation uxntal-grammar-0.0.0+rev=ad9b638>
  <derivation v-grammar-0.0.0+rev=7e11a6f>
  <derivation vala-grammar-0.0.0+rev=8f690bf>
  <derivation vento-grammar-0.0.0+rev=3321077>
  <derivation verilog-grammar-0.0.0+rev=075ebfc>
  <derivation vhs-grammar-0.0.0+rev=90028bb>
  <derivation vim-grammar-0.0.0+rev=b448ca6>
  <derivation vimdoc-grammar-0.0.0+rev=b711df7>
  <derivation vue-grammar-0.0.0+rev=22bdfa6>
  <derivation wgsl-grammar-0.0.0+rev=40259f3>
  <derivation wgsl_bevy-grammar-0.0.0+rev=59d5fbd>
  <derivation wing-grammar-0.0.0+rev=bd1d35c>
  <derivation wit-grammar-0.0.0+rev=cab9479>
  <derivation xcompose-grammar-0.0.0+rev=2383cc6>
  <derivation xml-grammar-0.0.0+rev=648183d>
  <derivation yaml-grammar-0.0.0+rev=7b03fee>
  <derivation yang-grammar-0.0.0+rev=2c0e6be>
  <derivation yuck-grammar-0.0.0+rev=e877f6a>
  <derivation zathurarc-grammar-0.0.0+rev=e9e8de0>
  <derivation zig-grammar-0.0.0+rev=0d08703>
]

Declared by:

plugins.treesitter.ignoreInstall

List of parsers to ignore installing (for “all”)

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter.indent

Whether to enable tree-sitter based indentation.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter.languageRegister

This is a wrapping of the vim.treesitter.language.register function. Register specific parsers to one or several filetypes. The keys are the parser names and the values are either one or several filetypes.

Type: attribute set of (string or list of string)

Default: { }

Example:

{
  cpp = "onelab";
  python = [
    "myFiletype"
    "anotherFiletype"
  ];
}

Declared by:

plugins.treesitter.moduleConfig

This is the configuration for extra modules. It should not be used directly

Type: attribute set of anything

Default: { }

Declared by:

plugins.treesitter.nixGrammars

Install grammars with Nix

Type: boolean

Default: true

Declared by:

plugins.treesitter.nixvimInjections

Whether to enable nixvim specific injections, like lua highlighting in extraConfigLua.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter.parserInstallDir

Location of the parsers to be installed by the plugin (only needed when nixGrammars is disabled). This default might not work on your own install, please make sure that $XDG_DATA_HOME is set if you want to use the default. Otherwise, change it to something that will work for you!

Type: null or string

Default: null

Declared by:

plugins.treesitter.incrementalSelection.enable

Whether to enable incremental selection based on the named nodes from the grammar.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter.incrementalSelection.keymaps.initSelection

This option has no description.

Type: string

Default: "gnn"

Declared by:

plugins.treesitter.incrementalSelection.keymaps.nodeDecremental

This option has no description.

Type: string

Default: "grm"

Declared by:

plugins.treesitter.incrementalSelection.keymaps.nodeIncremental

This option has no description.

Type: string

Default: "grn"

Declared by:

plugins.treesitter.incrementalSelection.keymaps.scopeIncremental

This option has no description.

Type: string

Default: "grc"

Declared by:

treesitter-context

Url: https://github.com/nvim-treesitter/nvim-treesitter-context/

Maintainers: Gaetan Lepage

plugins.treesitter-context.enable

Whether to enable nvim-treesitter-context.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-context.package

Which package to use for the nvim-treesitter-context plugin.

Type: package

Default: <derivation vimplugin-nvim-treesitter-context-2024-05-16>

Declared by:

plugins.treesitter-context.settings

Options provided to the require('treesitter-context').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  line_numbers = true;
  max_lines = 0;
  min_window_height = 0;
  mode = "topline";
  multiline_threshold = 20;
  separator = "-";
  trim_scope = "inner";
  zindex = 20;
}

Declared by:

plugins.treesitter-context.settings.enable

Enable this plugin (Can be enabled/disabled later via commands)

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.line_numbers

Whether to show line numbers.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.max_lines

How many lines the window should span. 0 means no limit.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.min_window_height

Minimum editor window height to enable context. 0 means no limit.

Plugin default: 0

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.mode

Line used to calculate context.

Plugin default: "cursor"

Type: null or one of “cursor”, “topline” or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.multiline_threshold

Maximum number of lines to collapse for a single context line.

Plugin default: 20

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.on_attach

The implementation of a lua function which takes an integer buf as parameter and returns a boolean. Return false to disable attaching.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.treesitter-context.settings.separator

Separator between context and content. Should be a single character string, like “-”. When separator is set, the context will only show up when there are at least 2 lines above cursorline.

Type: null or string

Default: null

Declared by:

plugins.treesitter-context.settings.trim_scope

Which context lines to discard if max_lines is exceeded.

Plugin default: "outer"

Type: null or one of “outer”, “inner” or raw lua code

Default: null

Declared by:

plugins.treesitter-context.settings.zindex

The Z-index of the context window.

Plugin default: 20

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.treesitter-refactor.enable

Whether to enable treesitter-refactor (requires plugins.treesitter.enable to be true).

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-refactor.package

Which package to use for the treesitter-refactor plugin.

Type: package

Default: <derivation vimplugin-nvim-treesitter-refactor-2023-04-04>

Declared by:

plugins.treesitter-refactor.highlightCurrentScope.enable

Whether to enable highlighting the block from the current scope where the cursor is.

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-refactor.highlightCurrentScope.disable

List of languages to disable the module on

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter-refactor.highlightDefinitions.enable

Whether to enable Highlights definition and usages of the current symbol under the cursor…

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-refactor.highlightDefinitions.clearOnCursorMove

Controls if highlights should be cleared when the cursor is moved. If your ‘updatetime’ is around 100 you can set this to false to have a less laggy experience.

Type: boolean

Default: true

Declared by:

plugins.treesitter-refactor.highlightDefinitions.disable

List of languages to disable the module on

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter-refactor.navigation.enable

Whether to enable Provides “go to definition” for the symbol under the cursor, and lists the definitions from the current file. .

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-refactor.navigation.disable

List of languages to disable the module on

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter-refactor.navigation.keymaps.gotoDefinition

go to the definition of the symbol under the cursor

Type: null or string

Default: "gnd"

Declared by:

plugins.treesitter-refactor.navigation.keymaps.gotoDefinitionLspFallback

go to the definition of the symbol under the cursor or use vim.lsp.buf.definition if the symbol can not be resolved. You can use your own fallback function if create a mapping for lua require'nvim-treesitter.refactor.navigation(nil, fallback_function)<cr>.

Type: null or string

Default: null

Declared by:

plugins.treesitter-refactor.navigation.keymaps.gotoNextUsage

go to next usage of identifier under the cursor

Type: null or string

Default: "<a-*>"

Declared by:

plugins.treesitter-refactor.navigation.keymaps.gotoPreviousUsage

go to previous usage of identifier

Type: null or string

Default: "<a-#>"

Declared by:

plugins.treesitter-refactor.navigation.keymaps.listDefinitions

list all definitions from the current file

Type: null or string

Default: "gnD"

Declared by:

plugins.treesitter-refactor.navigation.keymaps.listDefinitionsToc

list all definitions from the current file like a table of contents (similar to the one you see when pressing |gO| in help files).

Type: null or string

Default: "gO"

Declared by:

plugins.treesitter-refactor.smartRename.enable

Whether to enable Renames the symbol under the cursor within the current scope (and current file)…

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-refactor.smartRename.disable

List of languages to disable the module on

Type: list of string

Default: [ ]

Declared by:

plugins.treesitter-refactor.smartRename.keymaps.smartRename

rename symbol under the cursor

Type: null or string

Default: "grr"

Declared by:

plugins.treesitter-textobjects.enable

Whether to enable treesitter-textobjects (requires plugins.treesitter.enable to be true).

Type: boolean

Default: false

Example: true

Declared by:

plugins.treesitter-textobjects.package

Which package to use for the treesitter-textobjects plugin.

Type: package

Default: <derivation vimplugin-nvim-treesitter-textobjects-2024-05-15>

Declared by:

plugins.treesitter-textobjects.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.treesitter-textobjects.lspInterop.enable

LSP interop.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.lspInterop.border

Define the style of the floating window border.

Plugin default: "none"

Type: null or one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.lspInterop.floatingPreviewOpts

Options to pass to vim.lsp.util.open_floating_preview. For example, maximum_height.

Plugin default: {}

Type: null or (attribute set of anything)

Default: null

Declared by:

plugins.treesitter-textobjects.lspInterop.peekDefinitionCode

Show textobject surrounding definition as determined using Neovim’s built-in LSP in a floating window. Press the shortcut twice to enter the floating window (when https://github.com/neovim/neovim/pull/12720 or its successor is merged).

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.enable

Go to next/previous text object~

Define your own mappings to jump to the next or previous text object. This is similar to |]m|, |[m|, |]M|, |[M| Neovim’s mappings to jump to the next or previous function.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.move.disable

List of languages to disable this module for.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoNext

Will go to either the start or the end, whichever is closer. Use if you want more granular movements. Make it even more gradual by adding multiple queries and regex.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoNextEnd

Same as gotoNextStart, but it jumps to the start of the text object.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoNextStart

Map of keymaps to a list of tree-sitter capture groups ({@function.outer, @class.outer}). The one that starts closest to the cursor will be chosen, preferring row-proximity to column-proximity.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoPrevious

Will go to either the start or the end, whichever is closer. Use if you want more granular movements. Make it even more gradual by adding multiple queries and regex.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoPreviousEnd

Same as gotoNextEnd, but it jumps to the previous text object.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.gotoPreviousStart

Same as gotoNextStart, but it jumps to the previous text object.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.move.setJumps

Whether to set jumps in the jumplist.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.select.enable

Text object selection:

Define your own text objects mappings similar to ip (inner paragraph) and ap (a paragraph).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.select.disable

List of languages to disable this module for.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.treesitter-textobjects.select.includeSurroundingWhitespace

true or false, when true textobjects are extended to include preceding or succeeding whitespace.

Can also be a function which gets passed a table with the keys query_string (@function.inner) and selection_mode (v) and returns true of false.

If you set this to true (default is false) then any textobject is extended to include preceding or succeeding whitespace. Succeeding whitespace has priority in order to act similarly to eg the built-in ap.

Plugin default: false

Type: null or lua function string or boolean

Default: null

Declared by:

plugins.treesitter-textobjects.select.keymaps

Map of keymaps to a tree-sitter query ((function_definition) @function) or capture group (@function.inner).

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.select.lookahead

Whether or not to look ahead for the textobject.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.select.selectionModes

Map of capture group to v(charwise), V(linewise), or <c-v>(blockwise), choose a selection mode per capture, default is v(charwise).

Plugin default: {}

Type: null or (attribute set of (one of “v”, “V”, “<c-v>”))

Default: null

Declared by:

plugins.treesitter-textobjects.swap.enable

Swap text objects:

Define your own mappings to swap the node under the cursor with the next or previous one, like function parameters or arguments.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.treesitter-textobjects.swap.disable

List of languages to disable this module for.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.treesitter-textobjects.swap.swapNext

Map of keymaps to a list of tree-sitter capture groups ({@parameter.inner}). Capture groups that come earlier in the list are preferred.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

plugins.treesitter-textobjects.swap.swapPrevious

Same as swapNext, but it will swap with the previous text object.

Plugin default: {}

Type: null or (attribute set of (string or (submodule)))

Default: null

Declared by:

trim

Url: https://github.com/cappyzawa/trim.nvim/

Maintainers: Gaetan Lepage

plugins.trim.enable

Whether to enable trim.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.trim.package

Which package to use for the trim.nvim plugin.

Type: package

Default: <derivation vimplugin-trim.nvim-2024-03-15>

Declared by:

plugins.trim.settings

Options provided to the require('trim').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  ft_blocklist = [
    "markdown"
  ];
  highlight = true;
  patterns = [
    ''
      [[%s/(
      
      )
      +/1/]]''
  ];
  trim_on_write = false;
}

Declared by:

plugins.trim.settings.ft_blocklist

Filetypes to exclude.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.trim.settings.highlight

Whether to highlight trailing whitespaces.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trim.settings.highlight_bg

Which color to use for coloring whitespaces.

Plugin default: "#ff0000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trim.settings.highlight_ctermbg

Which color to use for coloring whitespaces (cterm).

Plugin default: "red"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trim.settings.patterns

Extra patterns to use for removing white spaces.

Plugin default: []

Type: list of lua code string

Default: [ ]

Example:

[
  ''
    [[%s/(
    
    )
    +/1/]]''
]

Declared by:

plugins.trim.settings.trim_first_line

Whether to trim blank lines at the beginning of the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trim.settings.trim_last_line

Whether to trim trailing blank lines at the end of the file.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trim.settings.trim_on_write

Whether to automatically trim on write.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trim.settings.trim_trailing

Whether to trim trailing whitespaces.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

trouble

Url: https://github.com/folke/trouble.nvim/

Maintainers: Loïc Reynier

plugins.trouble.enable

Whether to enable trouble-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.trouble.package

Which package to use for the trouble-nvim plugin.

Type: package

Default: <derivation vimplugin-trouble.nvim-2024-03-29>

Declared by:

plugins.trouble.settings

Options provided to the require('trouble').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.trouble.settings.auto_close

Automatically close the list when you have no diagnostics.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.auto_fold

Automatically fold a file trouble list at creation.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.auto_jump

For the given modes, automatically jump if there is only a single result.

Plugin default: ["lsp_definitions"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.trouble.settings.auto_open

Automatically open the list when you have diagnostics.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.auto_preview

Automatically preview the location of the diagnostic. <esc> to close preview and go back to last window.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.cycle_results

Whether to cycle item list when reaching beginning or end of list

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.fold_closed

Icon used for closed folds

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.fold_open

Icon used for open folds

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.group

Group results by file

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.height

Height of the trouble list when position is top or bottom.

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.trouble.settings.icons

Use devicons for filenames

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.include_declaration

For the given modes, include the declaration of the current symbol in the results.

Plugin default: ["lsp_references" "lsp_implementations" "lsp_definitions"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.trouble.settings.indent_lines

Add an indent guide below the fold icons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.mode

Mode for default list

Plugin default: "workspace_diagnostics"

Type: null or one of “workspace_diagnostics”, “document_diagnostics”, “quickfix”, “lsp_references”, “loclist” or raw lua code

Default: null

Declared by:

plugins.trouble.settings.padding

Add an extra new line on top of the list

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.position

Position of the list.

Plugin default: "bottom"

Type: null or one of “top”, “left”, “right”, “bottom” or raw lua code

Default: null

Declared by:

plugins.trouble.settings.use_diagnostic_signs

Enabling this will use the signs defined in your lsp client

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.trouble.settings.width

Width of the list when position is left or right.

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.trouble.settings.win_config

Configuration for floating windows. See |nvim_open_win()|.

Plugin default:

{
  border = "single";
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.trouble.settings.action_keys.cancel

Cancel the preview and get back to your last window / buffer / cursor

Plugin default: <esc>

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.close

Close the list

Plugin default: q

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.close_folds

Close all folds

Plugin default: [ "zM" "zm" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.hover

Opens a small popup with the full multiline message

Plugin default: K

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.jump

Jump to the diagnostic or open / close folds

Plugin default: [ "<cr>" "<tab>" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.jump_close

Jump to the diagnostic and close the list

Plugin default: [ "o" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.next

Next item

Plugin default: j

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.open_folds

Open all folds

Plugin default: [ "zR" "zr" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.open_split

Open buffer in new split

Plugin default: [ "<c-x>" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.open_tab

Open buffer in new tab

Plugin default: [ "<c-t>" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.open_vsplit

Open buffer in new vsplit

Plugin default: [ "<c-v>" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.preview

Preview the diagnostic location

Plugin default: p

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.previous

Previous item

Plugin default: k

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.refresh

Manually refresh

Plugin default: r

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.toggle_fold

Toggle fold of current file

Plugin default: [ "zA" "za" ]

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.toggle_mode

toggle between ‘workspace’ and ‘document’ diagnostics mode

Plugin default: m

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.action_keys.toggle_preview

Toggle auto_preview

Plugin default: P

Type: null or string or list of string

Default: null

Declared by:

plugins.trouble.settings.signs.error

Icon/text for error diagnostics.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.signs.hint

Icon/text for hint diagnostics.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.signs.information

Icon/text for information diagnostics.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.signs.other

Icon/text for other diagnostics.

Plugin default: "﫠"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.trouble.settings.signs.warning

Icon/text for warning diagnostics.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ts-autotag.enable

Whether to enable nvim-ts-autotag.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ts-autotag.package

Which package to use for the ts-autotag plugin.

Type: package

Default: <derivation vimplugin-nvim-ts-autotag-2024-02-07>

Declared by:

plugins.ts-autotag.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.ts-autotag.filetypes

Filetypes for which ts-autotag should be enabled.

Plugin default:

[
  "html"
  "javascript"
  "typescript"
  "javascriptreact"
  "typescriptreact"
  "svelte"
  "vue"
  "tsx"
  "jsx"
  "rescript"
  "xml"
  "php"
  "markdown"
  "astro"
  "glimmer"
  "handlebars"
  "hbs"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.ts-autotag.skipTags

Which tags to skip.

Plugin default:

[
  "area"
  "base"
  "br"
  "col"
  "command"
  "embed"
  "hr"
  "img"
  "slot"
  "input"
  "keygen"
  "link"
  "meta"
  "param"
  "source"
  "track"
  "wbr"
  "menuitem"
]

Type: null or (list of string)

Default: null

Declared by:

plugins.ts-context-commentstring.enable

Whether to enable nvim-ts-context-commentstring.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ts-context-commentstring.package

Which package to use for the ts-context-commentstring plugin.

Type: package

Default: <derivation vimplugin-nvim-ts-context-commentstring-2024-05-07>

Declared by:

plugins.ts-context-commentstring.disableAutoInitialization

Whether to disable auto-initialization.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.ts-context-commentstring.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.ts-context-commentstring.languages

Allows you to add support for more languages.

See :h ts-context-commentstring-commentstring-configuration for more information.

Type: null or (attribute set of (string or attribute set of string))

Default: null

Declared by:

plugins.ts-context-commentstring.skipTsContextCommentStringModule

Whether to skip backwards compatibility routines and speed up loading.

Type: boolean

Default: true

Example: false

Declared by:

twilight

Url: https://github.com/folke/twilight.nvim/

Maintainers: Gaetan Lepage

plugins.twilight.enable

Whether to enable twilight.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.twilight.package

Which package to use for the twilight.nvim plugin.

Type: package

Default: <derivation vimplugin-twilight.nvim-2023-09-25>

Declared by:

plugins.twilight.settings

Options provided to the require('twilight').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  context = 20;
  dimming = {
    alpha = 0.4;
  };
  expand = [
    "function"
    "method"
  ];
  treesitter = true;
}

Declared by:

plugins.twilight.settings.context

Amount of lines we will try to show around the current line.

Plugin default: 10

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.twilight.settings.exclude

Exclude these filetypes.

Plugin default: []

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.twilight.settings.expand

For treesitter, we will always try to expand to the top-most ancestor with these types.

Plugin default:

[
  "function"
  "method"
  "table"
  "if_statement"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.twilight.settings.treesitter

Use treesitter when available for the filetype. treesitter is used to automatically expand the visible text, but you can further control the types of nodes that should always be fully expanded.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.twilight.settings.dimming.alpha

Amount of dimming.

Plugin default: 0.25

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.twilight.settings.dimming.color

Highlight groups / colors to use.

Plugin default: ["Normal" "#ffffff"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.twilight.settings.dimming.inactive

When true, other windows will be fully dimmed (unless they contain the same buffer).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.twilight.settings.dimming.term_bg

If guibg=NONE, this will be used to calculate text color.

Plugin default: "#000000"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.typescript-tools.enable

Whether to enable typescript-tools.

Type: boolean

Default: false

Example: true

Declared by:

plugins.typescript-tools.package

Which package to use for the typescript-tools plugin.

Type: package

Default: <derivation vimplugin-typescript-tools.nvim-2024-01-16>

Declared by:

plugins.typescript-tools.handlers

How tsserver should respond to LSP requests

Type: null or (attribute set of lua function string)

Default: null

Example:

{
  "textDocument/publishDiagnostics" = ''
    require("typescript-tools.api").filter_diagnostics(
      -- Ignore 'This may be converted to an async function' diagnostics.
      { 80006 }
    )
  '';
}

Declared by:

plugins.typescript-tools.onAttach

Lua code to run when tsserver attaches to a buffer.

Plugin default: __lspOnAttach

Type: null or lua function string

Default: null

Declared by:

plugins.typescript-tools.settings.codeLens

WARNING: Experimental feature also in VSCode, disabled by default because it might impact server performance.

Plugin default: "off"

Type: null or one of “off”, “all”, “implementations_only”, “references_only” or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.completeFunctionCalls

Mirror of VSCode’s typescript.suggest.completeFunctionCalls

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.disableMemberCodeLens

By default code lenses are displayed on all referenceable values. Display less by removing member references from lenses.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.exposeAsCodeAction

Specify what to expose as code actions.

Type: value “all” (singular enum) or list of (one of “fix_all”, “add_missing_imports”, “remove_unused”, “remove_unused_imports”, “organize_imports”, “insert_leave”)

Default: [ ]

Declared by:

plugins.typescript-tools.settings.includeCompletionsWithInsertText

Mirror of VSCode’s typescript.suggest.completeFunctionCalls

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.publishDiagnosticOn

Either “change” or “insert_leave”. Determines when the client asks the server about diagnostics

Plugin default: "insert_leave"

Type: null or one of “change”, “insert_leave” or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.separateDiagnosticServer

Spawns an additional tsserver instance to calculate diagnostics

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.tsserverFilePreferences

Configuration options that well be passed to the tsserver instance. Find available options here

Type: null or (attribute set of anything)

Default: null

Example:

{
  tsserver_format_options = ''
    {
      allowIncompleteCompletions = false,
      allowRenameOfImportPath = false,
      ...
    }'';
}

Declared by:

plugins.typescript-tools.settings.tsserverFormatOptions

Configuration options that well be passed to the tsserver instance. Find available options here

Type: null or (attribute set of anything)

Default: null

Example:

{
  tsserver_file_preferences = ''
    {
      includeInlayParameterNameHints = "all",
      includeCompletionsForModuleExports = true,
      quotePreference = "auto",
      ...
    }
  '';
}

Declared by:

plugins.typescript-tools.settings.tsserverLocale

Locale of all tsserver messages. Supported locales here: https://github.com/microsoft/TypeScript/blob/3c221fc086be52b19801f6e8d82596d04607ede6/src/compiler/utilitiesPublic.ts#L620

Plugin default: "en"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.tsserverMaxMemory

This value is passed to: https://nodejs.org/api/cli.html#–max-old-space-sizesize-in-megabytes Memory limit in megabytes or “auto”(basically no limit)

Type: null or unsigned integer, meaning >=0, or value “auto” (singular enum) or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.tsserverPath

Specify a custom path to tsserver.js file, if this is nil or file under path doesn’t exist then standard path resolution strategy is applied

Type: null or string or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.tsserverPlugins

List of plugins for tsserver to load. See this plugins’s README at https://github.com/pmizio/typescript-tools.nvim/#-styled-components-support

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.typescript-tools.settings.jsxCloseTag.enable

Functions similarly to nvim-ts-autotag. This is disabled by default to avoid conflicts.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typescript-tools.settings.jsxCloseTag.filetypes

Filetypes this should apply to.

Plugin default: ["javascriptreact" "typescriptreact"]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

typst-vim

Url: https://github.com/kaarmu/typst.vim/

Maintainers: Gaetan Lepage

plugins.typst-vim.enable

Whether to enable typst.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.typst-vim.package

Which package to use for the typst-vim plugin.

Type: package

Default: <derivation vimplugin-typst.vim-2024-04-18>

Declared by:

plugins.typst-vim.keymaps.silent

Whether typst-vim keymaps should be silent.

Type: boolean

Default: false

Declared by:

plugins.typst-vim.keymaps.watch

Keymap to preview the document and recompile on change.

Type: null or string

Default: null

Declared by:

plugins.typst-vim.settings

The configuration options for typst-vim without the typst_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal typst_foo_bar=1
  • hello = "world" -> :setglobal typst_hello="world"
  • some_toggle = true -> :setglobal typst_some_toggle
  • other_toggle = false -> :setglobal notypst_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  auto_close_toc = true;
  cmd = "typst";
  conceal_math = true;
}

Declared by:

plugins.typst-vim.settings.auto_close_toc

Specifies whether TOC will be automatically closed after using it.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typst-vim.settings.cmd

Specifies the location of the Typst executable.

Plugin default: "typst"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.typst-vim.settings.conceal_math

Enable concealment for math symbols in math mode (i.e. replaces symbols with their actual unicode character). Warning: this can affect performance

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.typst-vim.settings.pdf_viewer

Specifies pdf viewer that typst watch --open will use.

Type: null or string

Default: null

Declared by:

undotree

Url: https://github.com/mbbill/undotree/

Maintainers: Gaetan Lepage

plugins.undotree.enable

Whether to enable undotree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.undotree.package

Which package to use for the undotree plugin.

Type: package

Default: <derivation vimplugin-undotree-2024-04-16>

Declared by:

plugins.undotree.settings

The configuration options for undotree without the undotree_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal undotree_foo_bar=1
  • hello = "world" -> :setglobal undotree_hello="world"
  • some_toggle = true -> :setglobal undotree_some_toggle
  • other_toggle = false -> :setglobal noundotree_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  CursorLine = true;
  DiffAutoOpen = true;
  DiffCommand = "diff";
  DiffpanelHeight = 10;
  HelpLine = true;
  HighlightChangedText = true;
  HighlightChangedWithSign = true;
  HighlightSyntaxAdd = "DiffAdd";
  HighlightSyntaxChange = "DiffChange";
  HighlightSyntaxDel = "DiffDelete";
  RelativeTimestamp = true;
  SetFocusWhenToggle = true;
  ShortIndicators = false;
  SplitWidth = 40;
  TreeNodeShape = "*";
  TreeReturnShape = "\\";
  TreeSplitShape = "/";
  TreeVertShape = "|";
  WindowLayout = 4;
}

Declared by:

plugins.vim-bbye.enable

Whether to enable vim-bbye.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vim-bbye.package

Which package to use for the vim-bbye plugin.

Type: package

Default: <derivation vimplugin-vim-bbye-2018-03-03>

Declared by:

plugins.vim-bbye.keymapsSilent

Whether vim-bbye keymaps should be silent.

Type: boolean

Default: false

Declared by:

plugins.vim-bbye.keymaps.bdelete

Keymap for deleting the current buffer.";

Type: null or string

Default: null

Declared by:

plugins.vim-bbye.keymaps.bwipeout

Keymap for completely deleting the current buffer.";

Type: null or string

Default: null

Declared by:

vim-css-color

Url: https://github.com/ap/vim-css-color/

Maintainers: Daniel Laing

plugins.vim-css-color.enable

Whether to enable vim-css-color.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vim-css-color.package

Which package to use for the vim-css-color plugin.

Type: package

Default: <derivation vimplugin-vim-css-color-2024-01-13>

Declared by:

plugins.vim-matchup.enable

Whether to enable vim-matchup.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vim-matchup.enableSurround

To enable the delete surrounding (ds%) and change surrounding (cs%) maps

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.enableTransmute

To enable the experimental transmute module

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.package

Which package to use for the vim-matchup plugin.

Type: package

Default: <derivation vimplugin-vim-matchup-2024-02-24>

Declared by:

plugins.vim-matchup.delimNoSkips

To disable matching within strings and comments:

  • 0: matching is enabled within strings and comments
  • 1: recognize symbols within comments
  • 2: don’t recognize anything in comments

Plugin default: 0

Type: null or one of 0, 1, 2

Default: null

Declared by:

plugins.vim-matchup.delimStopline

To configure the number of lines to search in either direction while using motions and text objects. Does not apply to match highlighting (see matchParenStopline instead)

Plugin default: 1500

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.enable

Control matching parentheses

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.fallback

If matchParen is not enabled fallback to the standard vim matchparen.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.hiSurroundAlways

Highlight surrounding delimiters always as the cursor moves Note: this feature requires deferred highlighting to be supported and enabled.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.insertTimeout

Adjust timeouts in milliseconds for matchparen highlighting

Plugin default: 60

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.singleton

Whether to highlight known words even if there is no match

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.stopline

The number of lines to search in either direction while highlighting matches. Set this conservatively since high values may cause performance issues.

Plugin default: 400

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.timeout

Adjust timeouts in milliseconds for matchparen highlighting

Plugin default: 300

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.deferred.enable

Deferred highlighting improves cursor movement performance (for example, when using hjkl) by delaying highlighting for a short time and waiting to see if the cursor continues moving

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.deferred.hideDelay

Adjust delays in milliseconds for deferred highlighting

Plugin default: 700

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.deferred.showDelay

Adjust delays in milliseconds for deferred highlighting

Plugin default: 50

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.offscreen

Dictionary controlling the behavior with off-screen matches.

Plugin default: {method = "status";}

Type: null or (submodule)

Default: null

Declared by:

plugins.vim-matchup.matchParen.offscreen.method

‘status’: Replace the status-line for off-screen matches.

If a match is off of the screen, the line belonging to that match will be displayed syntax-highlighted in the status line along with the line number (if line numbers are enabled). If the match is above the screen border, an additional Δ symbol will be shown to indicate that the matching line is really above the cursor line.

‘popup’: Show off-screen matches in a popup (vim) or floating (neovim) window.

‘status_manual’: Compute the string which would be displayed in the status-line or popup, but do not display it. The function MatchupStatusOffscreen() can be used to get the text.

Plugin default: "status"

Type: null or one of “status”, “popup”, “status_manual” or raw lua code

Default: null

Declared by:

plugins.vim-matchup.matchParen.offscreen.scrolloff

When enabled, off-screen matches will not be shown in the statusline while the cursor is at the screen edge (respects the value of ‘scrolloff’). This is intended to prevent flickering while scrolling with j and k.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.motion.enable

Control motions

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.motion.cursorEnd

If enabled, cursor will land on the end of mid and close words while moving downwards (%/]%). While moving upwards (g%, [%) the cursor will land on the beginning.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.motion.overrideNPercent

In vim, {count}% goes to the {count} percentage in the file. match-up overrides this motion for small {count} (by default, anything less than 7). To allow {count}% for {count} less than 12 set overrideNPercent to 11.

To disable this feature set it to 0.

To always enable this feature, use any value greater than 99

Plugin default: 6

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.vim-matchup.textObj.enable

Controls text objects

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.textObj.linewiseOperators

Modify the set of operators which may operate line-wise

Plugin default: ["d" "y"]

Type: null or (list of string)

Default: null

Declared by:

plugins.vim-matchup.treesitterIntegration.enable

Whether to enable treesitter integration.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vim-matchup.treesitterIntegration.disable

Languages for each to disable this module

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.vim-matchup.treesitterIntegration.disableVirtualText

Do not use virtual text to highlight the virtual end of a block, for languages without explicit end markers (e.g., Python).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-matchup.treesitterIntegration.includeMatchWords

Additionally include traditional vim regex matches for symbols. For example, highlights /* */ comments in C++ which are not supported in tree-sitter matching

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

vim-slime

Url: https://github.com/jpalardy/vim-slime/

Maintainers: Gaetan Lepage

plugins.vim-slime.enable

Whether to enable vim-slime.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vim-slime.package

Which package to use for the vim-slime plugin.

Type: package

Default: <derivation vimplugin-vim-slime-2024-05-15>

Declared by:

plugins.vim-slime.settings

The configuration options for vim-slime without the slime_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal slime_foo_bar=1
  • hello = "world" -> :setglobal slime_hello="world"
  • some_toggle = true -> :setglobal slime_some_toggle
  • other_toggle = false -> :setglobal noslime_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  bracketed_paste = false;
  default_config = {
    socket_name = "default";
    target_pane = "{last}";
  };
  dont_ask_default = false;
  no_mappings = false;
  paste_file = "$HOME/.slime_paste";
  preserve_curpos = true;
  target = "screen";
  vimterminal_cmd = null;
}

Declared by:

plugins.vim-slime.settings.bracketed_paste

Sometimes REPL are too smart for their own good, e.g. autocompleting a bracket that should not be autocompleted when pasting code from a file. In this case it can be useful to rely on bracketed-paste (https://cirw.in/blog/bracketed-paste). Luckily, tmux knows how to handle that. See tmux’s manual.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.default_config

Pre-filled prompt answer.

Examples:

  • tmux:

      {
    socket_name = "default";
    target_pane = "{last}";
  }

  • zellij:

      {
    session_id = "current";
    relative_pane = "right";
  }

Type: null or (attribute set of (string or raw lua code))

Default: null

Declared by:

plugins.vim-slime.settings.dont_ask_default

Whether to bypass the prompt and use the specified default configuration options.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.no_mappings

Whether to disable the default mappings.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.paste_file

Required to transfer data from vim to GNU screen or tmux. Setting this explicitly can work around some occasional portability issues. whimrepl does not require or support this setting.

Plugin default: "$HOME/.slime_paste"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.preserve_curpos

Whether to preserve cursor position when sending a line or paragraph.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.target

Which backend vim-slime should use.

Plugin default: "screen"

Type: null or one of “dtach”, “kitty”, “neovim”, “screen”, “tmux”, “vimterminal”, “wezterm”, “whimrepl”, “x11”, “zellij” or raw lua code

Default: null

Declared by:

plugins.vim-slime.settings.vimterminal_cmd

The vim terminal command to execute.

Type: null or string or raw lua code

Default: null

Declared by:

vimtex

Url: https://github.com/lervag/vimtex/

Maintainers: Gaetan Lepage

plugins.vimtex.enable

Whether to enable vimtex.

Type: boolean

Default: false

Example: true

Declared by:

plugins.vimtex.package

Which package to use for the vimtex plugin.

Type: package

Default: <derivation vimplugin-vimtex-2024-05-13>

Declared by:

plugins.vimtex.texlivePackage

Which package to use for texlive. Set to null to disable its automatic installation.

Type: null or package

Default: <derivation texlive-combined-medium-2023-final>

Declared by:

plugins.vimtex.settings

The configuration options for vimtex without the vimtex_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal vimtex_foo_bar=1
  • hello = "world" -> :setglobal vimtex_hello="world"
  • some_toggle = true -> :setglobal vimtex_some_toggle
  • other_toggle = false -> :setglobal novimtex_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  compiler_method = "latexrun";
  toc_config = {
    split_pos = "vert topleft";
    split_width = 40;
  };
  view_method = "zathura";
}

Declared by:

plugins.vimtex.settings.view_method

Set the viewer method. By default, a generic viewer is used through the general view method (e.g. xdg-open on Linux).

Type: string

Default: "general"

Example: "zathura"

Declared by:

virt-column

Url: https://github.com/lukas-reineke/virt-column.nvim/

Maintainers: Alison Jenkins

plugins.virt-column.enable

Whether to enable virt-column.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.virt-column.package

Which package to use for the virt-column.nvim plugin.

Type: package

Default: <derivation vimplugin-virt-column.nvim-2023-11-13>

Declared by:

plugins.virt-column.settings

Options provided to the require('virt-column').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  char = "┃";
  enabled = true;
  exclude = {
    buftypes = [
      "nofile"
      "quickfix"
      "terminal"
      "prompt"
    ];
    filetypes = [
      "lspinfo"
      "packer"
      "checkhealth"
      "help"
      "man"
      "TelescopePrompt"
      "TelescopeResults"
    ];
  };
  highlight = "NonText";
  virtcolumn = "";
}

Declared by:

plugins.virt-column.settings.enabled

Enables or disables virt-column.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.virt-column.settings.char

Character, or list of characters, that get used to display the virtual column. Each character has to have a display width of 0 or 1.

Plugin default: ["┃"]

Type: null or string or list of string

Default: null

Declared by:

plugins.virt-column.settings.highlight

Highlight group, or list of highlight groups, that get applied to the virtual column.

Plugin default: NonText

Type: null or string or list of string

Default: null

Declared by:

plugins.virt-column.settings.virtcolumn

Comma-separated list of screen columns same syntax as :help colorcolumn.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.virt-column.settings.exclude.buftypes

List of buftypes for which virt-column is disabled.

Plugin default:

[
  "nofile"
  "quickfix"
  "terminal"
  "prompt"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.virt-column.settings.exclude.filetypes

List of filetypes for which virt-column is disabled.

Plugin default:

[
  "lspinfo"
  "packer"
  "checkhealth"
  "help"
  "man"
  "TelescopePrompt"
  "TelescopeResults"
]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.which-key.enable

Whether to enable which-key.nvim, a plugin that popup with possible key bindings of the command you started typing.

Type: boolean

Default: false

Example: true

Declared by:

plugins.which-key.package

Which package to use for the which-key-nvim plugin.

Type: package

Default: <derivation vimplugin-which-key.nvim-2023-10-20>

Declared by:

plugins.which-key.hidden

hide mapping boilerplate

Plugin default:

["<silent>" "<cmd>" "<Cmd>" "<CR>" "^:" "^ " "^call " "^lua "]

Type: null or (list of string)

Default: null

Declared by:

plugins.which-key.ignoreMissing

enable this to hide mappings for which you didn’t specify a label

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.keyLabels

override the label used to display some keys. It doesn’t effect WK in any other way.

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.which-key.operators

add operators that will trigger motion and text object completion to enable all native operators, set the preset / operators plugin above

Plugin default: {gc = "Comments";}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.which-key.registrations

Manually register the description of mappings.

Type: attribute set of anything

Default: { }

Example:

{
  "<leader>p" = "Find git files with telescope";
}

Declared by:

plugins.which-key.showHelp

show a help message in the command line for using WhichKey

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.showKeys

show the currently pressed key and its label as a message in the command line

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.triggers

automatically setup triggers, or specify a list manually

Plugin default: "auto"

Type: null or value “auto” (singular enum) or list of string

Default: null

Declared by:

plugins.which-key.triggersBlackList

list of mode / prefixes that should never be hooked by WhichKey this is mostly relevant for keymaps that start with a native binding

Plugin default: { i = ["j" "k"]; v = ["j" "k"]}}

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.which-key.triggersNoWait

list of triggers, where WhichKey should not wait for timeoutlen and show immediately

Plugin default: ["" “'” "g" "g'" "\"" "<c-r>" "z="]

Type: null or (list of string)

Default: null

Declared by:

plugins.which-key.disable.buftypes

Disabled by default for Telescope

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.which-key.disable.filetypes

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.which-key.icons.breadcrumb

symbol used in the command line area that shows your active key combo

Plugin default: "»"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.which-key.icons.group

symbol prepended to a group

Plugin default: "+"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.which-key.icons.separator

symbol used between a key and it’s label

Plugin default: "➜"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.which-key.layout.align

Plugin default: "left"

Type: null or one of “left”, “center”, “right” or raw lua code

Default: null

Declared by:

plugins.which-key.layout.spacing

spacing between columns

Plugin default: 3

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.which-key.layout.height

min and max height of the columns

Plugin default: {min = 4; max = 25;}

Type: null or (submodule)

Default: null

Declared by:

plugins.which-key.layout.height.max

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.layout.height.min

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.layout.width

min and max width of the columns

Plugin default: {min = 20; max = 50;}

Type: null or (submodule)

Default: null

Declared by:

plugins.which-key.layout.width.max

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.layout.width.min

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.motions.count

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.marks

shows a list of your marks on ’ and `

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.registers

shows your registers on " in NORMAL or <C-r> in INSERT mode

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.g

bindings for prefixed with g

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.motions

adds help for motions

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.nav

misc bindings to work with windows

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.operators

adds help for operators like d, y, …

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.textObjects

help for text objects triggered after entering an operator

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.windows

default bindings on <c-w>

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.presets.z

bindings for folds, spelling and others prefixed with z

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.spelling.enabled

enabling this will show WhichKey when pressing z= to select spelling suggestions

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.which-key.plugins.spelling.suggestions

how many suggestions should be shown in the list?

Plugin default: 20

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.which-key.popupMappings.scrollDown

binding to scroll down inside the popup

Plugin default: "<c-d>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.which-key.popupMappings.scrollUp

binding to scroll up inside the popup

Plugin default: "<c-u>"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.which-key.window.border

Defines the border to use for which-key. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: none

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.which-key.window.position

Plugin default: "bottom"

Type: null or one of “bottom”, “top” or raw lua code

Default: null

Declared by:

plugins.which-key.window.winblend

0 for fully opaque and 100 for fully transparent

Plugin default: 0

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Declared by:

plugins.which-key.window.margin

extra window margin

Plugin default: {top = 1; right = 0; bottom = 1; left = 0;}

Type: null or (submodule)

Default: null

Declared by:

plugins.which-key.window.margin.bottom

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.margin.left

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.margin.right

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.margin.top

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.padding

extra window padding

Plugin default: {top = 1; right = 2; bottom = 1; left = 2;}

Type: null or (submodule)

Default: null

Declared by:

plugins.which-key.window.padding.bottom

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.padding.left

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.padding.right

This option has no description.

Type: signed integer

Declared by:

plugins.which-key.window.padding.top

This option has no description.

Type: signed integer

Declared by:

plugins.wilder.enable

Whether to enable wilder-nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.wilder.enableCmdlineEnter

If true calls wilder#enable_cmdline_enter(). Creates a new |CmdlineEnter| autocmd to which will start wilder when the cmdline is entered.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.wilder.package

Which package to use for the wilder-nvim plugin.

Type: package

Default: <derivation vimplugin-wilder.nvim-2022-08-13>

Declared by:

plugins.wilder.acceptCompletionAutoSelect

The auto_select option passed to wilder#accept_completion(), if mapped.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.wilder.acceptKey

Mapping to bind to wilder#accept_completion().

NOTE: A string or an attrs (with keys key and fallback) representing the mapping to bind to |wilder#next()|. If a string is provided, it is automatically converted to {key = <KEY>; fallback = <KEY>;}.

  • mapping is the |cmap| used to bind to |wilder#next()|.
  • fallback is the mapping used if |wilder#in_context()| is false.

Plugin default: <Down>

Type: null or string or (submodule)

Default: null

Declared by:

plugins.wilder.beforeCursor

If true, wilder will look only at the part of the cmdline before the cursor, and when selecting a completion, the entire cmdline will be replaced. Only applicable if useCmdlinechanged is false.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.wilder.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.wilder.interval

Interval of the |timer| used to check whether the cmdline has changed, in milliseconds. Only applicable if useCmdlinechanged is false.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.wilder.modes

List of modes which wilderw will be active in. Possible elements: ‘/’, ‘?’ and ‘:’

Plugin default: ["/" "?"]

Type: null or (list of (one of “/”, “?”, “:”))

Default: null

Declared by:

plugins.wilder.nextKey

A key to map to wilder#next() providing next suggestion.

NOTE: A string or an attrs (with keys key and fallback) representing the mapping to bind to |wilder#next()|. If a string is provided, it is automatically converted to {key = <KEY>; fallback = <KEY>;}.

  • mapping is the |cmap| used to bind to |wilder#next()|.
  • fallback is the mapping used if |wilder#in_context()| is false.

Plugin default: <Tab>

Type: null or string or (submodule)

Default: null

Declared by:

plugins.wilder.numWorkers

Number of workers for the Python 3 |remote-plugin|. Has to be set at startup, before wilder is first run. Setting the option after the first run has no effect.

Plugin default: 2

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.wilder.pipeline

Sets the pipeline to use to get completions. See |wilder-pipeline|.

Example:

  [
    \'\'
      wilder.branch(
        wilder.cmdline_pipeline({
          language = 'python',
          fuzzy = 1,
        }),
        wilder.python_search_pipeline({
          pattern = wilder.python_fuzzy_pattern(),
          sorter = wilder.python_difflib_sorter(),
          engine = 're',
        })
      )
    \'\'
  ]

Type: null or (list of lua code string)

Default: null

Declared by:

plugins.wilder.postHook

A function which takes a ctx. This function is called when wilder stops, or when wilder becomes hidden. See |wilder-hidden|.

ctx contains no keys.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.wilder.preHook

A function which takes a ctx. This function is called when wilder starts, or when wilder becomes unhidden. See |wilder-hidden|.

ctx contains no keys.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.wilder.prevKey

A key to map to wilder#prev() providing previous suggestion.

NOTE: A string or an attrs (with keys key and fallback) representing the mapping to bind to |wilder#next()|. If a string is provided, it is automatically converted to {key = <KEY>; fallback = <KEY>;}.

  • mapping is the |cmap| used to bind to |wilder#next()|.
  • fallback is the mapping used if |wilder#in_context()| is false.

Plugin default: <S-Tab>

Type: null or string or (submodule)

Default: null

Declared by:

plugins.wilder.rejectKey

Mapping to bind to wilder#reject_completion().

NOTE: A string or an attrs (with keys key and fallback) representing the mapping to bind to |wilder#next()|. If a string is provided, it is automatically converted to {key = <KEY>; fallback = <KEY>;}.

  • mapping is the |cmap| used to bind to |wilder#next()|.
  • fallback is the mapping used if |wilder#in_context()| is false.

Plugin default: <Up>

Type: null or string or (submodule)

Default: null

Declared by:

plugins.wilder.renderer

Sets the renderer to used to display the completions. See |wilder-renderer|.

Example:

  \'\'
    wilder.wildmenu_renderer({
      -- highlighter applies highlighting to the candidates
      highlighter = wilder.basic_highlighter(),
    })
  \'\'

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.wilder.useCmdlinechanged

If true, wilder will refresh queries when the |CmdlineChanged| autocommand is triggered. Otherwise it will use a |timer| to check whether the cmdline has changed. Using a timer will be more resource intensive.

Default: exists('##CmdlineChanged')

Type: null or boolean

Default: null

Declared by:

plugins.wilder.usePythonRemotePlugin

If true, uses the Python remote plugin. This option can be set to false to disable the Python remote plugin.

This option has to be set before setting the pipeline option and before wilder is first run.

Default: has('python3') && (has('nvim') || exists('*yarp#py3'))

Type: null or boolean

Default: null

Declared by:

plugins.wilder.wildcharm

Key to set the ‘wildcharm’ option to. Can be set to v:false to skip the setting.

Plugin default: &wildchar

Type: null or string or value false (singular enum)

Default: null

Declared by:

plugins.wtf.enable

Whether to enable wtf.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.wtf.package

Which package to use for the wtf.nvim plugin.

Type: package

Default: <derivation vimplugin-wtf.nvim-2024-03-23>

Declared by:

plugins.wtf.additionalInstructions

Any additional instructions.

Type: null or string

Default: null

Declared by:

plugins.wtf.context

Send code as well as diagnostics.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.wtf.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.wtf.language

Set your preferred language for the response.

Plugin default: "english"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.wtf.openaiApiKey

An alternative way to set your API key.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.wtf.openaiModelId

ChatGPT Model.

Plugin default: "gpt-3.5-turbo"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.wtf.popupType

Default AI popup type.

Plugin default: "popup"

Type: null or one of “popup”, “horizontal”, “vertical” or raw lua code

Default: null

Declared by:

plugins.wtf.searchEngine

Default search engine.

Plugin default: "google"

Type: null or one of “google”, “duck_duck_go”, “stack_overflow”, “github” or raw lua code

Default: null

Declared by:

plugins.wtf.winhighlight

Add custom colours.

Plugin default: "Normal:Normal,FloatBorder:FloatBorder"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.wtf.hooks.requestFinished

Callback for request finished.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.wtf.hooks.requestStarted

Callback for request start.

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.wtf.keymaps.ai

Keymap for the ai action.

Type: null or string or (submodule)

Default: null

Declared by:

plugins.wtf.keymaps.search

Keymap for the search action.

Type: null or string or (submodule)

Default: null

Declared by:

plugins.yanky.enable

Whether to enable yanky.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.yanky.package

Which package to use for the yanky.nvim plugin.

Type: package

Default: <derivation vimplugin-yanky.nvim-2024-05-15>

Declared by:

plugins.yanky.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.yanky.highlight.onPut

Define if highlight put text feature is enabled.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.highlight.onYank

Define if highlight yanked text feature is enabled.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.highlight.timer

Define the duration of highlight.

Plugin default: 500

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.yanky.picker.select.action

This define the action that should be done when selecting an item in the vim.ui.select prompt. If you let this option to null, this will use the default action: put selected item after cursor.

This is either:

  • a rawLua value (action.__raw = "function() foo end";).
  • a string. In this case, Nixvim will automatically interpret it as a builtin yanky action. Example: action = "put('p')"; will translate to action = require('yanky.picker').actions.put('p') in lua.

Type: null or raw lua code or string

Default: null

Declared by:

plugins.yanky.picker.telescope.enable

Whether to enable the yank_history telescope picker…

Type: boolean

Default: false

Example: true

Declared by:

plugins.yanky.picker.telescope.mappings

This define or overrides the mappings available in Telescope.

If you set useDefaultMappings to true, mappings will be merged with default mappings.

Example:

  {
    i = {
      "<c-g>" = "put('p')";
      "<c-k>" = "put('P')";
      "<c-x>" = "delete()";
      "<c-r>" = "set_register(require('yanky.utils').get_default_register())";
    };
    n = {
      p = "put('p')";
      P = "put('P')";
      d = "delete()";
      r = "set_register(require('yanky.utils').get_default_register())";
    };
  }

Type: null or (attribute set of attribute set of string)

Default: null

Declared by:

plugins.yanky.picker.telescope.useDefaultMappings

This define if default Telescope mappings should be used.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.preserveCursorPosition.enabled

Whether cursor position should be preserved on yank. This works only if mappings has been defined.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.ring.cancelEvent

Define the event used to cancel ring activation. update will cancel ring on next buffer update, move will cancel ring when moving cursor or content changed.

Plugin default: "update"

Type: null or one of “update”, “move” or raw lua code

Default: null

Declared by:

plugins.yanky.ring.historyLength

Define the number of yanked items that will be saved and used for ring.

Plugin default: 100

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.yanky.ring.ignoreRegisters

Define registers to be ignored. By default the black hole register is ignored.

Plugin default: ["_"]

Type: null or (list of string)

Default: null

Declared by:

plugins.yanky.ring.storage

Define the storage mode for ring values.

Using shada, this will save pesistantly using Neovim ShaDa feature. This means that history will be persisted between each session of Neovim.

You can also use this feature to sync the yank history across multiple running instances of Neovim by updating shada file. If you execute :wshada in the first instance and then :rshada in the second instance, the second instance will be synced with the yank history in the first instance.

Using memory, each Neovim instance will have his own history and il will be lost between sessions.

Sqlite is more reliable than ShaDa but requires more dependencies. You can change the storage path using ring.storagePath option.

Plugin default: "shada"

Type: null or one of “shada”, “sqlite”, “memory” or raw lua code

Default: null

Declared by:

plugins.yanky.ring.storagePath

Only for sqlite storage.

Plugin default: {__raw = "vim.fn.stdpath('data') .. '/databases/yanky.db'";}

Type: null or string or raw lua code

Default: null

Declared by:

plugins.yanky.ring.syncWithNumberedRegisters

History can also be synchronized with numbered registers. Every time the yank history changes the numbered registers 1 - 9 will be updated to sync with the first 9 entries in the yank history. See here for an explanation of why we would want do do this.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.ring.updateRegisterOnCycle

If true, when you cycle through the ring, the contents of the register used to update will be updated with the last content cycled.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.systemClipboard.syncWithRing

Yanky can automatically adds to ring history yanks that occurs outside of Neovim. This works regardless to your &clipboard setting.

This means, if &clipboard is set to unnamed and/or unnamedplus, if you yank something outside of Neovim, you can put it immediately using p and it will be added to your yank ring.

If &clipboard is empty, if you yank something outside of Neovim, this will be the first value you’ll have when cycling through the ring. Basically, you can do p and then <c-p> to paste yanked text.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.yanky.textobj.enabled

Yanky comes with a text object corresponding to last put text. To use it, you have to enable it and set a keymap.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

zellij

Url: https://github.com/Lilja/zellij.nvim/

Maintainers: Haseeb Majid

plugins.zellij.enable

Whether to enable zellij.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.zellij.package

Which package to use for the zellij.nvim plugin.

Type: package

Default: <derivation vimplugin-zellij.nvim-2024-05-03>

Declared by:

plugins.zellij.settings

Options provided to the require('zellij').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  debug = true;
  path = "zellij";
  replaceVimWindowNavigationKeybinds = true;
  vimTmuxNavigatorKeybinds = false;
}

Declared by:

plugins.zellij.settings.debug

Will log things to /tmp/zellij.nvim.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.zellij.settings.path

Path to the zellij binary.

Plugin default: "zellij"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.zellij.settings.replaceVimWindowNavigationKeybinds

Will set keybinds like <C-w>h to left.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.zellij.settings.vimTmuxNavigatorKeybinds

Will set keybinds like <C-h> to left.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

zen-mode

Url: https://github.com/folke/zen-mode.nvim/

Maintainers: Gaetan Lepage

plugins.zen-mode.enable

Whether to enable zen-mode.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.zen-mode.package

Which package to use for the zen-mode.nvim plugin.

Type: package

Default: <derivation vimplugin-zen-mode.nvim-2024-01-21>

Declared by:

plugins.zen-mode.settings

Options provided to the require('zen-mode').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  on_close = ''
    function()
      require("gitsigns.actions").toggle_current_line_blame()
      vim.cmd('IBLEnable')
      vim.opt.relativenumber = true
      vim.opt.signcolumn = "yes:2"
      require("gitsigns.actions").refresh()
    end
  '';
  on_open = ''
    function()
      require("gitsigns.actions").toggle_current_line_blame()
      vim.cmd('IBLDisable')
      vim.opt.relativenumber = false
      vim.opt.signcolumn = "no"
      require("gitsigns.actions").refresh()
    end
  '';
  plugins = {
    gitsigns = {
      enabled = true;
    };
    options = {
      enabled = true;
      ruler = false;
      showcmd = false;
    };
    tmux = {
      enabled = false;
    };
    twilight = {
      enabled = false;
    };
  };
  window = {
    backdrop = 0.95;
    height = 1;
    options = {
      signcolumn = "no";
    };
    width = 0.8;
  };
}

Declared by:

plugins.zen-mode.settings.on_close

Callback where you can add custom code when the Zen window closes.

Plugin default: function(win) end

Type: null or lua function string

Default: null

Declared by:

plugins.zen-mode.settings.on_open

Callback where you can add custom code when the Zen window opens.

Plugin default: function(win) end

Type: null or lua function string

Default: null

Declared by:

plugins.zen-mode.settings.plugins.options

Disable some global vim options (vim.o…).

Plugin default:

{
  enabled = true;
  ruler = false;
  showcmd = false;
  laststatus = 0;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.zen-mode.settings.window.backdrop

Shade the backdrop of the Zen window. Set to 1 to keep the same as Normal.

Plugin default: 0.95

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.zen-mode.settings.window.height

Height of the Zen window.

Can be:

  • an absolute number of cells when > 1
  • a percentage of the width / height of the editor when <= 1
  • a function that returns the width or the height

Plugin default: 1

Type: null or positive integer, meaning >0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code

Default: null

Declared by:

plugins.zen-mode.settings.window.options

By default, no options are changed for the Zen window. You can set any vim.wo option here.

Example:

  {
    signcolumn = "no";
    number = false;
    relativenumber = false;
    cursorline = false;
    cursorcolumn = false;
    foldcolumn = "0";
    list = false;
  }

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.zen-mode.settings.window.width

Width of the zen window.

Can be:

  • an absolute number of cells when > 1
  • a percentage of the width / height of the editor when <= 1
  • a function that returns the width or the height

Plugin default: 120

Type: null or positive integer, meaning >0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code

Default: null

Declared by:

zig

Url: https://github.com/ziglang/zig.vim/

Maintainers: Gaetan Lepage

plugins.zig.enable

Whether to enable zig.vim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.zig.package

Which package to use for the zig plugin.

Type: package

Default: <derivation vimplugin-zig.vim-2023-10-10>

Declared by:

plugins.zig.settings

The configuration options for zig without the zig_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal zig_foo_bar=1
  • hello = "world" -> :setglobal zig_hello="world"
  • some_toggle = true -> :setglobal zig_some_toggle
  • other_toggle = false -> :setglobal nozig_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  fmt_autosave = false;
}

Declared by:

plugins.zig.settings.fmt_autosave

This plugin enables automatic code formatting on save by default using zig fmt. To disable it, you can set this option to false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.zk.enable

Whether to enable zk.nvim, a plugin to integrate with zk.

Type: boolean

Default: false

Example: true

Declared by:

plugins.zk.package

Which package to use for the zk.nvim plugin.

Type: package

Default: <derivation vimplugin-zk-nvim-2024-04-14>

Declared by:

plugins.zk.picker

it’s recommended to use “telescope” or “fzf”

Plugin default: "select"

Type: null or one of “select”, “fzf”, “telescope” or raw lua code

Default: null

Declared by:

plugins.zk.lsp.autoAttach.enabled

automatically attach buffers in a zk notebook

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.zk.lsp.autoAttach.filetypes

matching the given filetypes

Plugin default: ["markdown"]

Type: null or (list of string)

Default: null

Declared by:

plugins.zk.lsp.config.cmd

Plugin default: ["zk" "lsp"]

Type: null or (list of string)

Default: null

Declared by:

plugins.zk.lsp.config.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.zk.lsp.config.name

Plugin default: "zk"

Type: null or string or raw lua code

Default: null

Declared by:

Contributing (and hacking onto) nixvim

This document is mainly for contributors to nixvim, but it can also be useful for extending nixvim.

Submitting a change

In order to submit a change you must be careful of several points:

  • The code must be properly formatted. This can be done through nix fmt.
  • The tests must pass. This can be done through nix flake check --all-systems (this also checks formatting).
  • The change should try to avoid breaking existing configurations.
  • If the change introduces a new feature it should add tests for it (see the architecture section for details).
  • The commit title should be consistent with our style. This usually looks like "plugins/: fixed some bug", you can browse the commit history of the files you're editing to see previous commit messages.

Nixvim Architecture

Nixvim is mainly built around pkgs.neovimUtils.makeNeovimConfig. This function takes a list of plugins (and a few other misc options), and generates a configuration for neovim. This can then be passed to pkgs.wrapNeovimUnstable to generate a derivation that bundles the plugins, extra programs and the lua configuration.

All the options that nixvim expose end up in those three places. This is done in the modules/output.nix file.

The guiding principle of nixvim is to only add to the init.lua what the user added to the configuration. This means that we must trim out all the options that were not set.

This is done by making most of the options of the type types.nullOr ...., and not setting any option that is null.

Plugin configurations

Most of nixvim is dedicated to wrapping neovim plugins such that we can configure them in Nix. To add a new plugin you need to do the following.

  1. Add a file in the correct sub-directory of plugins. This depends on your exact plugin.

The vast majority of plugins fall into one of those two categories:

  • vim plugins: They are configured through global variables (g:plugin_foo_option in vimscript and vim.g.plugin_foo_option in lua).
    For those, you should use the helpers.vim-plugin.mkVimPlugin.
    -> See this plugin for an example.
  • neovim plugins: They are configured through a setup function (require('plugin').setup({opts})).
    For those, you should use the helpers.neovim-plugin.mkNeovimPlugin.
    -> See the template.
  1. Add the necessary parameters for the mkNeovimPlugin/mkVimPlugin:
  • name: The name of the plugin. The resulting nixvim module will have plugins.<name> as a path.
    For a plugin named foo-bar.nvim, set this to foo-bar (subject to exceptions).
  • originalName: The "real" name of the plugin (i.e. foo-bar.nvim). This is used mostly in documentation.
  • defaultPackage: The nixpkgs package for this plugin (e.g. pkgs.vimPlugins.foo-bar-nvim).
  • maintainers: Register yourself as a maintainer for this plugin:
    • [lib.maintainers.JosephFourier] if you are already registered as a nixpkgs maintainer
    • [helpers.maintainers.GaspardMonge] otherwise. (Also add yourself to maintainers.nix)
  • settingsOptions: All or some (only the most important ones) option declarations for this plugin settings.
    See below for more information
  • settingsExample: An example of what could the settings attrs look like.

Declaring plugin options

You will then need to add Nix options for all (or some) of the upstream plugin options. These option declarations should be in settingsOptions and their names should match exactly the upstream plugin. There are a number of helpers to help you correctly implement them:

  • helpers.defaultNullOpts.{mkBool,mkInt,mkStr,...}: This family of helpers takes a default value and a description, and sets the Nix default to null. These are the main functions you should use to define options.
  • helpers.defaultNullOpts.mkNullable: This takes a type, a default and a description. This is useful for more complex options.
  • helpers.nixvimTypes.rawLua: A type to represent raw lua code. The values are of the form { __raw = "<code>";}. This should not be used if the option can only be raw lua code, mkLua/mkLuaFn should be used in this case.

The resulting settings attrs will be directly translated to lua and will be forwarded the plugin:

  • Using globals (vim.g.<globalPrefix><option-name>) for plugins using mkVimPlugin
  • Using the require('<plugin>').setup() function for the plugins using mkNeovimPlugin

In either case, you don't need to bother implementing this part. It is done automatically.

[!NOTE] Learn more about the RFC 42 which motivated this new approach.

Tests

Most of the tests of nixvim consist of creating a neovim derivation with the supplied nixvim configuration, and then try to execute neovim to check for any output. All output is considered to be an error.

The tests are located in the tests/test-sources directory, and should be added to a file in the same hierarchy than the repository. For example if a plugin is defined in ./plugins/ui/foo.nix the test should be added in ./tests/test-sources/ui/foo.nix.

Tests can either be a simple attribute set, or a function taking {pkgs} as an input. The keys of the set are configuration names, and the values are a nixvim configuration.

You can specify the special tests attribute in the configuration that will not be interpreted by nixvim, but only the test runner. The following keys are available:

  • tests.dontRun: avoid launching this test, simply build the configuration.

The tests are then runnable with nix flake check --all-systems.

There are a second set of tests, unit tests for nixvim itself, defined in tests/lib-tests.nix that use the pkgs.lib.runTests framework.

If you want to speed up tests, we have set up a Cachix for nixvim. This way, only tests whose dependencies have changed will be re-run, speeding things up considerably. To use it, just install cachix and run cachix use nix-community.