Appendix A. Configuration Options

Follow editorconfig rules in current directory

Type: boolean

Default: false

Declared by:

Whether to enable Enable GitHub Copilot.

Type: boolean

Default: false

Example: true

Declared by:

Path to nodejs

Type: string

Default: "\${pkgs.nodejs-slim-16_x.out}/bin/node"

Declared by:

Enable auto indent

Type: boolean

Default: true

Declared by:

enable autocomplete

Type: boolean

Default: false

Declared by:

The function used to customize the appearance of the completion menu.

If vim.lsp.lspkind.enable is true, then the function will be called before modifications from lspkind.

Default is to call the menu mapping function.

Type: string

Default: "nvim_cmp_menu_map"

Example:

--- 
function(entry, vim_item) 
  return vim_item 
end 
---

Declared by:

Attribute set of source names for nvim-cmp.

If an attribute set is provided, then the menu value of vim_item in the format will be set to the value (if utilizing the nvim_cmp_menu_map function).

Note: only use a single attribute name per attribute set

Type: attribute set of (null or string)

Default: { }

Example:

''
  {nvim-cmp = null; buffer = "[Buffer]";}
''

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:

auto select first item

Type: boolean

Default: false

Declared by:

auto insert `(` after select function or method item

Type: boolean

Default: true

Declared by:

map <CR> on insert mode

Type: boolean

Default: true

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 Enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable which-key keybind 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:

Whether to enable Enable comment-nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable kommentary.

Type: boolean

Default: false

Example: true

Declared by:

vimrc contents

Type: DAG of strings concatenated with "\n"

Default: { }

Declared by:

Whether to enable Enable alpha.nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable dashboard.nvim.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable vim-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:

Whether to enable Enable debug mode.

Type: boolean

Default: false

Example: true

Declared by:

Set the debug level

Type: signed integer

Default: 20

Declared by:

Set the log file

Type: path

Default: "/tmp/nvim.log"

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:

Change directory when changing nvim's directory (DirChanged event).

Type: boolean

Default: true

Declared by:

Exclude files from expand all

Type: list of string

Default: [ ]

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:

Whether to enable Window picker.

Type: boolean

Default: false

Example: true

Declared by:

A string of chars used as identifiers by the window picker

Type: string

Default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

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

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:

[
  "node_modules"
  ".cache"
]

Declared by:

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

Type: boolean

Default: false

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

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:

Root folder label. Set null to disable

Type: null or string

Default: null

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:

Sort by name or extension

Type: one of "name", "extension", "modification_time", "case_sensitive"

Default: "name"

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:

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:

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 gesture-nvim plugin.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Git support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable gitsigns.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable gitsigns codeactions through null-ls.

Type: boolean

Default: false

Example: true

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:

Turn on extra diagnostics for enabled languages by default

Type: boolean

Default: false

Declared by:

Turn on formatting for enabled languages by default

Type: boolean

Default: false

Declared by:

Turn on LSP for enabled languages by default

Type: boolean

Default: false

Declared by:

Turn on treesitter for enabled languages by default

Type: boolean

Default: false

Declared by:

Whether to enable C/C++ language support.

Type: boolean

Default: false

Example: true

Declared by:

C syntax for headers. Can fix treesitter errors, see: https://www.reddit.com/r/neovim/comments/orfpcd/question_does_the_c_parser_from_nvimtreesitter/

Type: boolean

Default: false

Declared by:

Enable clang LSP support

Type: boolean

Default: false

Declared by:

clang LSP server package

Type: package

Default: <derivation ccls-0.20220729>

Declared by:

Options to pass to clang LSP server

Type: null or string

Default: null

Declared by:

The clang LSP server to use

Type: value "ccls" (singular enum)

Default: "ccls"

Declared by:

Enable C/C++ treesitter

Type: boolean

Default: false

Declared by:

The c treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.c

Declared by:

The cpp treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.cpp

Declared by:

Whether to enable Dart language support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable flutter-tools for flutter support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Whether or mot to highlight color variables at all.

Type: boolean

Default: false

Example: true

Declared by:

Highlight the background

Type: boolean

Default: false

Declared by:

Highlight the foreground

Type: boolean

Default: false

Declared by:

Whether to enable Show the highlight using virtual text.

Type: boolean

Default: false

Example: true

Declared by:

Virtual text character to highlight

Type: string

Default: "■"

Declared by:

Enable Dart LSP support

Type: boolean

Default: false

Declared by:

Dart LSP server package

Type: package

Default: <derivation dart-2.19.3>

Declared by:

Options to pass to Dart LSP server

Type: null or string

Default: null

Declared by:

The Dart LSP server to use

Type: value "dart" (singular enum)

Default: "dart"

Declared by:

Enable Dart treesitter

Type: boolean

Default: false

Declared by:

The dart treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.dart

Declared by:

Whether to enable elixir support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Go language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable Go LSP support

Type: boolean

Default: false

Declared by:

Go LSP server package

Type: package

Default: <derivation gopls-0.11.0>

Declared by:

Go LSP server to use

Type: value "gopls" (singular enum)

Default: "gopls"

Declared by:

Enable Go treesitter

Type: boolean

Default: false

Declared by:

The go treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.go

Declared by:

Whether to enable HTML language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable HTML treesitter

Type: boolean

Default: false

Declared by:

The html treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.html

Declared by:

Enable autoclose/autorename of html tags (nvim-ts-autotag)

Type: boolean

Default: true

Declared by:

Whether to enable Markdown language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable markdown preview in neovim with glow

Type: boolean

Default: true

Declared by:

Enable Markdown treesitter

Type: boolean

Default: false

Declared by:

The markdown-inline treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown-inline

Declared by:

The markdown treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown

Declared by:

Whether to enable Nix language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable Nix formatting

Type: boolean

Default: false

Declared by:

Nix formatter package

Type: package

Default: <derivation alejandra-3.0.0>

Declared by:

Nix formatter to use

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

Default: "alejandra"

Declared by:

Enable Nix LSP support

Type: boolean

Default: false

Declared by:

Nix LSP server package

Type: package

Default: <derivation nil-2023-04-03>

Declared by:

Nix LSP server to use

Type: string

Default: "nil"

Declared by:

Enable Nix treesitter

Type: boolean

Default: false

Declared by:

The nix treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.nix

Declared by:

Whether to enable Python language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable Python formatting

Type: boolean

Default: false

Declared by:

Python formatter package

Type: package

Default: <derivation black-23.1.0>

Declared by:

Python formatter to use

Type: value "black" (singular enum)

Default: "black"

Declared by:

Enable Python LSP support

Type: boolean

Default: false

Declared by:

The python treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.python

Declared by:

Python LSP server to use

Type: value "pyright" (singular enum)

Default: "pyright"

Declared by:

Enable Python treesitter

Type: boolean

Default: false

Declared by:

Python treesitter grammar to use

Type: package

Default: <derivation python-grammar-0.0.0+rev=6282715>

Declared by:

Whether to enable Rust language support.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable crates-nvim, tools for managing dependencies.

Type: boolean

Default: false

Example: true

Declared by:

Enable code actions through null-ls

Type: boolean

Default: true

Declared by:

Rust LSP support (rust-analyzer with extra tools)

Type: boolean

Default: false

Declared by:

rust-analyzer package

Type: package

Default: <derivation rust-analyzer-2023-04-10>

Declared by:

Options to pass to rust analyzer

Type: string

Default: ""

Declared by:

Enable Rust treesitter

Type: boolean

Default: false

Declared by:

The rust treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.rust

Declared by:

Whether to enable SQL language support.

Type: boolean

Default: false

Example: true

Declared by:

SQL dialect for sqlfluff (if used)

Type: string

Default: "ansi"

Declared by:

Enable extra SQL diagnostics

Type: boolean

Default: false

Declared by:

List of SQL diagnostics to enable

Type: list of (value "sqlfluff" (singular enum) or (submodule))

Default:

[
  "sqlfluff"
]

Declared by:

Enable SQL formatting

Type: boolean

Default: false

Declared by:

SQL formatter package

Type: package

Default: <derivation sqlfluff-2.0.5>

Declared by:

SQL formatter to use

Type: value "sqlfluff" (singular enum)

Default: "sqlfluff"

Declared by:

Enable SQL LSP support

Type: boolean

Default: false

Declared by:

SQL LSP server package

Type: package

Default: <derivation sqls-0.2.22>

Declared by:

SQL LSP server to use

Type: value "sqls" (singular enum)

Default: "sqls"

Declared by:

Enable SQL treesitter

Type: boolean

Default: false

Declared by:

SQL treesitter grammar to use

Type: package

Default: <derivation sql-grammar-0.0.0+rev=8f1c49f>

Declared by:

Whether to enable SQL language support.

Type: boolean

Default: false

Example: true

Declared by:

Enable extra Typescript/Javascript diagnostics

Type: boolean

Default: false

Declared by:

List of Typescript/Javascript diagnostics to enable

Type: list of (value "eslint" (singular enum) or (submodule))

Default:

[
  "eslint"
]

Declared by:

Enable Typescript/Javascript formatting

Type: boolean

Default: false

Declared by:

Typescript/Javascript formatter package

Type: package

Default: <derivation prettier-2.8.4>

Declared by:

Typescript/Javascript formatter to use

Type: value "prettier" (singular enum)

Default: "prettier"

Declared by:

Enable Typescript/Javascript LSP support

Type: boolean

Default: false

Declared by:

Typescript/Javascript LSP server package

Type: package

Default: <derivation typescript-language-server-3.3.0>

Declared by:

Typescript/Javascript LSP server to use

Type: value "tsserver" (singular enum)

Default: "tsserver"

Declared by:

Enable Typescript/Javascript treesitter

Type: boolean

Default: false

Declared by:

The javascript treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.javascript

Declared by:

The tsx treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.tsx

Declared by:

Whether to enable SQL language support.

Type: boolean

Default: false

Example: true

Declared by:

Zig LSP support (zls)

Type: boolean

Default: false

Declared by:

ZLS package

Type: package

Default: <derivation pyright-1.1.298>

Declared by:

Zig package used by ZLS

Type: package

Default: <derivation zig-0.10.1>

Declared by:

Enable Zig treesitter

Type: boolean

Default: false

Declared by:

The zig treesitter package to use.

Type: package

Default: pkgs.vimPlugins.nvim-treesitter.builtGrammars.zig

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 LSP, also enabled automatically through null-ls and lspconfig options.

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 Lightbulb for code actions. Requires an 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 nvim-lspconfig, also enabled automatically.

Type: boolean

Default: false

Example: true

Declared by:

nvim-lspconfig sources

Type: attribute set of string

Default: { }

Declared by:

Whether to enable vscode-like pictograms for lsp [lspkind].

Type: boolean

Default: false

Example: true

Declared by:

Defines how annotations are shown

Type: one of "text", "text_symbol", "symbol_text", "symbol"

Default: "symbol_text"

Declared by:

Whether to enable LSP Saga.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable null-ls, also enabled automatically.

Type: boolean

Default: false

Example: true

Declared by:

null-ls sources

Type: attribute set of string

Default: { }

Declared by:

Whether to enable Enable nvim code action menu.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable trouble diagnostics viewer.

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 Enable codewindow plugin for minimap view.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Enable minimap-vim plugin for minimap view.

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 The power of trees at your fingertips. .

Type: boolean

Default: false

Example: true

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 Enable nvim-orgmode: 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 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:

Whether to enable Enable nvim-notify plugin.

Type: boolean

Default: false

Example: true

Declared by:

The background colour of the notification

Type: string

Default: "#000000"

Declared by:

The icons of the notification

Type: attribute set of string

Default:

{
  DEBUG = "";
  ERROR = "";
  INFO = "";
  TRACE = "";
  WARN = "";
}

Declared by:

The position of the notification

Type: one of "top_left", "top_right", "bottom_left", "bottom_right"

Default: "top_right"

Declared by:

The stages of the notification

Type: one of "fade_in_slide_out", "fade_in", "slide_out", "none"

Default: "fade_in_slide_out"

Declared by:

The timeout of the notification

Type: signed integer

Default: 1000

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", "dracula", "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", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools" or package)

Default: [ ]

Declared by:

Whether to enable Enable presence.nvim plugin for discord rich presence.

Type: boolean

Default: false

Example: true

Declared by:

Show line number on the RPC item

Type: boolean

Default: false

Declared by:

Automatically update the presence

Type: boolean

Default: true

Declared by:

Show buttons on the RPC item

Type: boolean

Default: true

Declared by:

Client ID of the application

Type: string

Default: "859194972255989790"

Declared by:

Text displayed when hovering over the Neovim image

Type: string

Default: "The One True Text Editor"

Declared by:

Main image to be displayed

Type: string

Default: "neovim"

Declared by:

Text displayed when editing a file

Type: string

Default: "Editing %s"

Declared by:

Text displayed when browsing files

Type: string

Default: "Browsing %s"

Declared by:

Text displayed when committing changes

Type: string

Default: "Committing changes"

Declared by:

Text displayed when showing line number

Type: string

Default: "Line %s out of %s"

Declared by:

Text displayed when managing plugins

Type: string

Default: "Managing plugins"

Declared by:

Text displayed when reading a file

Type: string

Default: "Reading %s"

Declared by:

Text displayed when working on a project

Type: string

Default: "Working on %s"

Declared by:

Show time on the RPC item

Type: boolean

Default: true

Declared by:

Prevent swapfile, backupfile from being created

Type: boolean

Default: false

Declared by:

Whether to enable Enable project-nvim for project management.

Type: boolean

Default: false

Example: true

Declared by:

Detection methods to use

Type: list of string

Default:

[
  "lsp"
  "pattern"
]

Declared by:

Directories to exclude from project root search

Type: list of string

Default: [ ]

Declared by:

LSP servers no ignore by name

Type: list of string

Default: [ ]

Declared by:

don't automatically change the root directory so the user has the option to manually do so using `:ProjectRoot` command

Type: boolean

Default: true

Declared by:

Patterns to use for pattern detection method

Type: list of string

Default:

[
  ".git"
  "_darcs"
  ".hg"
  ".bzr"
  ".svn"
  "Makefile"
  "package.json"
  "flake.nix"
  "cargo.toml"
]

Declared by:

What scope to change the directory

Type: one of "global", "tab", "win"

Default: "global"

Declared by:

Show hidden files in telescope picker

Type: boolean

Default: false

Declared by:

Silently change directory when changing project

Type: boolean

Default: true

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:

All buffers of these bufer types will be closed before the session is saved

Type: list of string

Default: [ ]

Declared by:

A list of directories where the session will not be autosaved

Type: list of string

Default: [ ]

Declared by:

All buffers of these file types will be closed before the session is saved

Type: list of string

Default:

[
  "gitcommit"
]

Declared by:

Plugin will not save a session when no buffers are opened, or all of them aren't writable or listed

Type: boolean

Default: true

Declared by:

Automatically save last session on exit and on session switch

Type: boolean

Default: true

Declared by:

Always autosaves session. If true, only autosaves after a session is active

Type: boolean

Default: false

Declared by:

Define what to do when Neovim is started without arguments. Possible values: Disabled, CurrentDir, LastSession

Type: one of "Disabled", "CurrentDir", "LastSession"

Default: "LastSession"

Declared by:

The character to which the colon symbol will be replaced for session files

Type: string

Default: "++"

Declared by:

Shorten the display path if length exceeds this threshold. Use 0 if don't want to shorten the path at all

Type: null or signed integer

Default: 80

Declared by:

The character to which the path separator will be replaced for session files

Type: string

Default: "__"

Declared by:

Whether or not we should use dressing.nvim to build a session picker UI

Type: boolean

Default: 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", "dracula", "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", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools" or package)

Default: [ ]

Declared by:

Whether to enable lualine.

Type: boolean

Default: false

Example: true

Declared by:

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

Type: string

Default:

''
  {
    {
      "mode",
      separator = {
        left = '▎',
      },
    },
  }
''

Declared by:

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

Type: string

Default:

''
  {
    {
      "filetype",
      colored = true,
      icon_only = true,
      icon = { align = 'left' },
      color = {bg='none', fg='lavender'},
    },
    {
      "filename",
      color = {bg='none'},
      symbols = {modified = '', readonly = ''},
    },
  }
''

Declared by:

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

Type: string

Default:

''
  {
    {
      "diff",
      colored = false,
      diff_color = {
        -- Same color values as the general color option can be used here.
        added    = 'DiffAdd',    -- Changes the diff's added color
        modified = 'DiffChange', -- Changes the diff's modified color
        removed  = 'DiffDelete', -- Changes the diff's removed color you
      },
      symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the diff symbols
      color = {
        bg='none',
        fg='lavender'
      },
    },
  }
''

Declared by:

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

Type: string

Default:

''
  {
    {
      "diagnostics",
      sources = {'nvim_lsp', 'nvim_diagnostic', 'coc'},
      symbols = {error = ' ', warn = ' ', info = ' ', hint = ' '}
    },
  }
''

Declared by:

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

Type: string

Default:

''
  {
    {
      "fileformat",
      color = {bg='none', fg='lavender'},
      symbols = {
        unix = '', -- e712
        dos = '',  -- e70f
        mac = '',  -- e711
      },
    },
  }
''

Declared by:

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

Type: string

Default:

''
  {
    {
      "progress",
      color = {bg='none', fg='lavender'},
    },
    {
      "location",
      color = {bg='none', fg='lavender'},
    },
    {
      "branch",
      icon = ' •',
      separator = {
        left = '(',
        right = ')'
      },
      color = {bg='none', fg='lavender'},
  
    },
  }
''

Declared by:

Component separator for left side

Type: string

Default: ""

Declared by:

Component separator for right side

Type: string

Default: ""

Declared by:

Enable global status for lualine

Type: boolean

Default: true

Declared by:

Enable icons for lualine

Type: boolean

Default: true

Declared by:

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

Type: string

Default: "{}"

Declared by:

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

Type: string

Default: "{}"

Declared by:

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

Type: string

Default: "{'filename'}"

Declared by:

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

Type: string

Default: "{'location'}"

Declared by:

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

Type: string

Default: "{}"

Declared by:

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

Type: string

Default: "{}"

Declared by:

Refresh rate for lualine

Type: signed integer

Default: 1000

Declared by:

Refresh rate for tabline

Type: signed integer

Default: 1000

Declared by:

Refresh rate for winbar

Type: signed integer

Default: 1000

Declared by:

Section separator for left side

Type: string

Default: ""

Declared by:

Section separator for right side

Type: string

Default: ""

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"

Default: config.vim.theme.name if theme supports lualine else "auto"

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 Enable nvim-bufferline-lua as a bufferline.

Type: boolean

Default: false

Example: true

Declared by: