Appendix A. Configuration options

_module.args

Additional arguments passed to each module in addition to ones like `lib`, `config`, and `pkgs`, `modulesPath`. This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument `name` which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute. Some arguments are already passed by default, of which the following *cannot* be changed with this option: - {var}`lib`: The nixpkgs library. - {var}`config`: The results of all options after merging the values from all modules together. - {var}`options`: The options declared in all modules. - {var}`specialArgs`: The `specialArgs` argument passed to `evalModules`. - All attributes of {var}`specialArgs` Whereas option values can generally depend on other option values thanks to laziness, this does not apply to `imports`, which must be computed statically before anything else. For this reason, callers of the module system can provide `specialArgs` which are available during import resolution. For NixOS, `specialArgs` includes {var}`modulesPath`, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of the `nixpkgs` or NixOS directories. ``` { modulesPath, ... }: { imports = [ (modulesPath + "/profiles/minimal.nix") ]; } ``` For NixOS, the default value for this option includes at least this argument: - {var}`pkgs`: The nixpkgs package set according to the {option}`nixpkgs.pkgs` option.

Type: lazy attribute set of raw value

Declared by:

<main/lib/modules.nix>
vim.autoIndent

Enable auto indent

Type: boolean

Declared by:

<main/modules/basic>
vim.autocomplete.enable

enable autocomplete (nvim-cmp)

Type: boolean

Default: false

Declared by:

<main/modules/completion>
vim.autopairs.enable

enable autopairs

Type: boolean

Declared by:

<main/modules/autopairs/nvim-autopairs.nix>
vim.autopairs.checkTS

Whether to check treesitter for a pair

Type: boolean

Declared by:

<main/modules/autopairs/nvim-autopairs.nix>
vim.autopairs.type

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

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

Declared by:

<main/modules/autopairs/nvim-autopairs.nix>
vim.bell

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

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

Declared by:

<main/modules/basic>
vim.chatgpt.enable

Enable ChatGPT.nvim plugin

Type: boolean

Declared by:

<main/modules/chatgpt>
vim.chatgpt.openaiApiKey

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

Type: null or string

Default: null

Declared by:

<main/modules/chatgpt>
vim.cmap

Defines 'Command-line mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.cmdHeight

Height of the command pane

Type: signed integer

Declared by:

<main/modules/basic>
vim.cnoremap

Defines 'Command-line mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.colourTerm

Set terminal up for 256 colours

Type: boolean

Declared by:

<main/modules/basic>
vim.comments.enable

enable comments plugin

Type: boolean

Default: false

Declared by:

<main/modules/comments>
vim.comments.type

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

Type: one of "nerdcommenter", "kommentary"

Default: "nerdcommenter"

Declared by:

<main/modules/comments>
vim.configRC

vimrc contents

Type: strings concatenated with "\n"

Default: ""

Declared by:

<main/modules/core>
vim.customPlugins

List of custom scripts

Type: list of package

Default: [ ]

Declared by:

<main/modules/basic>
vim.dial.enable

Enable dial.nvim plugin (enhanced incr/decr)

Type: boolean

Declared by:

<main/modules/dial>
vim.disableArrows

Set to prevent arrow keys from moving cursor

Type: boolean

Declared by:

<main/modules/basic>
vim.filetree.nvimTreeLua.enable

Enable nvim-tree-lua

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.closeOnFileOpen

Close the tree when a file is opened

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.closeOnLastWindow

Close when tree is last window open

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.disableNetRW

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.followBufferFile

Follow file that is in current buffer on tree

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.groupEmptyFolders

Compact empty folders trees into a single item

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.hideDotFiles

Hide dotfiles

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.hideFiles

Files to hide in the file view by default.

Type: list of string

Default:

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

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.hideIgnoredGitFiles

Hide files ignored by git

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.hijackNetRW

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.ignoreFileTypes

Ignore file types

Type: list of string

Default: [ ]

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.indentMarkers

Show indent markers

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.lspDiagnostics

Shows lsp diagnostics in the tree

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.openOnSetup

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.openTreeOnNewTab

Opens the tree view when opening a new tab

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.resizeOnFileOpen

Resize the tree window when a file is opened

Type: boolean

Default: false

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.trailingSlash

Add a trailing slash to all folders

Type: boolean

Default: true

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.treeSide

Side the tree will appear on left or right

Type: one of "left", "right"

Default: "left"

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.filetree.nvimTreeLua.treeWidth

Width of the tree in charecters

Type: signed integer

Default: 25

Declared by:

<main/modules/filetree/nvimtreelua.nix>
vim.fx.automaton.enable

Enable Cellular Automaton

Type: boolean

Default: false

Declared by:

<main/modules/fx>
vim.git.enable

Enable git plugins

Type: boolean

Declared by:

<main/modules/git/git.nix>
vim.git.gitsigns.enable

Enable git options

Type: boolean

Declared by:

<main/modules/git/git.nix>
vim.globals

Set containing global variable values

Type: attribute set

Default: { }

Declared by:

<main/modules/core>
vim.hideSearchHighlight

Hide search highlight so it doesn't stay highlighted

Type: boolean

Declared by:

<main/modules/basic>
vim.hop.enable

Enable Hop plugin (easy motion)

Type: boolean

Declared by:

<main/modules/hop>
vim.imap

Defines 'Insert and Replace mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.inoremap

Defines 'Insert and Replace mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.keys.enable

Whether to enable key binding plugins.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/keys/which-key.nix>
vim.keys.whichKey.enable

Whether to enable which-key menu.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/keys/which-key.nix>
vim.lineNumberMode

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

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

Declared by:

<main/modules/basic>
vim.lsp.enable

Whether to enable neovim lsp support.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.clang

Whether to enable C language LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.dhall

Whether to enable Dhall LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.elm

Whether to enable Elm LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.folds

Whether to enable Folds via nvim-ufo.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.formatOnSave

Whether to enable Format on save.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.go

Whether to enable Go language LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.haskell

Whether to enable Haskell LSP (hls).

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.lightbulb.enable

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

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lightbulb.nix>
vim.lsp.lspSignature.enable

Whether to enable lsp signature viewer.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp-signature.nix>
vim.lsp.lspsaga.enable

Whether to enable LSP Saga.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lspsaga.nix>
vim.lsp.nix.enable

Whether to enable Nix LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.nix.type

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

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

Default: "nil"

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.nvimCodeActionMenu.enable

Whether to enable nvim code action menu.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/nvim-code-action-menu.nix>
vim.lsp.python

Whether to enable Python LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.rust.enable

Whether to enable Rust LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.rust.rustAnalyzerOpts

options to pass to rust analyzer

Type: string

Default:

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

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.scala.enable

Whether to enable Scala LSP (Metals).

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.scala.metals

The Metals package to use. Default pkgs.metals.

Type: package

Default: <derivation metals-1.0.1>

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.smithy.enable

Whether to enable Smithy Language LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.smithy.launcher

The launcher of the LSP server

Type: package

Default: <derivation coursier-2.1.7>

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.smithy.server.class

The Smithy LSP server main class

Type: string

Default: "software.amazon.smithy.lsp.Main"

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.smithy.server.name

The Smithy LSP server dependency (usually a jar)

Type: string

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

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.smithy.server.version

The Smithy LSP server dependency version

Type: string

Default: "0.0.28"

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.sql

Whether to enable SQL Language LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.lsp.trouble.enable

Whether to enable trouble diagnostics viewer.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/trouble.nix>
vim.lsp.ts

Whether to enable TS language LSP.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/lsp/lsp.nix>
vim.luaConfigRC

vim lua config

Type: strings concatenated with "\n"

Default: ""

Declared by:

<main/modules/core>
vim.mapClearHighlight

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

Type: boolean

Declared by:

<main/modules/basic>
vim.mapLeaderSpace

Map the space key to leader key

Type: boolean

Declared by:

<main/modules/basic>
vim.mapTimeout

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

Type: signed integer

Declared by:

<main/modules/basic>
vim.markdown.enable

Whether to enable markdown tools and plugins.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/markdown/glow.nix>
vim.markdown.glow.enable

Enable markdown preview in neovim with glow

Type: boolean

Default: true

Declared by:

<main/modules/markdown/glow.nix>
vim.mind.enable

Enable Mind plugin

Type: boolean

Default: false

Declared by:

<main/modules/mind>
vim.mind.persistence.dataDir

Directory for the Mind data files created by the user

Type: string

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

Declared by:

<main/modules/mind>
vim.mind.persistence.statePath

Application state file: mind.json

Type: string

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

Declared by:

<main/modules/mind>
vim.mouseSupport

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:

<main/modules/basic>
vim.neoclip.enable

Enable nvim-neoclip.lua plugin

Type: boolean

Declared by:

<main/modules/neoclip>
vim.neovim.package

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

Type: package

Default: <derivation neovim-unwrapped-0.9.2>

Example: "pkgs.neovim-nightly"

Declared by:

<main/modules/neovim>
vim.nmap

Defines 'Normal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.nnoremap

Defines 'Normal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.notifications.enable

Enable the nvim-notify plugin

Type: boolean

Declared by:

<main/modules/notifications>
vim.omap

Defines 'Operator pending mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.onoremap

Defines 'Operator pending mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.optPlugins

List of plugins to optionally load

Type: list of package

Default: [ ]

Declared by:

<main/modules/core>
vim.plantuml.enable

Enable PlantUML syntax highlights

Type: boolean

Default: false

Declared by:

<main/modules/plantuml>
vim.preventJunkFiles

Prevent swapfile, backupfile from being created

Type: boolean

Declared by:

<main/modules/basic>
vim.runtime

Set of files that have to be linked in {file}`runtime`.

Type: attribute set of (submodule)

Default: { }

Example:

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

Declared by:

<main/modules/core>
vim.runtime.<name>.enable

Whether this /etc file should be generated. This option allows specific /etc files to be disabled.

Type: boolean

Default: true

Declared by:

<main/modules/core>
vim.runtime.<name>.source

Path of the source file.

Type: path

Declared by:

<main/modules/core>
vim.runtime.<name>.target

Name of symlink. Defaults to the attribute name.

Type: string

Declared by:

<main/modules/core>
vim.runtime.<name>.text

Text of the file.

Type: null or strings concatenated with "\n"

Default: null

Declared by:

<main/modules/core>
vim.scrollOffset

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

Type: signed integer

Declared by:

<main/modules/basic>
vim.shortcuts.enable

Whether to enable enable shortcuts.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/keys/shortcuts.nix>
vim.showSignColumn

Show the sign column

Type: boolean

Declared by:

<main/modules/basic>
vim.smap

Defines 'Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.snippets.vsnip.enable

Whether to enable Enable vim-vsnip.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/snippets/vsnip.nix>
vim.snoremap

Defines 'Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.spellCheck.markdown

Enables spell-checker on markdown files

Type: boolean

Declared by:

<main/modules/basic>
vim.spider.enable

Enable the nvim-spider plugin

Type: boolean

Declared by:

<main/modules/spider>
vim.spider.skipInsignificantPunctuation

Plugin setting

Type: boolean

Default: true

Declared by:

<main/modules/spider>
vim.splitBelow

New splits will open below instead of on top

Type: boolean

Declared by:

<main/modules/basic>
vim.splitRight

New splits will open to the right

Type: boolean

Declared by:

<main/modules/basic>
vim.startConfigRC

start of vimrc contents

Type: strings concatenated with "\n"

Default: ""

Declared by:

<main/modules/core>
vim.startLuaConfigRC

start of vim lua config

Type: strings concatenated with "\n"

Default: ""

Declared by:

<main/modules/core>
vim.startPlugins

List of plugins to startup

Type: list of (null or package)

Default: [ ]

Declared by:

<main/modules/core>
vim.statusline.lualine.enable

Enable lualine

Type: boolean

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.a

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.b

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.c

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.x

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.y

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.activeSection.z

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.componentSeparator.left

Component separator for left side

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.componentSeparator.right

Component separator for right side

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.icons

Enable icons for lualine

Type: boolean

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.a

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.b

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.c

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.x

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.y

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.inactiveSection.z

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

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.sectionSeparator.left

Section separator for left side

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.sectionSeparator.right

Section separator for right side

Type: string

Declared by:

<main/modules/statusline/lualine.nix>
vim.statusline.lualine.theme

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:

<main/modules/statusline/lualine.nix>
vim.surround.enable

Enable nvim-surround plugin

Type: boolean

Default: true

Declared by:

<main/modules/surround>
vim.syntaxHighlighting

Enable syntax highlighting

Type: boolean

Declared by:

<main/modules/basic>
vim.tabWidth

Set the width of tabs

Type: signed integer

Declared by:

<main/modules/basic>
vim.tabline.nvimBufferline.enable

Whether to enable bufferline.nvim.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/tabline/nvim-bufferline.nix>
vim.telescope.enable

Whether to enable enable telescope.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/telescope>
vim.telescope.mediaFiles.enable

Whether to enable enable telescope-media-files extension.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/telescope>
vim.theme.enable

Enable Theme

Type: boolean

Declared by:

<main/modules/theme/theme.nix>
vim.theme.name

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

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

Default: "onedark"

Declared by:

<main/modules/theme/theme.nix>
vim.theme.style

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

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

Declared by:

<main/modules/theme/theme.nix>
vim.theme.transparency

Background transparency

Type: boolean

Declared by:

<main/modules/theme/theme.nix>
vim.tmap

Defines 'Terminal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.tnoremap

Defines 'Terminal mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.todo.enable

Whether to enable todo-comments.

Type: boolean

Default: false

Example: true

Declared by:

<main/modules/todo/todo-comments.nix>
vim.todo.patterns.highlight

vim regex pattern used for highlighting comments

Type: string

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

Declared by:

<main/modules/todo/todo-comments.nix>
vim.todo.patterns.search

ripgrep regex pattern used for searching comments

Type: string

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

Declared by:

<main/modules/todo/todo-comments.nix>
vim.treesitter.enable

enable tree-sitter [nvim-treesitter]

Type: boolean

Declared by:

<main/modules/treesitter/treesitter.nix>
vim.treesitter.autotagHtml

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

Type: boolean

Declared by:

<main/modules/treesitter/treesitter.nix>
vim.treesitter.context.enable

enable function context [nvim-treesitter-context]

Type: boolean

Declared by:

<main/modules/treesitter/context.nix>
vim.treesitter.fold

enable fold with tree-sitter

Type: boolean

Declared by:

<main/modules/treesitter/treesitter.nix>
vim.treesitter.textobjects

enable nvim-treesitter-textobjects and its default configuration

Type: boolean

Declared by:

<main/modules/treesitter/treesitter.nix>
vim.updateTime

The number of milliseconds till Cursor Hold event is fired

Type: signed integer

Declared by:

<main/modules/basic>
vim.useSystemClipboard

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

Type: boolean

Declared by:

<main/modules/basic>
vim.viAlias

Enable vi alias

Type: boolean

Default: true

Declared by:

<main/modules/core>
vim.vimAlias

Enable vim alias

Type: boolean

Default: true

Declared by:

<main/modules/core>
vim.visuals.enable

visual enhancements

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.cursorWordline.enable

enable word and delayed line highlight [nvim-cursorline]

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.cursorWordline.lineTimeout

time in milliseconds for cursorline to appear

Type: signed integer

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.indentBlankline.enable

enable indentation guides [indent-blankline]

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.indentBlankline.eolChar

Character at end of line

Type: string

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.indentBlankline.fillChar

Character to fill indents

Type: string

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.indentBlankline.listChar

Character for indentation line

Type: string

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.indentBlankline.showCurrContext

Highlight current context from treesitter

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.lspkind.enable

enable vscode-like pictograms for lsp [lspkind]

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.visuals.nvimWebDevicons.enable

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

Type: boolean

Declared by:

<main/modules/visuals/visuals.nix>
vim.vmap

Defines 'Visual and Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.vnoremap

Defines 'Visual and Select mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.wordWrap

Enable word wrapping.

Type: boolean

Declared by:

<main/modules/basic>
vim.xmap

Defines 'Visual mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>
vim.xnoremap

Defines 'Visual mode' mappings

Type: attribute set of (null or string)

Default: { }

Declared by:

<main/modules/core>