Appendix A. Configuration Options

Whether to enable Enable GitHub Copilot.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable TabNine assistant.

Type: boolean

Default: false

Example: true

Declared by:

Enable auto indent

Type: boolean

Default: true

Declared by:

enable autocomplete

Type: boolean

Default: false

Declared by:

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

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

Default: "nvim-cmp"

Declared by:

enable autopairs

Type: boolean

Default: false

Declared by:

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

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

Default: "nvim-autopairs"

Declared by:

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

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

Default: "none"

Declared by:

Whether to enable Searchable cheatsheet for nvim using telescope.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable which-key menu.

Type: boolean

Default: false

Example: true

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

Default: 1

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

Default: true

Declared by:

vimrc contents

Type: DAG of strings concatenated with "\n"

Default: { }

Declared by:

Whether to enable alpha.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable dashboard-nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable startify.

Type: boolean

Default: false

Example: true

Declared by:

List of book marks to disaply on start page

Type: list of (attribute set)

Default: [ ]

Example:

{
  c = "~/.vimrc";
}

Declared by:

Command to change the current window with. Can be cd, lcd or tcd

Type: one of "cd", "lcd", "tcd"

Default: "lcd"

Declared by:

Should vim change to the directory of the file you open

Type: boolean

Default: true

Declared by:

Should vim change to the version control root when opening a file

Type: boolean

Default: false

Declared by:

Commands that are presented to the user on startify page

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

Default: [ ]

Declared by:

Text to place in the footer

Type: list of string

Default: [ ]

Declared by:

Text to place in the header

Type: list of string

Default: [ ]

Declared by:

Specify a list of default charecters to use instead of numbers

Type: list of string

Default: [ ]

Declared by:

Prevent startify from opening on startup but can be called with :Startify

Type: boolean

Default: false

Declared by:

How many files to list

Type: signed integer

Default: 10

Declared by:

Specify the lists and in what order they are displayed on startify.

Type: list of (attribute set)

Default:

[
  {
    header = [
      "MRU"
    ];
    type = "files";
  }
  {
    header = [
      "MRU Current Directory"
    ];
    type = "dir";
  }
  {
    header = [
      "Sessions"
    ];
    type = "sessions";
  }
  {
    header = [
      "Bookmarks"
    ];
    type = "bookmarks";
  }
  {
    header = [
      "Commands"
    ];
    type = "commands";
  }
]

Declared by:

Number of spaces used for left padding.

Type: signed integer

Default: 3

Declared by:

Make startify auto load Session.vim files from the current directory

Type: boolean

Default: false

Declared by:

Commands to run before saving a session

Type: list of string

Default: [ ]

Declared by:

Delete all buffers when loading or closing a session

Type: boolean

Default: true

Declared by:

Directory to save and load sessions from

Type: string

Default: "~/.vim/session"

Declared by:

Persist session before leaving vim or switching session

Type: boolean

Default: false

Declared by:

Patterns to remove from session files

Type: list of string

Default: [ ]

Declared by:

List of commands to run when loading a session.

Type: list of string

Default: [ ]

Declared by:

List of variables to save into a session file.

Type: list of string

Default: [ ]

Declared by:

Set if you want items sorted by date rather than alphabetically

Type: boolean

Default: false

Declared by:

List of regex patterns to exclude from MRU lists

Type: list of string

Default: [ ]

Declared by:

List of vim servers to not load startify for

Type: list of string

Default: [ ]

Declared by:

Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list

Type: boolean

Default: false

Declared by:

Set if you want startify to always update and not just when neovim closes

Type: boolean

Default: false

Declared by:

Show environment variables in path if name is shorter than value

Type: boolean

Default: false

Declared by:

Set to prevent arrow keys from moving cursor

Type: boolean

Default: false

Declared by:

Enable nvim-tree-lua

Type: boolean

Default: false

Declared by:

Quit the tree when opening a file

Type: boolean

Default: false

Declared by:

Resize the tree when opening a file

Type: boolean

Default: true

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:

Enable filesystem watchers

Type: boolean

Default: true

Declared by:

Follow file that is in current buffer on tree

Type: boolean

Default: true

Declared by:

Whether to enable Git integration.

Type: boolean

Default: false

Example: true

Declared by:

Ignore files in git

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:

Hijack the cursor in the tree to put it at the start of the filename

Type: boolean

Default: true

Declared by:

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

Open nvimtree in place of the unnamed buffer if it's empty.

Type: boolean

Default: false

Declared by:

Ignore file types

Type: list of string

Default: [ ]

Declared by:

Ignore file types on setup

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:

Compact empty folders trees into a single item

Type: boolean

Default: false

Declared by:

Highlight opened files

Type: one of "none", "icon", "name", "all"

Default: "none"

Declared by:

Highlight git related files

Type: boolean

Default: false

Declared by:

Default icon

Type: string

Default: ""

Declared by:

Closed folder arrow icon

Type: string

Default: ""

Declared by:

Open folder arrow icon

Type: string

Default: ""

Declared by:

Default folder icon

Type: string

Default: ""

Declared by:

Empty folder icon

Type: string

Default: ""

Declared by:

Empty open folder icon

Type: string

Default: ""

Declared by:

Open folder icon

Type: string

Default: ""

Declared by:

Symlink folder icon

Type: string

Default: ""

Declared by:

Symlink open folder icon

Type: string

Default: ""

Declared by:

Deleted git icon

Type: string

Default: ""

Declared by:

Ignored git icon

Type: string

Default: "◌"

Declared by:

Renamed git icon

Type: string

Default: "➜"

Declared by:

Staged git icon

Type: string

Default: "✓"

Declared by:

Unmerged git icon

Type: string

Default: ""

Declared by:

Unstaged git icon

Type: string

Default: "✗"

Declared by:

Untracked git icon

Type: string

Default: "★"

Declared by:

Symlink icon

Type: string

Default: ""

Declared by:

Show file icons

Type: boolean

Default: true

Declared by:

Show folder icons

Type: boolean

Default: true

Declared by:

Show folder arrow icons

Type: boolean

Default: true

Declared by:

Show git icons

Type: boolean

Default: false

Declared by:

Show indent markers

Type: boolean

Default: false

Declared by:

Show hidden files

Type: boolean

Default: true

Declared by:

Show parent folder

Type: boolean

Default: false

Declared by:

Add a trailing slash to all folders

Type: boolean

Default: false

Declared by:

Changes the tree root directory on `DirChanged` and refreshes the tree

Type: boolean

Default: true

Declared by:

The command used to open a file with the associated default program

Type: string

Default: "\${pkgs.xdg-utils}/bin/xdg-open"

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:

Updates the tree when changing nvim's directory (DirChanged event).

Type: boolean

Default: true

Declared by:

Updates the tree when changing nvim's directory (DirChanged event).

Type: attribute set of (boolean or attribute set of boolean)

Default:

{
  enable = true;
  update_cwd = true;
}

Declared by:

Resize the tree when the window is resized

Type: boolean

Default: true

Declared by:

Hide the root folder

Type: boolean

Default: false

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: 35

Declared by:

Whether to enable Enable GitHub Copilot.

Type: boolean

Default: false

Example: true

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

Default: false

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:

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

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

Default: "relNumber"

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 C syntax header files.

Type: boolean

Default: false

Example: true

Declared by:

Type: string

Default: ""

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 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:

Which nix formatter to use

Type: one of "nixpkgs-fmt", "alejandra"

Default: "alejandra"

Declared by:

The LSP package to use

Type: package

Default: <derivation nil-unstable-2023-02-04>

Declared by:

Which LSP to use

Type: one of "rnix", "nil"

Default: "nil"

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 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:

Whether to enable Zig language LSP.

Type: boolean

Default: false

Example: true

Declared by:

vim lua config

Type: DAG of strings concatenated with "\n"

Default: { }

Declared by:

Map the space key to leader key

Type: boolean

Default: true

Declared by:

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

Type: signed integer

Default: 500

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:

Whether to enable Enable minimap-vim plugin.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable minimap-vim plugin.

Type: boolean

Default: false

Example: true

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"

Default: "a"

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:

Whether to enable Complementary neovim plugins for Obsidian editor.

Type: boolean

Default: false

Example: true

Declared by:

If using nvim-cmp, otherwise set to false

Type: boolean

Declared by:

Obsidian vault directory

Type: string

Default: "~/my-vault"

Declared by:

Whether to enable Neovim plugin for Emac Orgmode. Get the best of both worlds..

Type: boolean

Default: false

Example: true

Declared by:

List of org files to be used as agenda files.

Type: string

Default: "{'~/Dropbox/org/*', '~/my-orgs/**/*'}"

Declared by:

Default org file to be used for notes.

Type: string

Default: "~/Dropbox/org/refile.org"

Declared by:

Whether to enable Enable nvim-notify plugin.

Type: boolean

Default: false

Example: true

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 (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "colorizer", "venn-nvim", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim" or package)

Default: [ ]

Declared by:

Whether to enable Enable presence.nvim plugin.

Type: boolean

Default: false

Example: true

Declared by:

Prevent swapfile, backupfile from being created

Type: boolean

Default: false

Declared by:

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

Type: signed integer

Default: 8

Declared by:

Whether to enable Enable nvim-session-manager.

Type: boolean

Default: false

Example: true

Declared by:

Show the sign column

Type: boolean

Default: true

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:

New splits will open below instead of on top

Type: boolean

Default: true

Declared by:

New splits will open to the right

Type: boolean

Default: true

Declared by:

List of plugins to startup.

Type: list of (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "colorizer", "venn-nvim", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim" 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", "onelight", "palenight", "papercolor_dark", "papercolor_light", "powerline", "seoul256", "solarized_dark", "tomorrow", "wombat", "onedark"

Declared by:

Enable syntax highlighting

Type: boolean

Default: true

Declared by:

Set the width of tabs

Type: signed integer

Default: 4

Declared by:

Whether to enable nvim-bufferline-lua.

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 toggleterm as a replacement to built-in terminal command.

Type: boolean

Default: false

Example: true

Declared by:

Enable winbar

Type: boolean

Default: false

Declared by:

Direction of the terminal

Type: one of "horizontal", "vertical", "tab", "float"

Default: "float"

Declared by:

Enable Theme

Type: boolean

Declared by:

Additional lua configuration to add before setup

Type: strings concatenated with "\n"

Declared by:

Supported themes can be found in `supported_themes.nix`

Type: one of "catppuccin", "onedark", "tokyonight"

Declared by:

Specific style for theme if it supports it

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

Declared by:

Whether to enable tidal tools and plugins.

Type: boolean

Default: false

Example: true

Declared by:

When sending a paragraph or a single line, vim-tidal will "flash" the selection for some milliseconds

Type: signed integer

Default: 150

Declared by:

Automatically run the supercollider CLI, sclang, alongside the Tidal GHCI terminal.

Type: boolean

Default: true

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:

enable tree-sitter [nvim-treesitter]

Type: boolean

Default: false

Declared by:

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

Type: boolean

Default: false

Declared by:

enable function context [nvim-treesitter-context]

Type: boolean

Default: false

Declared by:

enable fold with tree-sitter

Type: boolean

Default: false

Declared by:

List of treesitter grammars to install. When enabling a language, its treesitter grammar is added for you.

Type: list of package

Default:

[
  <derivation c-grammar-7175a6d>
  <derivation cpp-grammar-56cec4c>
  <derivation nix-grammar-6b71a81>
  <derivation python-grammar-9e53981>
  <derivation rust-grammar-f7fb205>
  <derivation markdown-grammar-abea13b>
  <derivation comment-grammar-a37ca37>
  <derivation toml-grammar-8bd2056>
  <derivation make-grammar-a4b9187>
  <derivation tsx-grammar-5d20856>
  <derivation html-grammar-29f53d8>
  <derivation javascript-grammar-15e85e8>
  <derivation css-grammar-769203d>
  <derivation graphql-grammar-5e66e96>
  <derivation json-grammar-7307675>
  <derivation zig-grammar-b0693dd>
]

Declared by:

Whether to enable noice-nvim.

Type: boolean

Default: false

Example: true

Declared by:

The number of milliseconds till Cursor Hold event is fired

Type: signed integer

Default: 300

Declared by:

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

Type: boolean

Default: true

Declared by:

Whether to enable ccc color picker for neovim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Nerdfonts icon picker for nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable draw ASCII diagrams in Neovim.

Type: boolean

Default: false

Example: true

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 cellular automaton [cellular-automaton]

Type: boolean

Default: false

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:

enable scrollbar [scrollbar.nvim]

Type: boolean

Declared by:

enable smooth scrolling [cinnamon-nvim]

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

Default: true

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: