Appendix A. Neovim Flake Configuration Options

Below are the options provided by nvf provided in no particular order. They may include useful comments and warnings, or examples on how a module option is meant to be used.

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

  • lib: The nixpkgs library.

  • config: The results of all options after merging the values from all modules together.

  • options: The options declared in all modules.

  • specialArgs: The specialArgs argument passed to evalModules.

  • All attributes of 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 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:

  • pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.

Type: lazy attribute set of raw value

Declared by:

<nixpkgs/lib/modules.nix>
vim.enableEditorconfig

Follow editorconfig rules in current directory

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.enableLuaLoader

Whether to enable the experimental Lua module loader to speed up the start up process

If true, this will enable the experimental Lua module loader which:

  • overrides loadfile

  • adds the lua loader using the byte-compilation cache

  • adds the libs loader

  • removes the default Neovim loader

This is disabled by default. Before setting this option, please take a look at the official documentation. .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.package

The neovim package to use for the wrapper. This corresponds to the package that will be wrapped with your plugins and settings.

Warning

You will need to use an unwrapped package for this option to work as intended. Using an already wrapped package here may yield undesirable results.

Type: package

Default: <derivation neovim-unwrapped-0.9.5>

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.additionalRuntimePaths

Additional runtime paths that will be appended to the active runtimepath of the Neovim. This can be used to add additional lookup paths for configs, plugins, spell languages and other things you would generally place in your $HOME/.config/nvim.

This is meant as a declarative alternative to throwing files into ~/.config/nvim and having the Neovim wrapper pick them up. For more details on vim.o.runtimepath, and what paths to use; please see the official documentation

Type: list of (path or string)

Default: [ ]

Example:

[
  # absolute path, as a string - impure
  "$HOME/.config/nvim-extra"

  # relative path, as a path - pure
  ./nvim

  # source type path - pure and reproducible
  (builtins.source {
    path = ./runtime;
    name = "nvim-runtime";
  })
]

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.assistant.chatgpt.enable

Whether to enable ChatGPT AI assistant. Requires the environment variable OPENAI_API_KEY to be set.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.addTests

[ChatGPT] Add tests

Type: null or string

Default: "<leader>aa"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.chatGpt

ChatGPT

Type: null or string

Default: "<leader>ac"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.docstring

[ChatGPT] Docstring

Type: null or string

Default: "<leader>ad"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.editWithInstructions

[ChatGPT] Edit with instructions

Type: null or string

Default: "<leader>ae"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.explain

[ChatGPT] Explain code

Type: null or string

Default: "<leader>ax"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.fixBugs

[ChatGPT] Fix bugs

Type: null or string

Default: "<leader>af"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.grammarCorrection

[ChatGPT] Grammar correction

Type: null or string

Default: "<leader>ag"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.keyword

[ChatGPT] Keywords

Type: null or string

Default: "<leader>ak"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.optimize

[ChatGPT] Optimize code

Type: null or string

Default: "<leader>ao"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.readabilityanalysis

[ChatGPT] Code reability analysis

Type: null or string

Default: "<leader>al"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.roxygenEdit

[ChatGPT] Roxygen edit

Type: null or string

Default: "<leader>ar"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.summarize

[ChatGPT] Summarize

Type: null or string

Default: "<leader>as"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.mappings.translate

[ChatGPT] Translate

Type: null or string

Default: "<leader>at"

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.chatgpt.setupOpts

Option table to pass into the setup function of chatgpt

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix>
vim.assistant.copilot.enable

Whether to enable GitHub Copilot AI assistant.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.cmp.enable

Whether to enable nvim-cmp integration for GitHub Copilot.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.panel.accept

Accept suggestion

Type: null or string

Default: "<CR>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.panel.jumpNext

Jump to next suggestion

Type: null or string

Default: "]]"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.panel.jumpPrev

Jump to previous suggestion

Type: null or string

Default: "[["

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.panel.open

Open suggestions

Type: null or string

Default: "<M-CR>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.panel.refresh

Refresh suggestions

Type: null or string

Default: "gr"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.accept

Accept suggetion

Type: null or string

Default: "<M-l>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.acceptLine

Accept next line

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.acceptWord

Accept next word

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.dismiss

Dismiss suggestion

Type: null or string

Default: "<C-]>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.next

Next suggestion

Type: null or string

Default: "<M-]>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.mappings.suggestion.prev

Previous suggestion

Type: null or string

Default: "<M-[>"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts

Option table to pass into the setup function of Copilot

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts.copilot_node_command

The command that will be executed to initiate nodejs for GitHub Copilot. Recommended to leave as default.

Type: string

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

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts.panel.enabled

Whether to enable Completion Panel.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts.panel.layout.position

Panel position

Type: one of “bottom”, “top”, “left”, “right”

Default: "bottom"

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts.panel.layout.ratio

Panel size

Type: floating point number

Default: 0.4

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.assistant.copilot.setupOpts.suggestion.enabled

Whether to enable Suggestions.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/assistant/copilot/copilot.nix>
vim.autoIndent

Enable auto indent

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.autocomplete.enable

Whether to enable autocomplete.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.alwaysComplete

Automatically show completion.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.formatting.format

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:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.close

Close [nvim-cmp]

Type: null or string

Default: "<C-e>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.complete

Complete [nvim-cmp]

Type: null or string

Default: "<C-Space>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.confirm

Confirm [nvim-cmp]

Type: null or string

Default: "<CR>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.next

Next item [nvim-cmp]

Type: null or string

Default: "<Tab>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.previous

Previous item [nvim-cmp]

Type: null or string

Default: "<S-Tab>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.scrollDocsDown

Scroll docs down [nvim-cmp]

Type: null or string

Default: "<C-f>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.mappings.scrollDocsUp

Scroll docs up [nvim-cmp]

Type: null or string

Default: "<C-d>"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.sources

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:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autocomplete.type

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

Type: value “nvim-cmp” (singular enum)

Default: "nvim-cmp"

Declared by:

<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix>
vim.autopairs.enable

Whether to enable autopairs.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix>
vim.autopairs.type

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

Type: value “nvim-autopairs” (singular enum)

Default: "nvim-autopairs"

Declared by:

<nvf/modules/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix>
vim.bell

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

Type: one of “none”, “visual”, “on”

Default: "none"

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.binds.cheatsheet.enable

Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/binds/cheatsheet/cheatsheet.nix>
vim.binds.whichKey.enable

Whether to enable which-key keybind helper menu.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/binds/which-key/which-key.nix>
vim.binds.whichKey.register

Register label for which-key keybind helper menu

Type: attribute set of string

Default: { }

Declared by:

<nvf/modules/plugins/utility/binds/which-key/which-key.nix>
vim.cmdHeight

Height of the command pane

Type: signed integer

Default: 1

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.colourTerm

Set terminal up for 256 colours

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.comments.comment-nvim.enable

Whether to enable smart and powerful comment plugin for neovim comment-nvim.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleCurrentBlock

Toggle current block comment

Type: null or string

Default: "gbc"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleCurrentLine

Toggle current line comment

Type: null or string

Default: "gcc"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleOpLeaderBlock

Toggle block comment

Type: null or string

Default: "gb"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleOpLeaderLine

Toggle line comment

Type: null or string

Default: "gc"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleSelectedBlock

Toggle selected block

Type: null or string

Default: "gb"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.comments.comment-nvim.mappings.toggleSelectedLine

Toggle selected comment

Type: null or string

Default: "gc"

Declared by:

<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix>
vim.configRC

Contents of vimrc, either as a string or a DAG.

If this option is passed as a DAG, it will be resolved according to the DAG resolution rules (e.g. entryBefore or entryAfter) as per the nvf extended library.

Type: (DAG of strings concatenated with “\n”) or string

Default: { }

Example:

" Set the tab size to 4 spaces
set tabstop=4
set shiftwidth=4
set expandtab

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.cursorlineOpt

Highlight the text line of the cursor with CursorLine hl-CursorLine

Type: one of “line”, “screenline”, “number”, “both”

Default: "line"

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.dashboard.alpha.enable

Whether to enable fast and fully programmable greeter for neovim [alpha.mvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/dashboard/alpha/alpha.nix>
vim.dashboard.dashboard-nvim.enable

Whether to enable Fancy and Blazing Fast start screen plugin of neovim [dashboard.nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/dashboard/dashboard-nvim/dashboard-nvim.nix>
vim.dashboard.startify.enable

Whether to enable dashboard via vim-startify.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.bookmarks

List of book marks to disaply on start page

Type: list of (attribute set)

Default: [ ]

Example:

{
  c = "~/.vimrc";
}

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.changeDirCmd

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

Type: one of “cd”, “lcd”, “tcd”

Default: "lcd"

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.changeToDir

Should vim change to the directory of the file you open

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.changeToVCRoot

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.commands

Commands that are presented to the user on startify page

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

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.customFooter

Text to place in the footer

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.customHeader

Text to place in the header

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.customIndices

Specify a list of default charecters to use instead of numbers

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.disableOnStartup

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.filesNumber

How many files to list

Type: signed integer

Default: 10

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.lists

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:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.paddingLeft

Number of spaces used for left padding.

Type: signed integer

Default: 3

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionAutoload

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionBeforeSave

Commands to run before saving a session

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionDeleteBuffers

Delete all buffers when loading or closing a session

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionDir

Directory to save and load sessions from

Type: string

Default: "~/.vim/session"

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionPersistence

Persist session before leaving vim or switching session

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionRemoveLines

Patterns to remove from session files

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionSavecmds

List of commands to run when loading a session.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionSavevars

List of variables to save into a session file.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.sessionSort

Set if you want items sorted by date rather than alphabetically

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.skipList

List of regex patterns to exclude from MRU lists

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.skipListServer

List of vim servers to not load startify for

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.unsafe

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.updateOldFiles

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.dashboard.startify.useEnv

Show environment variables in path if name is shorter than value

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/dashboard/startify/startify.nix>
vim.debugMode.enable

Whether to enable debug mode.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/neovim/init/debug.nix>
vim.debugMode.level

Set verbosity level of Neovim while debug mode is enabled.

Value must be be one of the levels expected by Neovim’s verbose option

Type: one of 2, 3, 4, 5, 8, 9, 11, 12, 13, 14, 15, 16

Default: 16

Declared by:

<nvf/modules/neovim/init/debug.nix>
vim.debugMode.logFile

Set the log file that will be used to store verbose messages set by the verbose option.

Type: null or path

Default: null

Declared by:

<nvf/modules/neovim/init/debug.nix>
vim.debugger.nvim-dap.enable

Whether to enable debugging via nvim-dap.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.continue

Contiue

Type: null or string

Default: "<leader>dc"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.goDown

Go down stacktrace

Type: null or string

Default: "<leader>dvi"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.goUp

Go up stacktrace

Type: null or string

Default: "<leader>dvo"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.hover

Hover

Type: null or string

Default: "<leader>dh"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.restart

Restart

Type: null or string

Default: "<leader>dR"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.runLast

Re-run Last Debug Session

Type: null or string

Default: "<leader>d."

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.runToCursor

Continue to the current cursor

Type: null or string

Default: "<leader>dgc"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.stepBack

Step back

Type: null or string

Default: "<leader>dgk"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.stepInto

Step into function

Type: null or string

Default: "<leader>dgi"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.stepOut

Step out of function

Type: null or string

Default: "<leader>dgo"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.stepOver

Next step

Type: null or string

Default: "<leader>dgj"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.terminate

Terminate

Type: null or string

Default: "<leader>dq"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.toggleBreakpoint

Toggle breakpoint

Type: null or string

Default: "<leader>db"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.toggleDapUI

Toggle DAP-UI

Type: null or string

Default: "<leader>du"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.mappings.toggleRepl

Toggle Repl

Type: null or string

Default: "<leader>dr"

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.sources

List of debuggers to install

Type: attribute set of string

Default: { }

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.ui.enable

Whether to enable UI extension for nvim-dap.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.debugger.nvim-dap.ui.autoStart

Automatically Opens and Closes DAP-UI upon starting/closing a debugging session

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix>
vim.disableArrows

Set to prevent arrow keys from moving cursor

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.disableDefaultRuntimePaths

Disables the default runtime paths that are set by Neovim when it starts up. This is useful when you want to have full control over the runtime paths that are set by Neovim.

Note

To avoid leaking imperative user configuration into your configuration, this is enabled by default. If you wish to load configuration from user configuration directories (e.g. $HOME/.config/nvim, $HOME/.config/nvim/after and $HOME/.local/share/nvim/site) you may set this option to true.

Type: boolean

Default: true

Example: false

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.extraPackages

List of additional packages to make available to the Neovim wrapper.

Type: list of package

Default: [ ]

Example: [pkgs.fzf pkgs.ripgrep]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.extraPlugins

A list of plugins and their configurations that will be set up after builtin plugins.

This option takes a special type that allows you to order your custom plugins using nvf’s modified DAG library.

Type: attribute set of (submodule)

Default: { }

Example:

with pkgs.vimPlugins; {
  aerial = {
    package = aerial-nvim;
    setup = "require('aerial').setup {}";
  };

  harpoon = {
    package = harpoon;
    setup = "require('harpoon').setup {}";
    after = ["aerial"]; # place harpoon configuration after aerial
  };
}

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.extraPlugins.<name>.package

Plugin Package.

Type: null or package or one of “alpha-nvim”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “cmp-vsnip”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fidget-nvim”, “flutter-tools”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lualine”, “mind-nvim”, “minimap-vim”, “modes-nvim”, “neocord”, “neodev-nvim”, “noice-nvim”, “none-ls”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-code-action-menu”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-web-devicons”, “obsidian-nvim”, “onedark”, “orgmode-nvim”, “oxocarbon”, “plenary-nvim”, “project-nvim”, “registers”, “rose-pine”, “rust-tools”, “scrollbar-nvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “vim-vsnip”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.extraPlugins.<name>.after

Setup this plugin after the following ones.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.extraPlugins.<name>.setup

Lua code to run during setup.

Type: strings concatenated with “\n”

Default: ""

Example: "require('aerial').setup {}"

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.filetree.nvimTree.enable

Whether to enable filetree via nvim-tree.lua.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.mappings.findFile

Find file in NvimTree

Type: null or string

Default: "<leader>tg"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.mappings.focus

Focus NvimTree

Type: null or string

Default: "<leader>tf"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.mappings.refresh

Refresh NvimTree

Type: null or string

Default: "<leader>tr"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.mappings.toggle

Toggle NvimTree

Type: null or string

Default: "<leader>t"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.openOnSetup

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts

Option table to pass into the setup function of Nvim Tree

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions

Configuration for various actions.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.change_dir

vim change-directory behaviour

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.change_dir.enable

Change the working directory when changing directories in the tree.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.change_dir.global

Use :cd instead of :lcd when changing directories. Consider that this might cause issues with the nvimTree.syncRootWithCwd option.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.change_dir.restrict_above_cwd

Restrict changing to a directory above the global current working directory.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.expand_all

Configuration for expand_all behaviour.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.expand_all.exclude

A list of directories that should not be expanded automatically.

Type: list of string

Default:

[
  ".git"
  "target"
  "build"
  "result"
]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.expand_all.max_folder_discovery

Limit the number of folders being explored when expanding every folders. Avoids hanging neovim when running this action on very large folders.

Type: signed integer

Default: 300

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.file_popup

Configuration for file_popup behaviour.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.file_popup.open_win_config

Floating window config for file_popup. See |nvim_open_win| for more details.

Type: attribute set

Default:

{
  border = "rounded";
  col = 1;
  relative = "cursor";
  row = 1;
  style = "minimal";
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file

Configuration options for opening a file from nvim-tree.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.eject

Prevent new opened file from opening in the same window as the tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.quit_on_open

Closes the explorer when opening a file.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.resize_window

Resizes the tree when opening a file. Previously view.auto_resize

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker

window_picker

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.enable

Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.chars

A string of chars used as identifiers by the window picker.

Type: string

Default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.buftype

A list of buftypes to exclude from the window picker.

Type: list of string

Default:

[
  "nofile"
  "terminal"
  "help"
]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.filetype

A list of filetypes to exclude from the window picker.

Type: list of string

Default:

[
  "notify"
  "packer"
  "qf"
  "diff"
  "fugitive"
  "fugitiveblame"
]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.picker

Change the default window picker, can be a string "default" or a function. The function should return the window id that will open the node, or nil if an invalid window is picked or user cancelled the action.

The picker may create a new window.

Type: string

Default: "default"

Example:

-- with s1n7ax/nvim-window-picker plugin
require('window-picker').pick_window,

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.remove_file.close_window

Close any window displaying a file when removing the file from the tree

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.actions.use_system_clipboard

A boolean value that toggle the use of system clipboard when copy/paste function are invoked. When enabled, copied text will be stored in registers ‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.auto_reload_on_write

Auto reload tree on write

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics

Show LSP and COC diagnostics in the signcolumn Note that the modified sign will take precedence over the diagnostics signs.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.enable

Whether to enable diagnostics view in the signcolumn…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.debounce_delay

Idle milliseconds between diagnostic event and update.

Type: signed integer

Default: 50

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.icons

Icons for diagnostic severity.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.icons.error

Icon used for error diagnostic.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.icons.hint

Icon used for hint diagnostic.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.icons.info

Icon used for info diagnostic.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.icons.warning

Icon used for warning diagnostic.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.severity

Severity for which the diagnostics will be displayed. See :help diagnostic-severity

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.severity.max

Maximum severity.

Type: one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: "ERROR"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.severity.min

Minimum severity.

Type: one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: "HINT"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.show_on_dirs

Show diagnostic icons on parent directories.

Type: unspecified value

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.diagnostics.show_on_open_dirs

Show diagnostics icons on directories that are open. Only relevant when diagnostics.show_on_dirs is true.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.disable_netrw

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filesystem_watchers

Will use file system watcher (libuv fs_event) to watch the filesystem for changes. Using this will disable BufEnter / BufWritePost events in nvim-tree which were used to update the whole tree. With this feature, the tree will be updated only for the appropriate folder change, resulting in better performance.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filesystem_watchers.enable

Enable filesystem watchers.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filesystem_watchers.debounce_delay

Idle milliseconds between filesystem change and action.

Type: signed integer

Default: 50

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filesystem_watchers.ignore_dirs

List of vim regex for absolute directory paths that will not be watched. Backslashes must be escaped e.g. "my-project/\\.build$". Useful when path is not in .gitignore or git integration is disabled.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters

Filtering options.

Type: submodule

Default:

{
  dotfiles = false;
  exclude = [ ];
  git_clean = false;
  git_ignored = false;
  no_buffer = false;
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters.dotfiles

Do not show dotfiles: files starting with a .

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters.exclude

List of directories or files to exclude from filtering: always show them.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters.git_clean

Do not show files with no git status. This will show ignored files when nvimTree.filters.gitIgnored is set, as they are effectively dirty.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters.git_ignored

Ignore files based on .gitignore. Requires git.enableto betrue`

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.filters.no_buffer

Do not show files that have no buflisted() buffer.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.git.enable

Whether to enable Git integration with icons and colors…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.git.disable_for_dirs

Disable git integration when git top-level matches these paths. May be relative, evaluated via ":p"

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.git.show_on_dirs

Show git icons on parent directories.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.git.show_on_open_dirs

Show git icons on directories that are open.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.git.timeout

Kills the git process after some time if it takes too long. Git integration will be disabled after 10 git jobs exceed this timeout.

Type: signed integer

Default: 400

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.hijack_cursor

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.hijack_directories.enable

Enable the hijack_directories feature. Disable this option if you use vim-dirvish or dirbuf.nvim. If hijack_netrw and disable_netrw are false, this feature will be disabled.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.hijack_directories.auto_open

Opens the tree if the tree was previously closed.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.hijack_netrw

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.hijack_unnamed_buffer_when_opening

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.live_filter

Configurations for the live_filtering feature. The live filter allows you to filter the tree nodes dynamically, based on regex matching (see vim.regex). This feature is bound to the f key by default. The filter can be cleared with the F key by default.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.live_filter.always_show_folders

Whether to filter folders or not.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.live_filter.prefix

Prefix of the filter displayed in the buffer.

Type: string

Default: "[FILTER]: "

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.modified

Indicate which file have unsaved modification.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.modified.enable

Whether to enable Modified files with icons and color highlight…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.modified.show_on_dirs

Show modified icons on parent directories.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.modified.show_on_open_dirs

Show modified icons on directories that are open.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.notify

Configuration for notifications.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.notify.absolute_path

Whether to use absolute paths or item names in fs action notifications.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.notify.threshold

Specify minimum notification level, uses the values from vim.log.levels

Type: one of “ERROR”, “WARNING”, “INFO”, “DEBUG”

Default: "INFO"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.prefer_startup_root

Prefer startup root directory when updating root directory of the tree. Only relevant when update_focused_file.update_root is true

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.reload_on_bufenter

Automatically reloads the tree on BufEnter nvim-tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.add_trailing

Appends a trailing slash to folder names.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.full_name

Display node whose name length is wider than the width of nvim-tree window in floating window.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.group_empty

Compact folders that only contain a single folder into one node in the file tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.highlight_git

Enable file highlight for git attributes using NvimTreeGit highlight groups. Requires nvimTree.git.enable This can be used with or without the icons.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.highlight_modified

Highlight modified files in the tree using NvimTreeNormal highlight group. Requires nvimTree.view.highlightOpenedFiles

Type: one of “none”, “icon”, “name”, “all”

Default: "none"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.highlight_opened_files

Highlight icons and/or names for bufloaded() files using the NvimTreeOpenedFile highlight group.

Type: one of “none”, “icon”, “name”, “all”

Default: "none"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons

Configuration options for icons.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.git_placement

Place where the git icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: one of “before”, “after”, “signcolumn”

Default: "before"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs

Configuration options for icon glyphs. NOTE: Do not set any glyphs to more than two characters if it’s going to appear in the signcolumn.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.default

Glyph for files. Will be overridden by nvim-web-devicons if available.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.folder

Glyphs for directories. Recommended to use the defaults unless you know what you are doing.

Type: attribute set

Default:

{
  arrow_closed = "";
  arrow_open = "";
  default = "";
  empty = "";
  empty_open = "";
  open = "";
  symlink = "";
  symlink_open = "";
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.git

Glyphs for git status.

Type: attribute set

Default:

{
  deleted = "";
  ignored = "◌";
  renamed = "➜";
  staged = "✓";
  unmerged = "";
  unstaged = "✗";
  untracked = "★";
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.modified

Icon to display for modified files.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.symlink

Glyph for symlinks.

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.modified_placement

Place where the modified icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: one of “before”, “after”, “signcolumn”

Default: "after"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.padding

Inserted between icon and filename

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.show.file

Show an icon before the file name. nvim-web-devicons will be used if available.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder

Show an icon before the folder name.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder_arrow

Show a small arrow before the folder node. Arrow will be a part of the node when using renderer.indent_markers.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.show.git

Show a git status icon, see renderer.icons.gitPlacement Requires git.enable to be true.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.show.modified

Show a modified icon, see renderer.icons.modifiedPlacement Requires modified.enable to be true.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.symlink_arrow

Used as a separator between symlinks’ source and target.

Type: string

Default: " ➛ "

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.icons.webdev_colors

Use the webdev icon colors, otherwise NvimTreeFileIcon

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.indent_markers

Configuration options for tree indent markers.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.indent_markers.enable

Whether to enable Display indent markers when folders are open…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.indent_markers.icons

Individual elements of the indent markers

Type: attribute set

Default:

{
  bottom = "─";
  corner = "└";
  edge = "│";
  item = "│";
  none = "";
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.indent_markers.inline_arrows

Display folder arrows in the same column as indent marker when using renderer.icons.show.folder_arrow

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.indent_width

Number of spaces for an each tree nesting level. Minimum 1.

Type: signed integer

Default: 2

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.root_folder_label

In what format to show root folder. See :help filename-modifiers for available string options. Set to false to hide the root folder.

Function is passed the absolute path of the root folder and should return a string. e.g. my_root_folder_label = function(path) return “…/” … vim.fn.fnamemodify(path, “:t”) end

Type: string or boolean

Default: false

Example: "\"\":~:s?$?/..?\""

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.special_files

A list of filenames that gets highlighted with `NvimTreeSpecialFile

Type: list of string

Default:

[
  "Cargo.toml"
  "README.md"
  "readme.md"
  "Makefile"
  "MAKEFILE"
  "flake.nix"
]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.renderer.symlink_destination

Whether to show the destination of the symlink.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.respect_buf_cwd

Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.root_dirs

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.select_prompts

Whether to enable Use vim.ui.select style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.sort.folders_first

Sort folders before files. Has no effect when sort.sorter is a function.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.sort.sorter

How files within the same directory are sorted.

Type: one of “name”, “extension”, “modification_time”, “case_sensitive”, “suffix”, “filetype”

Default: "name"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.sync_root_with_cwd

Changes the tree root directory on DirChanged and refreshes the tree. Only relevant when updateFocusedFile.updateRoot is true

(previously update_cwd)

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.system_open.args

Optional argument list.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.system_open.cmd

The open command itself

Type: string

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

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.tab

Configuration for tab behaviour.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.tab.sync

Configuration for syncing nvim-tree across tabs.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.tab.sync.close

Closes the tree across all tabpages when the tree is closed.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.tab.sync.ignore

List of filetypes or buffer names on new tab that will prevent nvimTree.tab.sync.open and nvimTree.tab.sync.close

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.tab.sync.open

Opens the tree automatically when switching tabpage or opening a new tabpage if the tree was previously open.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.trash

Configuration options for trashing.

Type: submodule

Default:

{
  cmd = "\${pkgs.glib}/bin/gio trash";
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.trash.cmd

The command used to trash items

Type: string

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.ui

General UI configuration.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.ui.confirm.remove

Prompt before removing.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.ui.confirm.trash

Prompt before trash.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.update_focused_file

Update the focused file on BufEnter, un-collapses the folders recursively until it finds the file.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.update_focused_file.enable

update focused file

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.update_focused_file.ignore_list

List of buffer names and filetypes that will not update the root dir of the tree if the file isn’t found under the current root directory. Only relevant when update_focused_file.update_root and update_focused_file.enable are true.

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.update_focused_file.update_root

Update the root directory of the tree if the file is not under current root directory. It prefers vim’s cwd and root_dirs. Otherwise it falls back to the folder containing the file. Only relevant when update_focused_file.enable is true

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view

Window / buffer setup.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.centralize_selection

If true, reposition the view so that the current node is initially centralized when entering nvim-tree.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.cursorline

Enable cursorline in nvim-tree window.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.debounce_delay

Idle milliseconds before some reload / refresh operations. Increase if you experience performance issues around screen refresh.

Type: signed integer

Default: 15

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.float

Configuration options for floating window.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.float.enable

If true, tree window will be floating.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.float.open_win_config

Floating window config. See :h nvim_open_win() for more details.

Type: attribute set

Default:

{
  border = "rounded";
  col = 1;
  height = 30;
  relative = "editor";
  row = 1;
  width = 30;
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.float.quit_on_focus_loss

Close the floating tree window when it loses focus.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.number

Print the line number in front of each line.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.preserve_window_proportions

Preserves window proportions when opening a file. If false, the height and width of windows other than nvim-tree will be equalized.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.relativenumber

Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line will be the line number instead of 0.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.side

Side of the tree.

Type: one of “left”, “right”

Default: "left"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.signcolumn

Show diagnostic sign column. Value can be "yes", "auto" or"no".

Type: one of “yes”, “auto”, “no”

Default: "yes"

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.filetree.nvimTree.setupOpts.view.width

Width of the window: can be a % string, a number representing columns, a function or a table.

A table (an attribute set in our case, see example) indicates that the view should be dynamically sized based on the longest line.

Type: signed integer or (attribute set)

Default: 30

Example:

{
  min = 30;
  max = -1;
  padding = 1;
}

Declared by:

<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix>
vim.gestures.gesture-nvim.enable

Whether to enable gesture-nvim: mouse gestures.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix>
vim.gestures.gesture-nvim.mappings.draw

Start drawing [gesture.nvim]

Type: null or string

Default: "<LeftDrag>"

Declared by:

<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix>
vim.gestures.gesture-nvim.mappings.finish

Finish drawing [gesture.nvim]

Type: null or string

Default: "<LeftRelease>"

Declared by:

<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix>
vim.git.enable

Whether to enable git integration suite.

Enabling this option will enable the following plugins:

  • gitsigns

  • vim-fugitive .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/git>
vim.git.gitsigns.enable

Whether to enable gitsigns.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.codeActions.enable

Whether to enable gitsigns codeactions through null-ls.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.blameLine

Blame line [Gitsigns]

Type: null or string

Default: "<leader>hb"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.diffProject

Diff project [Gitsigns]

Type: null or string

Default: "<leader>hD"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.diffThis

Diff this [Gitsigns]

Type: null or string

Default: "<leader>hd"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.nextHunk

Next hunk [Gitsigns]

Type: null or string

Default: "]c"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.previewHunk

Preview hunk [Gitsigns]

Type: null or string

Default: "<leader>hP"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.previousHunk

Previous hunk [Gitsigns]

Type: null or string

Default: "[c"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.resetBuffer

Reset buffer [Gitsigns]

Type: null or string

Default: "<leader>hR"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.resetHunk

Reset hunk [Gitsigns]

Type: null or string

Default: "<leader>hr"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.stageBuffer

Stage buffer [Gitsigns]

Type: null or string

Default: "<leader>hS"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.stageHunk

Stage hunk [Gitsigns]

Type: null or string

Default: "<leader>hs"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.toggleBlame

Toggle blame [Gitsigns]

Type: null or string

Default: "<leader>tb"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.toggleDeleted

Toggle deleted [Gitsigns]

Type: null or string

Default: "<leader>td"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.gitsigns.mappings.undoStageHunk

Undo stage hunk [Gitsigns]

Type: null or string

Default: "<leader>hu"

Declared by:

<nvf/modules/plugins/git/gitsigns/gitsigns.nix>
vim.git.vim-fugitive.enable

Whether to enable vim-fugitive.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/git/vim-fugitive/vim-fugitive.nix>
vim.globals

An attribute set containing global variable values for storing vim variables as early as possible. If populated, this soption will set vim variables in the built configRC as the first item.

E.g. {foo = “bar”} will set g:foo to “bar” where the type of bar in the resulting vimscript will be infered from the type of the value in the {name = value} pair.

Type: attribute set

Default: { }

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.hideSearchHighlight

Hide search highlight so it doesn’t stay highlighted

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.languages.enableDAP

Turn on Debug Adapter for enabled languages by default

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages>
vim.languages.enableExtraDiagnostics

Turn on extra diagnostics for enabled languages by default

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages>
vim.languages.enableFormat

Turn on Formatting for enabled languages by default

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages>
vim.languages.enableLSP

Turn on LSP for enabled languages by default

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages>
vim.languages.enableTreesitter

Turn on Treesitter for enabled languages by default

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages>
vim.languages.bash.enable

Whether to enable Bash language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.extraDiagnostics.enable

Whether to enable extra Bash diagnostics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.extraDiagnostics.types

List of Bash diagnostics to enable

Type: list of (value “shellcheck” (singular enum) or (submodule))

Default:

[
  "shellcheck"
]

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.format.enable

Enable Bash formatting

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.format.package

Bash formatter package

Type: package

Default: <derivation shfmt-3.8.0>

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.format.type

Bash formatter to use

Type: value “shfmt” (singular enum)

Default: "shfmt"

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.lsp.enable

Whether to enable Enable Bash LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.lsp.package

bash-language-server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation bash-language-server-5.1.2>

Example: [lib.getExe pkgs.nodePackages.bash-language-server "start"]

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.lsp.server

Bash LSP server to use

Type: value “bash-ls” (singular enum)

Default: "bash-ls"

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.treesitter.enable

Whether to enable Bash treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.bash.treesitter.package

The bash treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/bash.nix>
vim.languages.clang.enable

Whether to enable C/C++ language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.cHeader

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:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.dap.enable

Enable clang Debug Adapter

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.dap.package

clang debugger package.

Type: package

Default: <derivation lldb-17.0.6>

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.dap.debugger

clang debugger to use

Type: value “lldb-vscode” (singular enum)

Default: "lldb-vscode"

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.lsp.enable

Whether to enable clang LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.lsp.package

clang LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation ccls-0.20240202>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.lsp.opts

Options to pass to clang LSP server

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.lsp.server

The clang LSP server to use

Type: one of “ccls”, “clangd”

Default: "ccls"

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.treesitter.enable

Whether to enable C/C++ treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.treesitter.cPackage

The c treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.clang.treesitter.cppPackage

The cpp treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/clang.nix>
vim.languages.css.enable

Whether to enable CSS language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.format.enable

Whether to enable CSS formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.format.package

CSS formatter package

Type: package

Default: <derivation prettier-3.2.5>

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.format.type

CSS formatter to use

Type: one of “prettier”, “prettierd”

Default: "prettier"

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.lsp.enable

Whether to enable CSS LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.lsp.package

CSS LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation vscode-langservers-extracted-4.8.0>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.lsp.server

CSS LSP server to use

Type: value “vscode-langservers-extracted” (singular enum)

Default: "vscode-langservers-extracted"

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.treesitter.enable

Whether to enable CSS treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.css.treesitter.package

The css treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/css.nix>
vim.languages.dart.enable

Whether to enable Dart language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.dap.enable

Enable Dart DAP support via flutter-tools

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.enable

Enable flutter-tools for flutter support

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.enableNoResolvePatch

Whether to patch flutter-tools so that it doesn’t resolve symlinks when detecting flutter path.

This is required if you want to use a flutter package built with nix. If you are using a flutter SDK installed from a different source and encounter the error “dart missing from PATH”, disable this option.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.color.enable

Whether to enable highlighting color variables.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.color.highlightBackground

Highlight the background

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.color.highlightForeground

Highlight the foreground

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.color.virtualText.enable

Whether to enable Show the highlight using virtual text.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.flutter-tools.color.virtualText.character

Virtual text character to highlight

Type: string

Default: "■"

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.lsp.enable

Whether to enable Dart LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.lsp.package

Dart LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation dart-3.3.3>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.lsp.opts

Options to pass to Dart LSP server

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.lsp.server

The Dart LSP server to use

Type: value “dart” (singular enum)

Default: "dart"

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.treesitter.enable

Whether to enable Dart treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.dart.treesitter.package

The dart treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/dart.nix>
vim.languages.elixir.enable

Whether to enable Elixir language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.elixir-tools.enable

Whether to enable Elixir tools.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.format.enable

Whether to enable Elixir formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.format.package

Elixir formatter package

Type: package

Default: <derivation elixir-1.16.2>

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.format.type

Elixir formatter to use

Type: value “mix” (singular enum)

Default: "mix"

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.lsp.enable

Whether to enable Elixir LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.lsp.package

Elixir LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation elixir-ls-0.20.0>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.lsp.server

Elixir LSP server to use

Type: value “elixirls” (singular enum)

Default: "elixirls"

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.treesitter.enable

Whether to enable Elixir treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.elixir.treesitter.package

The elixir treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/elixir.nix>
vim.languages.go.enable

Whether to enable Go language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.dap.enable

Enable Go Debug Adapter

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.dap.package

Go debugger package.

Type: package

Default: <derivation delve-1.22.1>

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.dap.debugger

Go debugger to use

Type: value “delve” (singular enum)

Default: "delve"

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.lsp.enable

Whether to enable Go LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.lsp.package

Go LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation gopls-0.15.3>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.lsp.server

Go LSP server to use

Type: value “gopls” (singular enum)

Default: "gopls"

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.treesitter.enable

Whether to enable Go treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.go.treesitter.package

The go treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/go.nix>
vim.languages.html.enable

Whether to enable HTML language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/html.nix>
vim.languages.html.treesitter.enable

Whether to enable HTML treesitter support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/html.nix>
vim.languages.html.treesitter.package

The html treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/html.nix>
vim.languages.html.treesitter.autotagHtml

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

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/languages/html.nix>
vim.languages.java.enable

Whether to enable Java language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/java.nix>
vim.languages.java.lsp.enable

Whether to enable Java LSP support (java-language-server).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/java.nix>
vim.languages.java.lsp.package

java language server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation jdt-language-server-1.31.0>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/java.nix>
vim.languages.java.treesitter.enable

Whether to enable Java treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/java.nix>
vim.languages.java.treesitter.package

The java treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/java.nix>
vim.languages.lua.enable

Whether to enable Lua language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.lua.lsp.enable

Whether to enable Lua LSP support via LuaLS.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.lua.lsp.package

LuaLS package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation lua-language-server-3.7.4>

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.lua.lsp.neodev.enable

Whether to enable neodev.nvim integration, useful for neovim plugin developers.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.lua.treesitter.enable

Whether to enable Lua Treesitter support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.lua.treesitter.package

The lua treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/lua.nix>
vim.languages.markdown.enable

Whether to enable Markdown markup language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.format.enable

Whether to enable Markdown formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.format.package

Markdown formatter package

Type: package

Default: <derivation deno-1.42.3>

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.format.extraFiletypes

Extra filetypes to format with the Markdown formatter

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.format.type

Markdown formatter to use

Type: value “denofmt” (singular enum)

Default: "denofmt"

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.lsp.enable

Whether to enable Enable Markdown LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.lsp.package

Markdown LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation marksman-2023-12-09>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.lsp.server

Markdown LSP server to use

Type: value “marksman” (singular enum)

Default: "marksman"

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.treesitter.enable

Enable Markdown treesitter

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.treesitter.mdInlinePackage

The markdown-inline treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.markdown.treesitter.mdPackage

The markdown treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/markdown.nix>
vim.languages.nim.enable

Whether to enable Nim language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.format.enable

Whether to enable Nim formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.format.package

Nim formatter package

Type: package

Default: <derivation x86_64-unknown-linux-gnu-nim-wrapper-2.0.2>

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.format.type

Nim formatter to use

Type: value “nimpretty” (singular enum)

Default: "nimpretty"

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.lsp.enable

Whether to enable Nim LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.lsp.package

Nim LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation nimlsp-0.4.6>

Example: "[lib.getExe pkgs.nimlsp]"

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.lsp.server

Nim LSP server to use

Type: string

Default: "nimlsp"

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.treesitter.enable

Whether to enable Nim treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nim.treesitter.package

The nim treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/nim.nix>
vim.languages.nix.enable

Whether to enable Nix language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.extraDiagnostics.enable

Whether to enable extra Nix diagnostics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.extraDiagnostics.types

List of Nix diagnostics to enable

Type: list of (one of “deadnix”, “statix” or (submodule))

Default:

[
  "statix"
  "deadnix"
]

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.format.enable

Whether to enable Nix formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.format.package

Nix formatter package

Type: package

Default: <derivation alejandra-3.0.0>

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.format.type

Nix formatter to use

Type: one of “alejandra”, “nixpkgs-fmt”

Default: "alejandra"

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.lsp.enable

Whether to enable Nix LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.lsp.package

Nix LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation nil-2023-08-09>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.lsp.server

Nix LSP server to use

Type: string

Default: "nil"

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.treesitter.enable

Whether to enable Nix treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.nix.treesitter.package

The nix treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/nix.nix>
vim.languages.php.enable

Whether to enable PHP language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.php.lsp.enable

Whether to enable PHP LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.php.lsp.package

PHP LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation phpactor-2024.03.09.0>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.php.lsp.server

PHP LSP server to use

Type: one of “phan”, “phpactor”

Default: "phpactor"

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.php.treesitter.enable

Whether to enable PHP treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.php.treesitter.package

The php treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/php.nix>
vim.languages.python.enable

Whether to enable Python language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.dap.enable

Enable Python Debug Adapter

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.dap.package

Python debugger package. This is a python package with debugpy installed, see https://nixos.wiki/wiki/Python#Install_Python_Packages.

Type: package

Default: <derivation python3-3.11.9-env>

Example: with pkgs; python39.withPackages (ps: with ps; [debugpy])

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.dap.debugger

Python debugger to use

Type: value “debugpy” (singular enum)

Default: "debugpy"

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.format.enable

Whether to enable Python formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.format.package

Python formatter package

Type: package

Default: <derivation black-24.3.0>

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.format.type

Python formatter to use

Type: one of “black”, “black-and-isort”, “isort”

Default: "black"

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.lsp.enable

Whether to enable Python LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.lsp.package

python LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation pyright-1.1.354>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.lsp.server

Python LSP server to use

Type: value “pyright” (singular enum)

Default: "pyright"

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.treesitter.enable

Whether to enable Python treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.python.treesitter.package

Python treesitter grammar to use

Type: package

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

Declared by:

<nvf/modules/plugins/languages/python.nix>
vim.languages.rust.enable

Whether to enable Rust language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.crates.enable

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

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.crates.codeActions

Enable code actions through null-ls

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.dap.enable

Rust Debug Adapter support

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.dap.package

lldb pacakge

Type: package

Default: <derivation lldb-17.0.6>

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.lsp.enable

Whether to enable Rust LSP support (rust-analyzer with extra tools).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.lsp.package

rust-analyzer package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation rust-analyzer-2024-04-08>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.lsp.opts

Options to pass to rust analyzer

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.treesitter.enable

Whether to enable Rust treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.rust.treesitter.package

The rust treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/rust.nix>
vim.languages.sql.enable

Whether to enable SQL language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.dialect

SQL dialect for sqlfluff (if used)

Type: string

Default: "ansi"

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.extraDiagnostics.enable

Whether to enable extra SQL diagnostics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.extraDiagnostics.types

List of SQL diagnostics to enable

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

Default:

[
  "sqlfluff"
]

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.format.enable

Whether to enable SQL formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.format.package

SQL formatter package

Type: package

Default: <derivation sqlfluff-3.0.5>

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.format.type

SQL formatter to use

Type: value “sqlfluff” (singular enum)

Default: "sqlfluff"

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.lsp.enable

Whether to enable SQL LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.lsp.package

SQL LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation sqls-0.2.28>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.lsp.server

SQL LSP server to use

Type: value “sqls” (singular enum)

Default: "sqls"

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.treesitter.enable

Whether to enable SQL treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.sql.treesitter.package

SQL treesitter grammar to use

Type: package

Default: <derivation sql-grammar-0.0.0+rev=25f94f9>

Declared by:

<nvf/modules/plugins/languages/sql.nix>
vim.languages.svelte.enable

Whether to enable Svelte language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.extraDiagnostics.enable

Whether to enable extra Svelte diagnostics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.extraDiagnostics.types

List of Svelte diagnostics to enable

Type: list of (value “eslint_d” (singular enum) or (submodule))

Default:

[
  "eslint_d"
]

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.format.enable

Whether to enable Svelte formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.format.package

Svelte formatter package

Type: package

Default: <derivation prettier-3.2.5>

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.format.type

Svelte formatter to use

Type: value “prettier” (singular enum)

Default: "prettier"

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.lsp.enable

Whether to enable Svelte LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.lsp.package

Svelte LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation svelte-language-server-0.16.5>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.lsp.server

Svelte LSP server to use

Type: value “svelte” (singular enum)

Default: "svelte"

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.treesitter.enable

Whether to enable Svelte treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.svelte.treesitter.sveltePackage

The svelte treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/svelte.nix>
vim.languages.tailwind.enable

Whether to enable Tailwindcss language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/tailwind.nix>
vim.languages.tailwind.lsp.enable

Whether to enable Tailwindcss LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/tailwind.nix>
vim.languages.tailwind.lsp.package

Tailwindcss LSP server package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation tailwindcss-language-server-0.0.16>

Example: "[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

<nvf/modules/plugins/languages/tailwind.nix>
vim.languages.tailwind.lsp.server

Tailwindcss LSP server to use

Type: value “tailwindcss-language-server” (singular enum)

Default: "tailwindcss-language-server"

Declared by:

<nvf/modules/plugins/languages/tailwind.nix>
vim.languages.terraform.enable

Whether to enable Terraform/HCL support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/terraform.nix>
vim.languages.terraform.lsp.enable

Whether to enable Terraform LSP support (terraform-ls).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/terraform.nix>
vim.languages.terraform.lsp.package

terraform-ls package

Type: package

Default: <derivation terraform-ls-0.33.1>

Declared by:

<nvf/modules/plugins/languages/terraform.nix>
vim.languages.terraform.treesitter.enable

Whether to enable Terraform treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/terraform.nix>
vim.languages.terraform.treesitter.package

The terraform treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/terraform.nix>
vim.languages.ts.enable

Whether to enable Typescript/Javascript language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.extraDiagnostics.enable

Whether to enable extra Typescript/Javascript diagnostics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.extraDiagnostics.types

List of Typescript/Javascript diagnostics to enable

Type: list of (value “eslint_d” (singular enum) or (submodule))

Default:

[
  "eslint_d"
]

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.format.enable

Whether to enable Typescript/Javascript formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.format.package

Typescript/Javascript formatter package

Type: package

Default: <derivation prettier-3.2.5>

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.format.type

Typescript/Javascript formatter to use

Type: one of “prettier”, “prettierd”

Default: "prettier"

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.lsp.enable

Whether to enable Typescript/Javascript LSP support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.lsp.package

Typescript/Javascript LSP server package, or the command to run as a list of strings

Type: package or list of string

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

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.lsp.server

Typescript/Javascript LSP server to use

Type: one of “denols”, “tsserver”

Default: "tsserver"

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.treesitter.enable

Whether to enable Typescript/Javascript treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.treesitter.jsPackage

The javascript treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.ts.treesitter.tsPackage

The tsx treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/ts.nix>
vim.languages.typst.enable

Whether to enable Typst language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.format.enable

Whether to enable Typst document formatting.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.format.package

Typst formatter package

Type: package

Default: <derivation typstfmt-0.2.9>

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.format.type

Typst formatter to use

Type: one of “typstfmt”, “typstyle”

Default: "typstfmt"

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.lsp.enable

Whether to enable Typst LSP support (typst-lsp).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.lsp.package

typst-lsp package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation typst-lsp-0.13.0>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.treesitter.enable

Whether to enable Typst treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.typst.treesitter.package

The typst treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/typst.nix>
vim.languages.zig.enable

Whether to enable Zig language support.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.languages.zig.lsp.enable

Whether to enable Zig LSP support (zls).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.languages.zig.lsp.package

ZLS package, or the command to run as a list of strings

Type: package or list of string

Default: <derivation zls-0.11.0>

Example: "[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.languages.zig.lsp.zigPackage

Zig package used by ZLS

Type: package

Default: <derivation zig-0.11.0>

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.languages.zig.treesitter.enable

Whether to enable Zig treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.languages.zig.treesitter.package

The zig treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/languages/zig.nix>
vim.leaderKey

The leader key to be used internally

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.lineNumberMode

How line numbers are displayed.

Type: one of “relative”, “number”, “relNumber”, “none”

Default: "relNumber"

Example: none

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.lsp.enable

Whether to enable LSP, also enabled automatically through null-ls and lspconfig options.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.formatOnSave

Whether to enable format on save.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.lightbulb.enable

Whether to enable Lightbulb for code actions. Requires an emoji font.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lightbulb/lightbulb.nix>
vim.lsp.lspSignature.enable

Whether to enable lsp signature viewer.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lsp-signature/lsp-signature.nix>
vim.lsp.lspSignature.setupOpts

Option table to pass into the setup function of lsp-signature

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/lsp/lsp-signature/lsp-signature.nix>
vim.lsp.lspconfig.enable

Whether to enable nvim-lspconfig, also enabled automatically.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lspconfig/lspconfig.nix>
vim.lsp.lspconfig.sources

nvim-lspconfig sources

Type: attribute set of string

Default: { }

Declared by:

<nvf/modules/plugins/lsp/lspconfig/lspconfig.nix>
vim.lsp.lspkind.enable

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

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lspkind/lspkind.nix>
vim.lsp.lspkind.mode

Defines how annotations are shown

Type: one of “text”, “text_symbol”, “symbol_text”, “symbol”

Default: "symbol_text"

Declared by:

<nvf/modules/plugins/lsp/lspkind/lspkind.nix>
vim.lsp.lsplines.enable

Whether to enable diagnostics using virtual lines on top of the real line of code. [lsp_lines] .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lsplines/lsplines.nix>
vim.lsp.lspsaga.enable

Whether to enable LSP Saga.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.codeAction

Code action [LSPSaga]

Type: null or string

Default: "<leader>ca"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.lspFinder

LSP Finder [LSPSaga]

Type: null or string

Default: "<leader>lf"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.nextDiagnostic

Next diagnostic [LSPSaga]

Type: null or string

Default: "<leader>ln"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.previewDefinition

Preview definition [LSPSaga]

Type: null or string

Default: "<leader>ld"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.previousDiagnostic

Previous diagnostic [LSPSaga]

Type: null or string

Default: "<leader>lp"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.rename

Rename [LSPSaga]

Type: null or string

Default: "<leader>lr"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.renderHoveredDoc

Rendered hovered docs [LSPSaga]

Type: null or string

Default: "<leader>lh"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.showCursorDiagnostics

Show cursor diagnostics [LSPSaga]

Type: null or string

Default: "<leader>lc"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.showLineDiagnostics

Show line diagnostics [LSPSaga]

Type: null or string

Default: "<leader>ll"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.signatureHelp

Signature help [LSPSaga]

Type: null or string

Default: "<leader>ls"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.smartScrollDown

Smart scroll up [LSPSaga]

Type: null or string

Default: "<C-b>"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.lspsaga.mappings.smartScrollUp

Smart scroll up [LSPSaga]

Type: null or string

Default: "<C-f>"

Declared by:

<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix>
vim.lsp.mappings.addWorkspaceFolder

Add workspace folder

Type: null or string

Default: "<leader>lwa"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.codeAction

Code action

Type: null or string

Default: "<leader>la"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.documentHighlight

Document highlight

Type: null or string

Default: "<leader>lH"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.format

Format

Type: null or string

Default: "<leader>lf"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.goToDeclaration

Go to declaration

Type: null or string

Default: "<leader>lgD"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.goToDefinition

Go to definition

Type: null or string

Default: "<leader>lgd"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.goToType

Go to type

Type: null or string

Default: "<leader>lgt"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.hover

Trigger hover

Type: null or string

Default: "<leader>lh"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.listDocumentSymbols

List document symbols

Type: null or string

Default: "<leader>lS"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.listImplementations

List implementations

Type: null or string

Default: "<leader>lgi"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.listReferences

List references

Type: null or string

Default: "<leader>lgr"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.listWorkspaceFolders

List workspace folders

Type: null or string

Default: "<leader>lwl"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.listWorkspaceSymbols

List workspace symbols

Type: null or string

Default: "<leader>lws"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.nextDiagnostic

Go to next diagnostic

Type: null or string

Default: "<leader>lgn"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.openDiagnosticFloat

Open diagnostic float

Type: null or string

Default: "<leader>le"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.previousDiagnostic

Go to previous diagnostic

Type: null or string

Default: "<leader>lgp"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.removeWorkspaceFolder

Remove workspace folder

Type: null or string

Default: "<leader>lwr"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.renameSymbol

Rename symbol

Type: null or string

Default: "<leader>ln"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.signatureHelp

Signature help

Type: null or string

Default: "<leader>ls"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.mappings.toggleFormatOnSave

Toggle format on save

Type: null or string

Default: "<leader>ltf"

Declared by:

<nvf/modules/plugins/lsp/module.nix>
vim.lsp.null-ls.enable

Whether to enable null-ls, also enabled automatically.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/null-ls/null-ls.nix>
vim.lsp.null-ls.sources

null-ls sources

Type: attribute set of string

Default: { }

Declared by:

<nvf/modules/plugins/lsp/null-ls/null-ls.nix>
vim.lsp.nvim-docs-view.enable

Whether to enable nvim-docs-view, for displaying lsp hover documentation in a side panel…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.mappings.viewToggle

Open or close the docs view panel

Type: null or string

Default: "lvt"

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.mappings.viewUpdate

Manually update the docs view panel

Type: null or string

Default: "lvu"

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.setupOpts

Option table to pass into the setup function of nvim-docs-view

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.setupOpts.height

Height of the docs view panel if the position is set to either top or bottom

Type: signed integer

Default: 10

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.setupOpts.position

Where to open the docs view panel

Type: one of “left”, “right”, “top”, “bottom”

Default: "right"

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.setupOpts.update_mode

Determines the mechanism used to update the docs view panel content.

  • If auto, the content will update upon cursor move.

  • If manual, the content will only update once :DocsViewUpdate is called

Type: one of “auto”, “manual”

Default: "auto"

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvim-docs-view.setupOpts.width

Width of the docs view panel if the position is set to either left or right

Type: signed integer

Default: 60

Declared by:

<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix>
vim.lsp.nvimCodeActionMenu.enable

Whether to enable nvim code action menu.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix>
vim.lsp.nvimCodeActionMenu.mappings.open

Open code action menu [nvim-code-action-menu]

Type: null or string

Default: "<leader>ca"

Declared by:

<nvf/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix>
vim.lsp.nvimCodeActionMenu.show.actionKind

Whether to enable Show action kind.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix>
vim.lsp.nvimCodeActionMenu.show.details

Whether to enable Show details.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix>
vim.lsp.nvimCodeActionMenu.show.diff

Whether to enable Show diff.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix>
vim.lsp.trouble.enable

Whether to enable trouble diagnostics viewer.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.documentDiagnostics

Document diagnostics [trouble]

Type: null or string

Default: "<leader>ld"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.locList

LOCList [trouble]

Type: null or string

Default: "<leader>xl"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.lspReferences

LSP References [trouble]

Type: null or string

Default: "<leader>lr"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.quickfix

QuickFix [trouble]

Type: null or string

Default: "<leader>xq"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.toggle

Toggle trouble [trouble]

Type: null or string

Default: "<leader>xx"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.lsp.trouble.mappings.workspaceDiagnostics

Workspace diagnostics [trouble]

Type: null or string

Default: "<leader>lwd"

Declared by:

<nvf/modules/plugins/lsp/trouble/trouble.nix>
vim.luaConfigPost

Verbatim lua code that will be inserted after the result of the luaConfigRc DAG has been resolved

This option does not take a DAG set, but a string instead. Useful when you’d like to insert contents of lua configs after the DAG result.

Type: string

Default: ""

Example: "$${builtins.readFile ./my-lua-config-post.lua}"

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.luaConfigPre

Verbatim lua code that will be inserted before the result of luaConfigRc DAG has been resolved.

This option does not take a DAG set, but a string instead. Useful when you’d like to insert contents of lua configs after the DAG result.

Warning

You do not want to override this option with mkForce It is used internally to set certain options as early as possible and should be avoided unless you know what you’re doing. Passing a string to this option will merge it with the default contents.

Type: string

Default: By default, this option will append paths in vim.additionalRuntimePaths to the runtimepath and enable the experimental Lua module loader if vim.enableLuaLoader is set to true.

Example: "$${builtins.readFile ./my-lua-config-pre.lua}"

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.luaConfigRC

Lua configuration, either as a string or a DAG.

If this option is passed as a DAG, it will be resolved according to the DAG resolution rules (e.g. entryBefore or entryAfter) as per the nvf extended library.

Type: (DAG of strings concatenated with “\n”) or string

Default: { }

Example:

-- Set the tab size to 4 spaces
vim.opt.tabstop = 4
vim.opt.shiftwidth = 4
vim.opt.expandtab = true

Declared by:

<nvf/modules/wrapper/rc/options.nix>
vim.luaPackages

List of lua packages to install.

Type: list of string

Default: [ ]

Example: ["magick" "serpent"]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.mapLeaderSpace

Map the space key to leader key

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.mapTimeout

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

Type: signed integer

Default: 500

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.maps

Custom keybindings for any mode.

For plain maps (e.g. just ‘map’ or ‘remap’) use maps.normalVisualOp.

Type: submodule

Default: { }

Example:

''
  maps = {
    normal."<leader>m" = {
      silent = true;
      action = "<cmd>make<CR>";
    }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
  };
''

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command

Mappings for command-line mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.command.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert

Mappings for insert mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insert.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand

Mappings for insert and command-line mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.insertCommand.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang

Mappings for insert, command-line and lang-arg mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.lang.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal

Mappings for normal mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normal.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp

Mappings for normal, visual, select and operator-pending (same as plain ‘map’) mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.normalVisualOp.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator

Mappings for operator-pending mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.operator.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select

Mappings for select mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.select.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal

Mappings for terminal mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.terminal.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual

Mappings for visual and select mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visual.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly

Mappings for visual only mode

Type: attribute set of (submodule)

Default: { }

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.action

The action to execute.

Type: string

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.desc

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

Type: null or string

Default: null

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.expr

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.lua

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.noremap

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

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.nowait

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.script

Equivalent to adding <script> to a map.

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.silent

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.maps.visualOnly.<name>.unique

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/mappings/options.nix>
vim.minimap.codewindow.enable

Whether to enable codewindow plugin for minimap view.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/minimap/codewindow/codewindow.nix>
vim.minimap.codewindow.mappings.close

Close minimap [codewindow]

Type: null or string

Default: "<leader>mc"

Declared by:

<nvf/modules/plugins/minimap/codewindow/codewindow.nix>
vim.minimap.codewindow.mappings.open

Open minimap [codewindow]

Type: null or string

Default: "<leader>mo"

Declared by:

<nvf/modules/plugins/minimap/codewindow/codewindow.nix>
vim.minimap.codewindow.mappings.toggle

Toggle minimap [codewindow]

Type: null or string

Default: "<leader>mm"

Declared by:

<nvf/modules/plugins/minimap/codewindow/codewindow.nix>
vim.minimap.codewindow.mappings.toggleFocus

Toggle minimap focus [codewindow]

Type: null or string

Default: "<leader>mf"

Declared by:

<nvf/modules/plugins/minimap/codewindow/codewindow.nix>
vim.minimap.minimap-vim.enable

Whether to enable minimap view [minimap-vim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/minimap/minimap-vim/minimap-vim.nix>
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”

Default: "a"

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.notes.mind-nvim.enable

Whether to enable note organizer tool for Neovim [mind-nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/notes/mind-nvim/mind-nvim.nix>
vim.notes.obsidian.enable

Whether to enable complementary neovim plugins for Obsidian editor.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.obsidian.setupOpts

Option table to pass into the setup function of Obsidian.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.obsidian.setupOpts.completion.nvim_cmp

If using nvim-cmp, otherwise set to false

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.obsidian.setupOpts.daily_notes.date_format

Date format used for creating daily notes

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.obsidian.setupOpts.daily_notes.folder

Directory in which daily notes should be created

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.obsidian.setupOpts.dir

Obsidian vault directory

Type: string

Default: "~/my-vault"

Declared by:

<nvf/modules/plugins/notes/obsidian/obsidian.nix>
vim.notes.orgmode.enable

Whether to enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.orgmode.setupOpts

Option table to pass into the setup function of Orgmode

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.orgmode.setupOpts.org_agenda_files

List of org files to be used as agenda files.

Type: list of string

Default:

[
  "~/Documents/org/*"
  "~/my-orgs/**/*"
]

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.orgmode.setupOpts.org_default_notes_file

Default org file to be used for notes.

Type: string

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

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.orgmode.treesitter.enable

Whether to enable Orgmode treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.orgmode.treesitter.orgPackage

The org treesitter package to use.

Type: package

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

Declared by:

<nvf/modules/plugins/notes/orgmode/orgmode.nix>
vim.notes.todo-comments.enable

Whether to enable todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.mappings.quickFix

Open Todo-s in a quickfix list

Type: null or string

Default: "<leader>tdq"

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.mappings.telescope

Open Todo-s in telescope

Type: null or string

Default: "<leader>tds"

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.mappings.trouble

Open Todo-s in Trouble

Type: null or string

Default: "<leader>tdt"

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.setupOpts

Option table to pass into the setup function of todo-comments.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.setupOpts.highlight.pattern

vim regex pattern used for highlighting comments

Type: string

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

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.setupOpts.search.args

arguments to pass to the search command

Type: list of string

Default:

[
  "--color=never"
  "--no-heading"
  "--with-filename"
  "--line-number"
  "--column"
]

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.setupOpts.search.command

search command

Type: string

Default: "\${pkgs.ripgrep}/bin/rg"

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notes.todo-comments.setupOpts.search.pattern

ripgrep regex pattern used for searching comments

Type: string

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

Declared by:

<nvf/modules/plugins/notes/todo-comments/todo-comments.nix>
vim.notify.nvim-notify.enable

Whether to enable nvim-notify notifications.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts

Option table to pass into the setup function of nvim-notify

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.background_colour

The background colour of the notification

Type: string

Default: "#000000"

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.icons

The icons of the notification

Type: attribute set of string

Default:

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

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.position

The position of the notification

Type: one of “top_left”, “top_right”, “bottom_left”, “bottom_right”

Default: "top_right"

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.render

Custom rendering method to be used for displaying notifications

Type: one of “default”, “minimal”, “simple”, “compact”, “wrapped-compact” or (luaInline)

Default: "compact"

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.stages

The stages of the notification

Type: one of “fade_in_slide_out”, “fade_in”, “slide_out”, “none”

Default: "fade_in_slide_out"

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.notify.nvim-notify.setupOpts.timeout

The timeout of the notification

Type: signed integer

Default: 1000

Declared by:

<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix>
vim.optPlugins

List of plugins to optionally load on startup.

This option has the same type definition as vim.startPlugins and plugins in this list are appended to vim.startPlugins by the wrapper during the build process.

To avoid overriding packages and dependencies provided by startPlugins, you are recommended to use this option or vim.extraPlugins option.

Type: list of (null or package or one of “alpha-nvim”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “cmp-vsnip”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fidget-nvim”, “flutter-tools”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lualine”, “mind-nvim”, “minimap-vim”, “modes-nvim”, “neocord”, “neodev-nvim”, “noice-nvim”, “none-ls”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-code-action-menu”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-web-devicons”, “obsidian-nvim”, “onedark”, “orgmode-nvim”, “oxocarbon”, “plenary-nvim”, “project-nvim”, “registers”, “rose-pine”, “rust-tools”, “scrollbar-nvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “vim-vsnip”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)

Default: [ ]

Example:

[pkgs.vimPlugins.vim-ghost]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.presence.neocord.enable

Whether to enable neocord plugin for discord rich presence.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts

Option table to pass into the setup function of neocord

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.enable_line_number

Show line number on the RPC item

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.auto_update

Automatically update the presence

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.blacklist

List of filetypes to ignore

Type: list of string

Default: [ ]

Example: ["Alpha"]

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.client_id

Client ID of the application

Type: string

Default: "1157438221865717891"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.debounce_timeout

Number of seconds to debounce events

Type: signed integer

Default: 10

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.editing_text

Text displayed when editing a file

Type: string

Default: "Editing %s"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.file_explorer_text

Text displayed when browsing files

Type: string

Default: "Browsing %s"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.git_commit_text

Text displayed when committing changes

Type: string

Default: "Committing changes"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.line_number_text

Text displayed when showing line number

Type: string

Default: "Line %s out of %s"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.log_level

Log level to be used by the plugin

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

Default: null

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.logo

Logo to be displayed on the RPC item

This must be either “auto” or an URL to your image of choice

Type: string

Default: "auto"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.logo_tooltip

Text displayed when hovering over the Neovim image

Type: string

Default: "The One True Text Editor"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.main_image

Main image to be displayed

Type: one of “language”, “logo”

Default: "language"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.plugin_manager_text

Text displayed when managing plugins

Type: string

Default: "Managing plugins"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.reading_text

Text displayed when reading a file

Type: string

Default: "Reading %s"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.show_time

Show time on the RPC item

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.terminal_text

Text displayed when working on the terminal

Type: string

Default: "Working on the terminal"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.presence.neocord.setupOpts.workspace_text

Text displayed when working on a project

Type: string

Default: "Working on %s"

Declared by:

<nvf/modules/plugins/rich-presence/neocord/neocord.nix>
vim.preventJunkFiles

Prevent swapfile and backupfile from being created

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.projects.project-nvim.enable

Whether to enable project-nvim for project management.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts

Option table to pass into the setup function of Project.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.detection_methods

Detection methods to use

Type: list of string

Default:

[
  "lsp"
  "pattern"
]

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.exclude_dirs

Directories to exclude from project root search

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.lsp_ignored

LSP servers no ignore by name

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.manual_mode

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:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.patterns

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:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.scope_chdir

What scope to change the directory

Type: one of “global”, “tab”, “win”

Default: "global"

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.show_hidden

Show hidden files in telescope picker

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.projects.project-nvim.setupOpts.silent_chdir

Silently change directory when changing project

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/projects/project-nvim/project-nvim.nix>
vim.python3Packages

List of python packages to install.

Type: list of string

Default: [ ]

Example: ["pynvim"]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.scrollOffset

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

Type: signed integer

Default: 8

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.searchCase

Set the case sensitivity of search

Type: one of “ignore”, “smart”, “sensitive”

Default: "sensitive"

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.session.nvim-session-manager.enable

Whether to enable nvim-session-manager: manage sessions like folders in VSCode.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.mappings.deleteSession

Delete session

Type: null or string

Default: "<leader>sd"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.mappings.loadLastSession

Load last session

Type: null or string

Default: "<leader>slt"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.mappings.loadSession

Load session

Type: null or string

Default: "<leader>sl"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.mappings.saveCurrentSession

Save current session

Type: null or string

Default: "<leader>sc"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autoload_mode

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:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_ignore_buftypes

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

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_ignore_dirs

A list of directories where the session will not be autosaved

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_ignore_filetypes

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

Type: list of string

Default:

[
  "gitcommit"
]

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_ignore_not_normal

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:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_last_session

Automatically save last session on exit and on session switch

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.autosave_only_in_session

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

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.colon_replacer

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

Type: string

Default: "++"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.max_path_length

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:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.setupOpts.path_replacer

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

Type: string

Default: "__"

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.session.nvim-session-manager.usePicker

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

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix>
vim.showSignColumn

Show the sign column

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.snippets.vsnip.enable

Whether to enable vim-vsnip: snippet LSP/VSCode’s format.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/snippets/vsnip/vsnip.nix>
vim.spellcheck.enable

Whether to enable Neovim’s built-in spellchecking.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/neovim/init/spellcheck.nix>
vim.spellcheck.ignoredFiletypes

A list of filetypes for which spellchecking will be disabled.

You may use echo &filetype in Neovim to find out the filetype for a specific buffer.

Type: list of string

Default:

[
  "toggleterm"
]

Example: ["markdown" "gitcommit"]

Declared by:

<nvf/modules/neovim/init/spellcheck.nix>
vim.spellcheck.languages

A list of languages that should be used for spellchecking.

To add your own language files, you may place your spell directory in either ~/.config/nvim or the additionalRuntimePaths directory provided by nvf.

Type: list of string

Default:

[
  "en"
]

Example: ["en" "de"]

Declared by:

<nvf/modules/neovim/init/spellcheck.nix>
vim.splitBelow

New splits will open below instead of on top

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.splitRight

New splits will open to the right

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.startPlugins

List of plugins to load on startup. This is used internally to add plugins to Neovim’s runtime.

To add additional plugins to your configuration, consider using the vim.extraPlugins option.

Type: list of (null or package or one of “alpha-nvim”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “cmp-vsnip”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fidget-nvim”, “flutter-tools”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lualine”, “mind-nvim”, “minimap-vim”, “modes-nvim”, “neocord”, “neodev-nvim”, “noice-nvim”, “none-ls”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-code-action-menu”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-web-devicons”, “obsidian-nvim”, “onedark”, “orgmode-nvim”, “oxocarbon”, “plenary-nvim”, “project-nvim”, “registers”, “rose-pine”, “rust-tools”, “scrollbar-nvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “vim-vsnip”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)

Default:

[
  "plenary-nvim"
]

Example:

[pkgs.vimPlugins.telescope-nvim]

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.statusline.lualine.enable

Whether to enable lualine statusline plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.a

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

Type: list of string

Default:

[
  ''
    {
      "mode",
      icons_enabled = true,
      separator = {
        left = '▎',
        right = ''
      },
    }
  ''
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.b

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

Type: list of 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:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.c

active config for: | A | B | © X | Y | Z |

Type: list of 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'
      },
      separator = {
        right = ''
      },
    }
  ''
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.x

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

Type: list of string

Default:

[
  ''
    {
      -- Lsp server name
      function()
        local buf_ft = vim.api.nvim_get_option_value('filetype', {})
    
        -- List of buffer types to exclude
        local excluded_buf_ft = {"toggleterm", "NvimTree", "TelescopePrompt"}
    
        -- Check if the current buffer type is in the excluded list
        for _, excluded_type in ipairs(excluded_buf_ft) do
          if buf_ft == excluded_type then
            return ""
          end
        end
    
        -- Get the name of the LSP server active in the current buffer
        local clients = vim.lsp.get_active_clients()
        local msg = 'No Active Lsp'
    
        -- if no lsp client is attached then return the msg
        if next(clients) == nil then
          return msg
        end
    
        for _, client in ipairs(clients) do
          local filetypes = client.config.filetypes
          if filetypes and vim.fn.index(filetypes, buf_ft) ~= -1 then
            return client.name
          end
        end
    
        return msg
      end,
      icon = ' ',
      color = {bg='none', fg='lavender'},
      separator = {
        left = '',
      },
    }
  ''
  ''
    {
      "diagnostics",
      sources = {'nvim_lsp', 'nvim_diagnostic', 'coc'},
      symbols = {error = '󰅙  ', warn = '  ', info = '  ', hint = '󰌵 '},
      color = {bg='none', fg='lavender'},
      diagnostics_color = {
        color_error = { fg = 'red' },
        color_warn = { fg = 'yellow' },
        color_info = { fg = 'cyan' },
      },
    }
  ''
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.y

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

Type: list of string

Default:

[
  ''
    {
      'searchcount',
      maxcount = 999,
      timeout = 120,
      color = {bg='none', fg='lavender'}
    }
  ''
  ''
    {
      "branch",
      icon = ' •',
      color = {bg='none', fg='lavender'},
    }
  ''
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.activeSection.z

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

Type: list of string

Default:

[
  ''
    {
      "progress",
      separator = {
        left = '',
      },
    }
  ''
  ''
    {
      "location",
    }
  ''
  ''
    {
      "fileformat",
      color = {fg='black'},
      symbols = {
        unix = '', -- e712
        dos = '',  -- e70f
        mac = '',  -- e711
      },
    }
  ''
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.alwaysDivideMiddle

Always divide middle section

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.componentSeparator.left

Component separator for left side

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.componentSeparator.right

Component separator for right side

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.disabledFiletypes

Filetypes to disable lualine on

Type: list of string

Default:

[
  "alpha"
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.a

Extra entries for activeSection.a

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.b

Extra entries for activeSection.b

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.c

Extra entries for activeSection.c

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.x

Extra entries for activeSection.x

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.y

Extra entries for activeSection.y

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraActiveSection.z

Extra entries for activeSection.z

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.a

Extra entries for inactiveSection.a

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.b

Extra entries for inactiveSection.b

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.c

Extra entries for inactiveSection.c

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.x

Extra entries for inactiveSection.x

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.y

Extra entries for inactiveSection.y

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.extraInactiveSection.z

Extra entries for inactiveSection.z

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.globalStatus

Enable global status for lualine

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.icons.enable

Whether to enable icons for lualine.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.ignoreFocus

If current filetype is in this list it’ll always be drawn as inactive statusline and the last window will be drawn as active statusline.

Type: list of string

Default:

[
  "NvimTree"
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.a

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

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.b

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

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.c

inactive config for: | A | B | © X | Y | Z |

Type: list of string

Default:

[
  "'filename'"
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.x

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

Type: list of string

Default:

[
  "'location'"
]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.y

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

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.inactiveSection.z

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

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.refresh.statusline

Refresh rate for lualine

Type: signed integer

Default: 1000

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.refresh.tabline

Refresh rate for tabline

Type: signed integer

Default: 1000

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.refresh.winbar

Refresh rate for winbar

Type: signed integer

Default: 1000

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.sectionSeparator.left

Section separator for left side

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.sectionSeparator.right

Section separator for right side

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.statusline.lualine.setupOpts

Option table to pass into the setup function of Lualine

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/statusline/lualine/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”, “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:

<nvf/modules/plugins/statusline/lualine/lualine.nix>
vim.syntaxHighlighting

Enable syntax highlighting

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.tabWidth

Set the width of tabs

Type: signed integer

Default: 4

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.tabline.nvimBufferline.enable

Whether to enable neovim bufferline.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.closeCurrent

Close buffer

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.cycleNext

Next buffer

Type: null or string

Default: "<leader>bn"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.cyclePrevious

Previous buffer

Type: null or string

Default: "<leader>bp"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.moveNext

Move next buffer

Type: null or string

Default: "<leader>bmn"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.movePrevious

Move previous buffer

Type: null or string

Default: "<leader>bmp"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.pick

Pick buffer

Type: null or string

Default: "<leader>bc"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.sortByDirectory

Sort buffers by directory

Type: null or string

Default: "<leader>bsd"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.sortByExtension

Sort buffers by extension

Type: null or string

Default: "<leader>bse"

Declared by:

<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
vim.tabline.nvimBufferline.mappings.sortById

Sort buffers by ID

Type: null or string

Default: "<leader>bsi"

Declared by:

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

Whether to enable telescope.nvim: multi-purpose search and picker utility.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.buffers

Buffers [Telescope]

Type: null or string

Default: "<leader>fb"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.diagnostics

Diagnostics [Telescope]

Type: null or string

Default: "<leader>fld"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.findFiles

Find files [Telescope]

Type: null or string

Default: "<leader>ff"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.findProjects

Find files [Telescope]

Type: null or string

Default: "<leader>fp"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.gitBranches

Git branches [Telescope]

Type: null or string

Default: "<leader>fvb"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.gitBufferCommits

Git buffer commits [Telescope]

Type: null or string

Default: "<leader>fvcb"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.gitCommits

Git commits [Telescope]

Type: null or string

Default: "<leader>fvcw"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.gitStash

Git stash [Telescope]

Type: null or string

Default: "<leader>fvx"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.gitStatus

Git status [Telescope]

Type: null or string

Default: "<leader>fvs"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.helpTags

Help tags [Telescope]

Type: null or string

Default: "<leader>fh"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.liveGrep

Live grep [Telescope]

Type: null or string

Default: "<leader>fg"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspDefinitions

LSP Definitions [Telescope]

Type: null or string

Default: "<leader>flD"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspDocumentSymbols

LSP Document Symbols [Telescope]

Type: null or string

Default: "<leader>flsb"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspImplementations

LSP Implementations [Telescope]

Type: null or string

Default: "<leader>fli"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspReferences

LSP References [Telescope]

Type: null or string

Default: "<leader>flr"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspTypeDefinitions

LSP Type Definitions [Telescope]

Type: null or string

Default: "<leader>flt"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.lspWorkspaceSymbols

LSP Workspace Symbols [Telescope]

Type: null or string

Default: "<leader>flsw"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.open

Open [Telescope]

Type: null or string

Default: "<leader>ft"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.mappings.treesitter

Treesitter [Telescope]

Type: null or string

Default: "<leader>fs"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts

Option table to pass into the setup function of Telescope

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.color_devicons

Boolean if devicons should be enabled or not.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.entry_prefix

Prefix in front of each result entry. Current selection not included.

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.file_ignore_patterns

A table of lua regex that define the files that should be ignored.

Type: list of string

Default:

[
  "node_modules"
  ".git/"
  "dist/"
  "build/"
  "target/"
  "result/"
]

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.initial_mode

Determines in which mode telescope starts.

Type: one of “insert”, “normal”

Default: "insert"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config

Determines the default configuration values for layout strategies. See telescope.layout for details of the configurations options for each strategy.

Type: submodule

Default: { }

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.height

Type: floating point number

Default: 0.8

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.horizontal.preview_width

Type: floating point number

Default: 0.55

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.horizontal.prompt_position

Type: string

Default: "top"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.horizontal.results_width

Type: floating point number

Default: 0.8

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.preview_cutoff

Type: signed integer

Default: 120

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.vertical.mirror

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_config.width

Type: floating point number

Default: 0.8

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.layout_strategy

Determines the default layout of Telescope pickers. See :help telescope.layout.

Type: string

Default: "horizontal"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.path_display

Determines how file paths are displayed.

Type: list of (one of “hidden”, “tail”, “absolute”, “smart”, “shorten”, “truncate”)

Default:

[
  "absolute"
]

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.pickers.find_command

cmd to use for finding files

Type: (list of string) or (luaInline)

Default:

[
  "\${pkgs.fd}/bin/fd"
]

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.prompt_prefix

Shown in front of Telescope’s prompt

Type: string

Default: "  "

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.selection_caret

Character(s) to show in front of the current selection

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.selection_strategy

Determines how the cursor acts after each sort iteration.

Type: one of “reset”, “follow”, “row”, “closest”, “none”

Default: "reset"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.set_env

Set an envrionment for term_previewer

Type: attribute set of string

Default:

{
  COLORTERM = "truecolor";
}

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.sorting_strategy

Determines the direction “better” results are sorted towards.

Type: one of “descending”, “ascending”

Default: "ascending"

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.vimgrep_arguments

Defines the command that will be used for live_grep and grep_string pickers. Make sure that color is set to never because telescope does not yet interpret color codes.

Type: list of string

Default:

[
  "\${pkgs.ripgrep}/bin/rg"
  "--color=never"
  "--no-heading"
  "--with-filename"
  "--line-number"
  "--column"
  "--smart-case"
  "--hidden"
  "--no-ignore"
]

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.telescope.setupOpts.defaults.winblend

pseudo-transparency of keymap hints floating window

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/utility/telescope/telescope.nix>
vim.terminal.toggleterm.enable

Whether to enable toggleterm as a replacement to built-in terminal command.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.lazygit.enable

Whether to enable LazyGit integration.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.lazygit.package

The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH

Type: null or package

Default: <derivation lazygit-0.41.0>

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.lazygit.direction

Direction of the lazygit window

Type: one of “horizontal”, “vertical”, “tab”, “float”

Default: "float"

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.lazygit.mappings.open

Open lazygit [toggleterm]

Type: null or string

Default: "<leader>gg"

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.mappings.open

The keymapping to open toggleterm

Type: null or string

Default: "<c-t>"

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts

Option table to pass into the setup function of ToggleTerm

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts.enable_winbar

Enable winbar

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts.direction

Direction of the terminal

Type: one of “horizontal”, “vertical”, “tab”, “float”

Default: "horizontal"

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts.size

Number or lua function which is passed to the current terminal

Type: (luaInline) or signed integer

Default:

{
  _type = "lua-inline";
  expr = ''
    function(term)
      if term.direction == "horizontal" then
        return 15
      elseif term.direction == "vertical" then
        return vim.o.columns * 0.4
      end
    end
  '';
}

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts.winbar.enabled

Whether to enable winbar in terminal.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.terminal.toggleterm.setupOpts.winbar.name_formatter

Winbar formatter function.

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(term)
      return term.name
    end
  '';
}

Declared by:

<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix>
vim.theme.enable

Enable theming

Type: boolean

Declared by:

<nvf/modules/plugins/theme/theme.nix>
vim.theme.extraConfig

Additional lua configuration to add before setup

Type: strings concatenated with “\n”

Declared by:

<nvf/modules/plugins/theme/theme.nix>
vim.theme.name

Supported themes can be found in supported_themes.nix

Type: one of “catppuccin”, “dracula”, “gruvbox”, “onedark”, “oxocarbon”, “rose-pine”, “tokyonight”

Declared by:

<nvf/modules/plugins/theme/theme.nix>
vim.theme.style

Specific style for theme if it supports it

Type: one of “dark”, “darker”, “cool”, “deep”, “warm”, “warmer”

Declared by:

<nvf/modules/plugins/theme/theme.nix>
vim.theme.transparent

Whether or not transparency should be enabled. Has no effect for themes that do not support transparency

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/theme/theme.nix>
vim.treesitter.enable

Whether to enable treesitter, also enabled automatically through language options.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.addDefaultGrammars

Whether to add the default grammars to the list of grammars to install.

This option is only relevant if treesitter has been enabled.

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.autotagHtml

Whether to enable autoclose and rename html tag.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.context.enable

Whether to enable context of current buffer contents [nvim-treesitter-context] .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts

Option table to pass into the setup function of treesitter-context

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.line_numbers

Whether to display line numbers in current context

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.max_lines

How many lines the window should span.

Values >= 0 mean there will be no limit.

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.min_window_height

Minimum editor window height to enable context.

Values >= 0 mean there will be no limit.

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.mode

Line used to calculate context.

Type: one of “cursor”, “topline”

Default: "cursor"

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.multiline_threshold

Maximum number of lines to collapse for a single context line.

Type: signed integer

Default: 20

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.separator

Separator between context and content. This option should be a single character string, like ‘-’.

When separator is set, the context will only show up when there are at least 2 lines above cursorline.

Type: null or string

Default: "-"

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.trim_scope

Which context lines to discard if vim.treesitter.context.setupOpts.max_lines is exceeded.

Type: one of “inner”, “outer”

Default: "outer"

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.context.setupOpts.zindex

The Z-index of the context window.

Type: signed integer

Default: 20

Declared by:

<nvf/modules/plugins/treesitter/ts-context/context.nix>
vim.treesitter.fold

Whether to enable fold with treesitter.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.grammars

List of treesitter grammars to install.

For languages already supported by nvf, you may use the vim.language.<lang>.treesitter options, which will automatically add the required grammars to this.

Type: list of package

Default: [ ]

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.highlight.enable

Whether to enable highlighting with treesitter.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.highlight.additionalVimRegexHighlighting

Takes either a boolean or a list of languages.

Setting this to true will run :h syntax and tree-sitter at the same time. You may this to true if you depend on ‘syntax’ being enabled (like for indentation).

Note

Using this option may slow down your editor, and you may see some duplicate highlights.

Type: boolean or list of string

Default: false

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.highlight.disable

List of treesitter grammars to disable highlighting for.

This option can be either a list, in which case it will be converted to a Lua table containing grammars to disable highlighting for, or a string containing a lua function that will be read as is.

Warning

A comma will be added at the end of your function, so you do not need to add it yourself. Doing so will cause in syntax errors within your Neovim configuration.

Type: (list of string) or (luaInline)

Default: [ ]

Example:

-- Disable slow treesitter highlight for large files
function(lang, buf)
  local max_filesize = 1000 * 1024 -- 1MB
  local ok, stats = pcall(vim.loop.fs_stat, vim.api.nvim_buf_get_name(buf))
  if ok and stats and stats.size > max_filesize then
      return true
  end
end

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.incrementalSelection.enable

Whether to enable incremental selection with treesitter.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.incrementalSelection.disable

List of treesitter grammars to disable incremental selection for.

This option can be either a list, in which case it will be converted to a Lua table containing grammars to disable indentation for, or a string containing a lua function that will be read as is.

Warning

A comma will be added at the end of your function, so you do not need to add it yourself. Doing so will cause in syntax errors within your Neovim configuration.

Type: (list of string) or (luaInline)

Default: [ ]

Example: ["c" "rust" ]

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.indent.enable

Whether to enable indentation with treesitter.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.indent.disable

List of treesitter grammars to disable indentation for.

This option can be either a list, in which case it will be converted to a Lua table containing grammars to disable indentation for, or a string containing a lua function that will be read as is.

Warning

A comma will be added at the end of your function, so you do not need to add it yourself. Doing so will cause in syntax errors within your Neovim configuration.

Type: (list of string) or (luaInline)

Default: [ ]

Example: ["c" "rust"]

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.mappings.incrementalSelection.decrementByNode

Decrement selection by node [treesitter]

Type: null or string

Default: "grm"

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.mappings.incrementalSelection.incrementByNode

Increment selection by node [treesitter]

Type: null or string

Default: "grn"

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.mappings.incrementalSelection.incrementByScope

Increment selection by scope [treesitter]

Type: null or string

Default: "grc"

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.treesitter.mappings.incrementalSelection.init

Init selection [treesitter]

Type: null or string

Default: "gnn"

Declared by:

<nvf/modules/plugins/treesitter/treesitter.nix>
vim.ui.borders.enable

Whether to enable visible borders for most windows.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.globalStyle

The global border style to use.

Type: one of “none”, “single”, “double”, “rounded”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.code-action-menu.enable

Whether to enable borders for the code-actions-menu plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.code-action-menu.style

The border style to use for the code-actions-menu plugin

Type: one of “none”, “single”, “double”, “rounded”, “shadow”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.lsp-signature.enable

Whether to enable borders for the lsp-signature plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.lsp-signature.style

The border style to use for the lsp-signature plugin

Type: one of “none”, “single”, “double”, “rounded”, “shadow”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.lspsaga.enable

Whether to enable borders for the lspsaga plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.lspsaga.style

The border style to use for the lspsaga plugin

Type: one of “none”, “single”, “double”, “rounded”, “shadow”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.nvim-cmp.enable

Whether to enable borders for the nvim-cmp plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.nvim-cmp.style

The border style to use for the nvim-cmp plugin

Type: one of “none”, “single”, “double”, “rounded”, “shadow”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.which-key.enable

Whether to enable borders for the which-key plugin.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.borders.plugins.which-key.style

The border style to use for the which-key plugin

Type: one of “none”, “single”, “double”, “rounded”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/borders/borders.nix>
vim.ui.breadcrumbs.enable

Whether to enable breadcrumbs.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.alwaysRender

Whether to always display the breadcrumbs component on winbar (always renders winbar)

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.enable

Whether to enable navbuddy LSP helper UI. Enabling this option automatically loads and enables nvim-navic.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.appendName

insert at end of name

Type: string

Default: "a"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.appendScope

insert at end of scope

Type: string

Default: "A"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.children

keybinding to navigate to the child node

Type: string

Default: "l"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.close

keybinding to close Navbuddy UI

Type: string

Default: "<esc>"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.comment

comment the node

Type: string

Default: "c"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.delete

delete the node

Type: string

Default: "d"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.foldCreate

create a new fold

Type: string

Default: "f"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.foldDelete

delete the current fold

Type: string

Default: "F"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.help

open mapping help window

Type: string

Default: "g?"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.insertName

insert at start of name

Type: string

Default: "i"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.insertScope

insert at start of scope

Type: string

Default: "I"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.moveDown

move focused node down

Type: string

Default: "J"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.moveUp

move focused node up

Type: string

Default: "K"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.nextSibling

keybinding to navigate to the next sibling node

Type: string

Default: "j"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.parent

keybinding to navigate to the parent node

Type: string

Default: "h"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.previousSibling

keybinding to navigate to the previous sibling node

Type: string

Default: "k"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.rename

rename the node

Type: string

Default: "r"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.root

keybinding to navigate to the root node

Type: string

Default: "0"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.select

goto selected symbol

Type: string

Default: "<enter>"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.telescope

fuzzy finder at current level

Type: string

Default: "t"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.visualName

visual selection of name

Type: string

Default: "v"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.visualScope

visual selection of scope

Type: string

Default: "V"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.yankName

yank the name to system clipboard

Type: string

Default: "y"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.mappings.yankScope

yank the scope to system clipboard

Type: string

Default: "Y"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts

Option table to pass into the setup function of navbuddy

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Array

Type: string

Default: "󰅪 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Boolean

Type: string

Default: "◩ "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Class

Type: string

Default: "󰌗 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constant

Type: string

Default: "󰏿 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constructor

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Enum

Type: string

Default: "󰕘"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.EnumMember

Type: string

Default: "󰕘 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Event

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Field

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.File

Type: string

Default: "󰈙 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Function

Type: string

Default: "󰊕 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Interface

Type: string

Default: "󰕘"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Key

Type: string

Default: "󰌋 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Method

Type: string

Default: "󰆧 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Module

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Namespace

Type: string

Default: "󰌗 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Null

Type: string

Default: "󰟢 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Number

Type: string

Default: "󰎠 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Object

Type: string

Default: "󰅩 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Operator

Type: string

Default: "󰆕 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Package

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Property

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.String

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Struct

Type: string

Default: "󰌗 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.TypeParameter

Type: string

Default: "󰊄 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Variable

Type: string

Default: "󰆧 "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.auto_attach

Whether to attach to LSP server manually

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.preference

list of lsp server names in order of preference

Type: null or (list of string)

Default: null

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.enable

Whether to enable node markers.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.branch

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf_selected

Type: string

Default: " → "

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.followNode

keep the current node in focus on the source buffer

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.highlight

highlight the currently focused node

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.reorient

reorient buffer after changing nodes

Type: one of “smart”, “top”, “mid”, “none”

Default: "smart"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.scrolloff

scrolloff value when navbuddy is open

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.useDefaultMappings

use default Navbuddy keybindings (disables user-specified keybinds)

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.border

border style to use

Type: one of “single”, “rounded”, “double”, “solid”, “none”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.scrolloff

Scrolloff value within navbuddy window

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.left.border

border style to use for the left section of Navbuddy UI

Type: null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.mid.border

border style to use for the middle section of Navbuddy UI

Type: null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.border

border style to use for the right section of Navbuddy UI

Type: null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: "rounded"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.preview

display mode of the preview on the right section

Type: one of “leaf”, “always”, “never”

Default: "leaf"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.breadcrumbs.source

The source to be used for breadcrumbs component. Null means no breadcrumbs.

Type: null or value “nvim-navic” (singular enum)

Default: "nvim-navic"

Declared by:

<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix>
vim.ui.colorizer.enable

Whether to enable color highlighting [nvim-colorizer.lua].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts

Option table to pass into the setup function of nvim-colorizer

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.filetypes

Filetypes to highlight on

Type: attribute set of (attribute set)

Default:

{
  css = { };
  scss = { };
}

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.alwaysUpdate

Update color values even if buffer is not focused, like when using cmp_menu, cmp_docs

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.css

Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.css_fn

Enable all CSS functions: rgb_fn, hsl_fn

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.hsl_fn

CSS hsl() and hsla() functions

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.mode

Set the display mode

Type: one of “foreground”, “background”

Default: "background"

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.names

“Name” codes such as “Blue”

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.rgb

#RGB hex codes

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.rgb_fn

CSS rgb() and rgba() functions

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.rrggbb

#RRGGBB hex codes

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.rrggbbaa

#RRGGBBAA hex codes

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.sass

Enable sass colors

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.colorizer.setupOpts.user_default_options.tailwind

Enable tailwind colors

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/colorizer/colorizer.nix>
vim.ui.illuminate.enable

Whether to enable automatically highlight other uses of the word under the cursor [vim-illuminate].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/illuminate/illuminate.nix>
vim.ui.modes-nvim.enable

Whether to enable modes.nvim’s prismatic line decorations.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.colors

Option table to pass into the setup function of modes.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.colors.copy

The #RRGGBB color code for the visual mode highlights

Type: string

Default: "#f5c359"

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.colors.delete

The #RRGGBB color code for the visual mode highlights

Type: string

Default: "#c75c6a"

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.colors.insert

The #RRGGBB color code for the visual mode highlights

Type: string

Default: "#78ccc5"

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.colors.visual

The #RRGGBB color code for the visual mode highlights

Type: string

Default: "#9745be"

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.line_opacity.visual

Set opacity for cursorline and number background

Type: floating point number

Default: 0.0

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.modes-nvim.setupOpts.setCursorline

Set a colored cursorline on current line

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/ui/modes/modes.nix>
vim.ui.noice.enable

Whether to enable noice.nvim UI modification library.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/noice/noice.nix>
vim.ui.smartcolumn.enable

Whether to enable line length indicator.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix>
vim.ui.smartcolumn.setupOpts

Option table to pass into the setup function of smartcolumn.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix>
vim.ui.smartcolumn.setupOpts.colorcolumn

The position at which the column will be displayed. Set to null to disable

Type: null or string or list of string

Default: "120"

Declared by:

<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix>
vim.ui.smartcolumn.setupOpts.custom_colorcolumn

The position at which smart column should be displayed for each individual buffer type

Type: attribute set of (signed integer or list of signed integer)

Default: { }

Example:

vim.ui.smartcolumn.setupOpts.custom_colorcolumn = {
  nix = 110;
  ruby = 120;
  java = 130;
  go = [90 130];
};

Declared by:

<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix>
vim.ui.smartcolumn.setupOpts.disabled_filetypes

The filetypes smartcolumn will be disabled for.

Type: list of string

Default:

[
  "help"
  "text"
  "markdown"
  "NvimTree"
  "alpha"
]

Declared by:

<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix>
vim.updateTime

The number of milliseconds till Cursor Hold event is fired

Type: signed integer

Default: 300

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.useSystemClipboard

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

Type: boolean

Default: false

Declared by:

<nvf/modules/neovim/init/basic.nix>
vim.utility.ccc.enable

Whether to enable ccc color picker for neovim.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/ccc/ccc.nix>
vim.utility.ccc.mappings.decrease10

Decrease the value times delta of the slider

Type: null or string

Default: "<H>"

Declared by:

<nvf/modules/plugins/utility/ccc/ccc.nix>
vim.utility.ccc.mappings.increase10

Increase the value times delta of the slider

Type: null or string

Default: "<L>"

Declared by:

<nvf/modules/plugins/utility/ccc/ccc.nix>
vim.utility.ccc.mappings.quit

Cancel and close the UI without replace or insert

Type: null or string

Default: "<Esc>"

Declared by:

<nvf/modules/plugins/utility/ccc/ccc.nix>
vim.utility.diffview-nvim.enable

Whether to enable diffview-nvim: cycle through diffs for all modified files for any git rev.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/diffview/diffview.nix>
vim.utility.icon-picker.enable

Whether to enable nerdfonts icon picker for nvim.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/icon-picker/icon-picker.nix>
vim.utility.images.image-nvim.enable

Whether to enable image support in Neovim [image.nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts

Option table to pass into the setup function of image.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.backend

The backend to use for rendering images.

  • kitty - best in class, works great and is very snappy

  • ueberzug - backed by ueberzugpp, supports any terminal, but has lower performance

Type: one of “kitty”, “ueberzug”

Default: "ueberzug"

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.editorOnlyRenderWhenFocused

Whether to enable only rendering images when the editor is focused.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.hijackFilePatterns

File patterns to hijack for image.nvim. This is useful for filetypes that don’t have a dedicated integration.

Type: list of string

Default:

[
  "*.png"
  "*.jpg"
  "*.jpeg"
  "*.gif"
  "*.webp"
]

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.markdown.enable

Whether to enable image.nvim in markdown files.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.markdown.clearInInsertMode

Whether to enable clearing of images when entering insert mode.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.markdown.downloadRemoteImages

Whether to enable downloading remote images.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.markdown.filetypes

Filetypes to enable image.nvim in. Markdown extensions (i.e. quarto) can go here

Type: list of string

Default:

[
  "markdown"
  "vimwiki"
]

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.markdown.onlyRenderAtCursor

Whether to enable only rendering images at cursor.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.maxWidth

The maximum width of images to render. Images larger than this will be scaled down to fit within this width.

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.neorg.enable

Whether to enable image.nvim in Neorg files.

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.neorg.clearInInsertMode

Whether to enable clearing of images when entering insert mode.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.neorg.downloadRemoteImages

Whether to enable downloading remote images.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.neorg.filetypes

Filetypes to enable image.nvim in.

Type: list of string

Default:

[
  "neorg"
]

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.integrations.neorg.onlyRenderAtCursor

Whether to enable only rendering images at cursor.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.maxHeight

The maximum height of images to render. Images larger than this will be scaled down to fit within this height.

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.maxHeightWindowPercentage

The maximum height of images to render as a percentage of the window height. Images larger than this will be scaled down to fit within this height.

Type: null or signed integer

Default: 50

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.maxWidthWindowPercentage

The maximum width of images to render as a percentage of the window width. Images larger than this will be scaled down to fit within this width.

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.windowOverlapClear.enable

Whether to enable clearing of images when they overlap with the window.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.images.image-nvim.setupOpts.windowOverlapClear.ftIgnore

Filetypes to ignore window overlap clearing in.

Type: list of string

Default:

[
  "cmp_menu"
  "cmp_docs"
  ""
]

Declared by:

<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix>
vim.utility.motion.hop.enable

Whether to enable Hop.nvim plugin (easy motion).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/motion/hop/hop.nix>
vim.utility.motion.hop.mappings.hop

Jump to occurences [hop.nvim]

Type: null or string

Default: "<leader>h"

Declared by:

<nvf/modules/plugins/utility/motion/hop/hop.nix>
vim.utility.motion.leap.enable

Whether to enable leap.nvim plugin (easy motion).

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.motion.leap.mappings.leapBackwardTill

Leap backward till

Type: null or string

Default: "X"

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.motion.leap.mappings.leapBackwardTo

Leap backward to

Type: null or string

Default: "S"

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.motion.leap.mappings.leapForwardTill

Leap forward till

Type: null or string

Default: "x"

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.motion.leap.mappings.leapForwardTo

Leap forward to

Type: null or string

Default: "s"

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.motion.leap.mappings.leapFromWindow

Leap from window

Type: null or string

Default: "gs"

Declared by:

<nvf/modules/plugins/utility/motion/leap/leap.nix>
vim.utility.preview.glow.enable

Whether to enable markdown preview in neovim with glow.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/preview/glow/glow.nix>
vim.utility.preview.glow.mappings.openPreview

Open preview

Type: null or string

Default: "<leader>p"

Declared by:

<nvf/modules/plugins/utility/preview/glow/glow.nix>
vim.utility.preview.markdownPreview.enable

Whether to enable Markdown preview in neovim with markdown-preview.nvim.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.alwaysAllowPreview

Allow preview on all filetypes

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.autoClose

Automatically close the preview window after leaving a Markdown buffer

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.autoStart

Automatically open the preview window after entering a Markdown buffer

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.broadcastServer

Allow for outside and network wide connections

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.customIP

IP-address to use

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.customPort

Port to use

Type: string

Default: ""

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.filetypes

Allowed filetypes

Type: list of string

Default:

[
  "markdown"
]

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.preview.markdownPreview.lazyRefresh

Only update preview when saving or leaving insert mode

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix>
vim.utility.surround.enable

nvim-surround: add/change/delete surrounding delimiter pairs with ease. Note that the default mappings deviate from upstreeam to avoid conflicts with nvim-leap.

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.change

Change surrounding character

Type: null or string

Default: "gzr"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.delete

Delete surrounding character

Type: null or string

Default: "gzd"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.insert

Add surround character around the cursor

Type: null or string

Default: "<C-g>z"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.insertLine

Add surround character around the cursor on new lines

Type: null or string

Default: "<C-g>Z"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.normal

Surround motion with character

Type: null or string

Default: "gz"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.normalCur

Surround motion with character on new lines

Type: null or string

Default: "gZ"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.normalCurLine

Surround line with character on new lines

Type: null or string

Default: "gZZ"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.normalLine

Surround line with character

Type: null or string

Default: "gzz"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.visual

Surround selection with character

Type: null or string

Default: "gz"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.mappings.visualLine

Surround selection with character on new lines

Type: null or string

Default: "gZ"

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.surround.useVendoredKeybindings

Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/utility/surround/surround.nix>
vim.utility.vim-wakatime.enable

Whether to enable vim-wakatime: live code statistics.

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/utility/wakatime/vim-wakatime.nix>
vim.utility.vim-wakatime.cli-package

The package that should be used for wakatime-cli. Set as null to use the default path in $XDG_DATA_HOME

Type: null or package

Default: <derivation wakatime-1.73.0>

Declared by:

<nvf/modules/plugins/utility/wakatime/vim-wakatime.nix>
vim.viAlias

Enable the vi alias for nvim

Type: boolean

Default: true

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.vimAlias

Enable the vim alias for nvim

Type: boolean

Default: true

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.visuals.enable

Whether to enable Visual enhancements…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.cellularAutomaton.enable

Whether to enable cellular automaton [cellular-automaton].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.cellularAutomaton.mappings.makeItRain

Make it rain [cellular-automaton]

Type: null or string

Default: "<leader>fml"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.cursorline.enable

Whether to enable line hightlighting on the cursor [nvim-cursorline].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.cursorline.lineNumbersOnly

Hightlight only in the presence of line numbers

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.cursorline.lineTimeout

Time in milliseconds for cursorline to appear

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.fidget-nvim.enable

Whether to enable nvim LSP UI element [fidget-nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts

Option table to pass into the setup function of Fidget

You can pass in any additional options even if they’re not listed in the docs

Type: attribute set of anything

Default: { }

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.integration.nvim-tree.enable

Integrate with nvim-tree/nvim-tree.lua (if enabled)

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.integration.xcodebuild-nvim.enable

Integrate with wojciech-kulik/xcodebuild.nvim (if enabled)

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.logger.float_precision

Limit the number of decimals displayed for floats

Type: floating point number

Default: 0.01

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.logger.level

Minimum logging level

Type: one of “debug”, “error”, “info”, “trace”, “warn”, “off”

Default: "warn"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.logger.max_size

Maximum log file size, in KB

Type: signed integer

Default: 10000

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.logger.path

Where Fidget writes its logs to

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    string.format("%s/fidget.nvim.log", vim.fn.stdpath("cache"))
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.configs

How to configure notification groups when instantiated

Type: attribute set of (luaInline)

Default:

{
  default = {
    _type = "lua-inline";
    expr = "require('fidget.notification').default_config";
  };
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.filter

Minimum notifications level

Type: one of “debug”, “info”, “warn”, “error”

Default: "info"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.history_size

Number of removed messages to retain in history

Type: signed integer

Default: 128

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.override_vim_notify

Automatically override vim.notify() with Fidget

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.poll_rate

How frequently to update and render notifications

Type: signed integer

Default: 10

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.redirect

Conditionally redirect notifications to another backend

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(msg, level, opts)
      if opts and opts.on_open then
        return require("fidget.integration.nvim-notify").delegate(msg, level, opts)
      end
    end
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator

Separator between notification groups

Type: string

Default: "---"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator_hl

Highlight group used for group separator

Type: string

Default: "Comment"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.view.icon_separator

Separator between group name and icon

Type: string

Default: " "

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.view.render_message

How to render notification messages

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(msg, cnt)
      return cnt == 1 and msg or string.format("(%dx) %s", cnt, msg)
    end
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.view.stack_upwards

Display notification items from bottom to top

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.align

How to align the notification window

Type: one of “top”, “bottom”

Default: "bottom"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.border

Border style of the notification window

Type: one of “none”, “single”, “double”, “rounded”, “solid”, “shadow”

Default: "none"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.max_height

Maximum height of the notification window

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.max_width

Maximum width of the notification window

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.normal_hl

Base highlight group in the notification window

Type: string

Default: "Comment"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.relative

What the notification window position is relative to

Type: one of “editor”, “win”

Default: "editor"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.winblend

Background color opacity in the notification window

Type: signed integer

Default: 100

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.x_padding

Padding from right edge of window boundary

Type: signed integer

Default: 1

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.y_padding

Padding from bottom edge of window boundary

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.notification.window.zindex

Stacking priority of the notification window

Type: signed integer

Default: 45

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.done_icon

Icon shown when LSP progress tasks are completed

Type: string

Default: "✓"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.done_style

Highlight group for completed LSP tasks

Type: string

Default: "Constant"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.done_ttl

How long a message should persist when complete

Type: signed integer

Default: 3

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.format_annote

How to format a progress annotation

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(msg) return msg.title end
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.format_group_name

How to format a progress notification group’s name

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(group) return tostring(group) end
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.format_message

How to format a progress message

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    require("fidget.progress.display").default_format_message
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.group_style

Highlight group for group name (LSP server name)

Type: string

Default: "Title"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.icon_style

Highlight group for group icons

Type: string

Default: "Question"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides

Overrides the default configuration for a notification group defined in vim.visuals.fidget-nvim.setupOpts.notification.configs.

If any of the fields are null, the value from the default configuration is used.

If default configuration is not defined, the following defaults are used:

   {
       name = "Notifications",
       icon = "❰❰",
       ttl = 5,
       group_style = "Title",
       icon_style = "Special",
       annote_style = "Question",
       debug_style = "Comment",
       info_style = "Question",
       warn_style = "WarningMsg",
       error_style = "ErrorMsg",
       debug_annote = "DEBUG",
       info_annote = "INFO",
       warn_annote = "WARN",
       error_annote = "ERROR",
       update_hook = function(item)
         notification.set_content_key(item)
       end,
   }

Type: attribute set of (submodule)

Default: { }

Example:

{
  rust_analyzer = {
    name = "Rust Analyzer";
  };
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.annote_separator

Separator between message from annote

Type: null or string

Default: " "

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.annote_style

Default style used to highlight item annotes

Type: null or string

Default: "Question"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.debug_annote

Default annotation for debug items

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.debug_style

Style used to highlight debug item annotes

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.error_annote

Default annotation for error items

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.error_style

Style used to highlight error item annotes

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.group_style

Style used to highlight group name

Type: null or string

Default: "Title"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon

Icon of the group, displayed in the notification window. Can be a string or a function that returns a string.

If a function, it is invoked every render cycle with the items list, useful for rendering animations and other dynamic content.

Note

If you’re looking for detailed information into the function signature, you can refer to the fidget API documentation available here

Type: null or string or (luaInline)

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon_on_left

If true, icon is rendered on the left instead of right

Type: null or boolean

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon_style

Style used to highlight icon, if null, use group_style

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.info_annote

Default annotation for info items

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.info_style

Style used to highlight info item annotes

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.name

Name of the group, displayed in the notification window. Can be a string or a function that returns a string.

If a function, it is invoked every render cycle with the items list, useful for rendering animations and other dynamic content.

Note

If you’re looking for detailed information into the function signature, you can refer to the fidget API documentation available here

Type: null or string or (luaInline)

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.priority

Order in which group should be displayed

Type: null or signed integer

Default: 50

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.render_limit

How many notification items to show at once

Type: null or signed integer

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.skip_history

Whether messages should be preserved in history

Type: null or boolean

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.ttl

How long a notification item should exist

Type: null or signed integer

Default: 5

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.update_hook

Called when an item is updated.

If false, no action is taken. If a function, it is invoked with the item being updated.

Note

If you’re looking for detailed information into the function signature, you can refer to the fidget API documentation available here

Type: null or boolean or (luaInline)

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.warn_annote

Default annotation for warn items

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.warn_style

Style used to highlight warn item annotes

Type: null or string

Default: null

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.priority

Priority of the progress notification

Type: signed integer

Default: 30

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.pattern

Pattern shown when LSP progress tasks are in progress

Type: one of “dots”, “dots_negative”, “dots_snake”, “dots_footsteps”, “dots_hop”, “line”, “pipe”, “dots_ellipsis”, “dots_scrolling”, “star”, “flip”, “hamburger”, “grow_vertical”, “grow_horizontal”, “noise”, “dots_bounce”, “triangle”, “arc”, “circle”, “square_corners”, “circle_quarters”, “circle_halves”, “dots_toggle”, “box_toggle”, “arrow”, “zip”, “bouncing_bar”, “bouncing_ball”, “clock”, “earth”, “moon”, “dots_pulse”, “meter”

Default: "dots"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.period

Period of the pattern

Type: signed integer

Default: 1

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.progress_style

Highlight group for in-progress LSP tasks

Type: string

Default: "WarningMsg"

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.progress_ttl

How long a message should persist when in progress

Type: signed integer

Default: 99999

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.render_limit

Maximum number of messages to render

Type: signed integer

Default: 16

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.display.skip_history

Skip adding messages to history

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.ignore

Ignore LSP servers by name

Type: list of string

Default: [ ]

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.ignore_done_already

Ignore new tasks that are already done

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.ignore_empty_message

Ignore new tasks with empty messages

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.lsp.log_handler

Log $/progress handler invocations

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.lsp.progress_ringbuf_size

Nvim’s LSP client ring buffer size

Type: signed integer

Default: 100

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.notification_group

How to get a progress message’s notification group key

Type: luaInline

Default:

{
  _type = "lua-inline";
  expr = ''
    function(msg)
      return msg.lsp_client.name
    end
  '';
}

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.poll_rate

How frequently to poll for LSP progress messages

Type: signed integer

Default: 0

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.fidget-nvim.setupOpts.progress.suppress_on_insert

Suppress new messages when in insert mode

Type: boolean

Default: false

Declared by:

<nvf/modules/plugins/visuals/fidget/fidget.nix>
vim.visuals.highlight-undo.enable

Whether to enable highlight undo [highlight-undo].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.highlight-undo.duration

Duration of highlight

Type: signed integer

Default: 500

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.highlight-undo.highlightForCount

Enable support for highlighting when a <count> is provided before the key If set to false it will only highlight when the mapping is not prefixed with a <count>

Type: boolean

Default: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.highlight-undo.redo.hlGroup

Highlight group for redo

Type: string

Default: "HighlightUndo"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.highlight-undo.undo.hlGroup

Highlight group for undo

Type: string

Default: "HighlightUndo"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.enable

Whether to enable indentation guides [indent-blankline].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.debounce

Debounce time in milliseconds

Type: signed integer

Default: 200

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.eolChar

Character at end of line

Type: null or string

Default: "↴"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.fillChar

Character to fill indents

Type: null or string

Default: "⋅"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.indent.char

Character for indentation line

Type: string

Default: "│"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.listChar

Character for indentation line

Type: string

Default: "│"

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.scope.enabled

Highlight current scope from treesitter

Type: boolean

Default: config.vim.treesitter.enable

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.scope.showEndOfLine

Displays the end of line character set by vim.visuals.indentBlankline.eolChar instead of the indent guide on line returns.

Type: boolean

Default: config.vim.visuals.indentBlankline.eolChar != null

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.viewportBuffer.max

Number of lines above and below of what is currently visible in the window

Type: signed integer

Default: 500

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.indentBlankline.viewportBuffer.min

Number of lines above and below of what is currently visible in the window

Type: signed integer

Default: 30

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.nvimWebDevicons.enable

Whether to enable dev icons. Required for certain plugins [nvim-web-devicons]…

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.scrollBar.enable

Whether to enable scrollbar [scrollbar.nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.visuals.smoothScroll.enable

Whether to enable smooth scrolling [cinnamon-nvim].

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/plugins/visuals/visuals.nix>
vim.withNodeJs

Whether to enable NodeJs support in the Neovim wrapper. .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.withPython3

Whether to enable Python3 support in the Neovim wrapper. .

Type: boolean

Default: false

Example: true

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.withRuby

Whether to enable Ruby support in the Neovim wrapper. .

Type: boolean

Default: true

Example: true

Declared by:

<nvf/modules/wrapper/build/options.nix>
vim.wordWrap

Enable word wrapping.

Type: boolean

Default: true

Declared by:

<nvf/modules/neovim/init/basic.nix>