Appendix A. Configuration options

Enable auto indent

Type: boolean

Declared by:

enable autocomplete

Type: boolean

Default: false

Declared by:

Set the autocomplete plugin. Options: [nvim-cmp] nvim-compe

Type: one of "nvim-compe", "nvim-cmp"

Default: "nvim-cmp"

Declared by:

enable autopairs

Type: boolean

Declared by:

Whether to check treesitter for a pair

Type: boolean

Declared by:

Set the autopairs type. Options: nvim-autopairs [nvim-autopairs]

Type: value "nvim-autopairs" (singular enum)

Declared by:

Set how bells are handled. Options: on, visual or none

Type: one of "none", "visual", "on"

Declared by:

Enable ChatGPT.nvim plugin

Type: boolean

Declared by:

The OpenAI API KEY (can also be set as an env variable)

Type: null or string

Default: null

Declared by:

Defines 'Command-line mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Height of the command pane

Type: signed integer

Declared by:

Defines 'Command-line mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Set terminal up for 256 colours

Type: boolean

Declared by:

enable comments plugin

Type: boolean

Default: false

Declared by:

Set the comments plugin. Options: [nerdcommenter] [kommentary]

Type: one of "nerdcommenter", "kommentary"

Default: "nerdcommenter"

Declared by:

vimrc contents

Type: strings concatenated with "\n"

Default: ""

Declared by:

List of custom scripts

Type: list of package

Default: [ ]

Declared by:

Enable dial.nvim plugin (enhanced incr/decr)

Type: boolean

Declared by:

Set to prevent arrow keys from moving cursor

Type: boolean

Declared by:

Enable nvim-tree-lua

Type: boolean

Default: false

Declared by:

Close the tree when a file is opened

Type: boolean

Default: false

Declared by:

Close when tree is last window open

Type: boolean

Default: true

Declared by:

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

Follow file that is in current buffer on tree

Type: boolean

Default: true

Declared by:

Compact empty folders trees into a single item

Type: boolean

Default: true

Declared by:

Hide dotfiles

Type: boolean

Default: false

Declared by:

Files to hide in the file view by default.

Type: list of string

Default:

[
  ".git"
  "node_modules"
  ".cache"
]

Declared by:

Hide files ignored by git

Type: boolean

Default: false

Declared by:

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

Ignore file types

Type: list of string

Default: [ ]

Declared by:

Show indent markers

Type: boolean

Default: true

Declared by:

Shows lsp diagnostics in the tree

Type: boolean

Default: true

Declared by:

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

Opens the tree view when opening a new tab

Type: boolean

Default: false

Declared by:

Resize the tree window when a file is opened

Type: boolean

Default: false

Declared by:

Add a trailing slash to all folders

Type: boolean

Default: true

Declared by:

Side the tree will appear on left or right

Type: one of "left", "right"

Default: "left"

Declared by:

Width of the tree in charecters

Type: signed integer

Default: 25

Declared by:

Enable Cellular Automaton

Type: boolean

Default: false

Declared by:

Enable git plugins

Type: boolean

Declared by:

Enable git options

Type: boolean

Declared by:

Set containing global variable values

Type: attribute set

Default: { }

Declared by:

Hide search highlight so it doesn't stay highlighted

Type: boolean

Declared by:

Enable Hop plugin (easy motion)

Type: boolean

Declared by:

Defines 'Insert and Replace mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Insert and Replace mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Whether to enable key binding plugins.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable which-key menu.

Type: boolean

Default: false

Example: true

Declared by:

How line numbers are displayed. none, relative, number, relNumber

Type: one of "relative", "number", "relNumber", "none"

Declared by:

Whether to enable neovim lsp support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable C language LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Dhall LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Elm LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Folds via nvim-ufo.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Format on save.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Go language LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Haskell LSP (hls).

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable lightbulb for code actions. Requires emoji font.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable lsp signature viewer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable LSP Saga.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Nix LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to use `nil` or `rnix-lsp`

Type: one of "nil", "rnix-lsp"

Default: "rnix-lsp"

Declared by:

Whether to enable nvim code action menu.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Python LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Rust LSP.

Type: boolean

Default: false

Example: true

Declared by:

options to pass to rust analyzer

Type: string

Default:

''
  ["rust-analyzer"] = {
    experimental = {
      procAttrMacros = true,
    },
  },
''

Declared by:

Whether to enable Scala LSP (Metals).

Type: boolean

Default: false

Example: true

Declared by:

The Metals package to use. Default pkgs.metals.

Type: package

Default: <derivation metals-0.11.11>

Declared by:

Whether to enable Smithy Language LSP.

Type: boolean

Default: false

Example: true

Declared by:

The launcher of the LSP server

Type: package

Default: <derivation coursier-2.1.0>

Declared by:

The Smithy LSP server dependency (usually a jar)

Type: string

Default: "com.disneystreaming.smithy:smithy-language-server"

Declared by:

The Smithy LSP server dependency version

Type: string

Default: "0.0.20"

Declared by:

Whether to enable SQL Language LSP.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable trouble diagnostics viewer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable TS language LSP.

Type: boolean

Default: false

Example: true

Declared by:

vim lua config

Type: strings concatenated with "\n"

Default: ""

Declared by:

Map the `C-z` key to clear highlight search

Type: boolean

Declared by:

Map the space key to leader key

Type: boolean

Declared by:

Timeout in ms that neovim will wait for mapped action to complete

Type: signed integer

Declared by:

Whether to enable markdown tools and plugins.

Type: boolean

Default: false

Example: true

Declared by:

Enable markdown preview in neovim with glow

Type: boolean

Default: true

Declared by:

Enable Mind plugin

Type: boolean

Default: false

Declared by:

Directory for the Mind data files created by the user

Type: string

Default: "~/.local/share/mind.nvim/data"

Declared by:

Application state file: mind.json

Type: string

Default: "~/.local/share/mind.nvim/mind.json"

Declared by:

Set modes for mouse support. a - all, n - normal, v - visual, i - insert, c - command

Type: one of "a", "n", "v", "i", "c"

Declared by:

Enable nvim-neoclip.lua plugin

Type: boolean

Declared by:

The NeoVim package to use. Default pkgs.neovim-unwrapped.

Type: package

Default: <derivation neovim-unwrapped-0.8.3>

Example: "pkgs.neovim-nightly"

Declared by:

Defines 'Normal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Normal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Enable the nvim-notify plugin

Type: boolean

Declared by:

Defines 'Operator pending mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Operator pending mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

List of plugins to optionally load

Type: list of package

Default: [ ]

Declared by:

Enable PlantUML syntax highlights

Type: boolean

Default: false

Declared by:

Prevent swapfile, backupfile from being created

Type: boolean

Declared by:

Type: attribute set of (submodule)

Default: { }

Example:

{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }

Declared by:

Type: boolean

Default: true

Declared by:

Type: path

Declared by:

Type: string

Declared by:

Type: null or strings concatenated with "\n"

Default: null

Declared by:

Start scrolling this number of lines from the top or bottom of the page.

Type: signed integer

Declared by:

Whether to enable enable shortcuts.

Type: boolean

Default: false

Example: true

Declared by:

Show the sign column

Type: boolean

Declared by:

Defines 'Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Whether to enable Enable vim-vsnip.

Type: boolean

Default: false

Example: true

Declared by:

Defines 'Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Enables spell-checker on markdown files

Type: boolean

Declared by:

Enable the nvim-spider plugin

Type: boolean

Declared by:

Plugin setting

Type: boolean

Default: true

Declared by:

New splits will open below instead of on top

Type: boolean

Declared by:

New splits will open to the right

Type: boolean

Declared by:

start of vimrc contents

Type: strings concatenated with "\n"

Default: ""

Declared by:

start of vim lua config

Type: strings concatenated with "\n"

Default: ""

Declared by:

List of plugins to startup

Type: list of (null or package)

Default: [ ]

Declared by:

Enable lualine

Type: boolean

Declared by:

active config for: | (A) | B | C X | Y | Z |

Type: string

Declared by:

active config for: | A | (B) | C X | Y | Z |

Type: string

Declared by:

active config for: | A | B | (C) X | Y | Z |

Type: string

Declared by:

active config for: | A | B | C (X) | Y | Z |

Type: string

Declared by:

active config for: | A | B | C X | (Y) | Z |

Type: string

Declared by:

active config for: | A | B | C X | Y | (Z) |

Type: string

Declared by:

Component separator for left side

Type: string

Declared by:

Component separator for right side

Type: string

Declared by:

Enable icons for lualine

Type: boolean

Declared by:

inactive config for: | (A) | B | C X | Y | Z |

Type: string

Declared by:

inactive config for: | A | (B) | C X | Y | Z |

Type: string

Declared by:

inactive config for: | A | B | (C) X | Y | Z |

Type: string

Declared by:

inactive config for: | A | B | C (X) | Y | Z |

Type: string

Declared by:

inactive config for: | A | B | C X | (Y) | Z |

Type: string

Declared by:

inactive config for: | A | B | C X | Y | (Z) |

Type: string

Declared by:

Section separator for left side

Type: string

Declared by:

Section separator for right side

Type: string

Declared by:

Theme for lualine

Type: one of "auto", "16color", "gruvbox", "ayu_dark", "ayu_light", "ayu_mirage", "codedark", "dracula", "everforest", "gruvbox", "gruvbox_light", "gruvbox_material", "horizon", "iceberg_dark", "iceberg_light", "jellybeans", "material", "modus_vivendi", "molokai", "nightfly", "nord", "oceanicnext", "onedark", "onelight", "palenight", "papercolor_dark", "papercolor_light", "powerline", "seoul256", "solarized_dark", "tomorrow", "wombat", "catppuccin", "tokyonight", "nightfox", "rose-pine", "rose-pine-alt"

Declared by:

Enable nvim-surround plugin

Type: boolean

Default: true

Declared by:

Enable syntax highlighting

Type: boolean

Declared by:

Set the width of tabs

Type: signed integer

Declared by:

Whether to enable bufferline.nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable enable telescope.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable enable telescope-media-files extension.

Type: boolean

Default: false

Example: true

Declared by:

Enable Theme

Type: boolean

Declared by:

Name of theme to use: "catppuccin" "nightfox" "onedark" "rose-pine" "tokyonight"

Type: one of "catppuccin", "nightfox", "onedark", "rose-pine", "tokyonight"

Default: "onedark"

Declared by:

Theme style: "storm", darker variant "night", and "day"

Type: one of "dark", "darker", "cool", "deep", "warm", "warmer"

Declared by:

Background transparency

Type: boolean

Declared by:

Defines 'Terminal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Terminal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Whether to enable todo-comments.

Type: boolean

Default: false

Example: true

Declared by:

vim regex pattern used for highlighting comments

Type: string

Default: "[[.*<(KEYWORDS)(\\([^\\)]*\\))?:]]"

Declared by:

ripgrep regex pattern used for searching comments

Type: string

Default: "[[\\b(KEYWORDS)(\\([^\\)]*\\))?:]]"

Declared by:

enable tree-sitter [nvim-treesitter]

Type: boolean

Declared by:

enable autoclose and rename html tag [nvim-ts-autotag]

Type: boolean

Declared by:

enable function context [nvim-treesitter-context]

Type: boolean

Declared by:

enable fold with tree-sitter

Type: boolean

Declared by:

enable nvim-treesitter-textobjects and its default configuration

Type: boolean

Declared by:

The number of milliseconds till Cursor Hold event is fired

Type: signed integer

Declared by:

Make use of the clipboard for default yank and paste operations. Don't use * and +

Type: boolean

Declared by:

Enable vi alias

Type: boolean

Default: true

Declared by:

Enable vim alias

Type: boolean

Default: true

Declared by:

visual enhancements

Type: boolean

Declared by:

enable word and delayed line highlight [nvim-cursorline]

Type: boolean

Declared by:

time in milliseconds for cursorline to appear

Type: signed integer

Declared by:

enable indentation guides [indent-blankline]

Type: boolean

Declared by:

Character at end of line

Type: string

Declared by:

Character to fill indents

Type: string

Declared by:

Character for indentation line

Type: string

Declared by:

Highlight current context from treesitter

Type: boolean

Declared by:

enable vscode-like pictograms for lsp [lspkind]

Type: boolean

Declared by:

enable dev icons. required for certain plugins [nvim-web-devicons]

Type: boolean

Declared by:

Defines 'Visual and Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Visual and Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Enable word wrapping.

Type: boolean

Declared by:

Defines 'Visual mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

Defines 'Visual mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by: