Home Manager Manual

programs.vim.enable

Whether to enable Vim.

Type: boolean

Default:

false

Example:

true

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.package

Resulting customized vim package

Type: package (read only)

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.packageConfigurable

The vim-full package to use. Vim package to customize

Type: package

Default:

pkgs.vim-full

Example:

pkgs.vim

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.defaultEditor

Whether to configure vim as the default editor using the EDITOR and VISUAL environment variables.

Type: boolean

Default:

false

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.extraConfig

Custom .vimrc lines

Type: strings concatenated with “\n”

Default:

""

Example:

''
  set nocompatible
  set nobackup
''

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.plugins

List of vim plugins to install. To get a list of supported plugins run: nix-env -f '<nixpkgs>' -qaP -A vimPlugins.

Note: String values are deprecated, please use actual packages.

Type: list of (string or package)

Default:

[
  <derivation vimplugin-vim-sensible-2.0-unstable-2024-06-08>
]

Example:

[ pkgs.vimPlugins.YankRing ]

Declared by:

• <home-manager/modules/programs/vim.nix>

programs.vim.settings

At attribute set of Vim settings. The attribute names and corresponding values must be among the following supported options.

• ‌background‌

  one of “dark”, “light”

• ‌backupdir‌

  list of string

• ‌copyindent‌

  boolean

• ‌directory‌

  list of string

• ‌expandtab‌

  boolean

• ‌hidden‌

  boolean

• ‌history‌

  signed integer

• ‌ignorecase‌

  boolean

• ‌modeline‌

  boolean

• ‌mouse‌

  one of “n”, “v”, “i”, “c”, “h”, “a”, “r”

• ‌mousefocus‌

  boolean

• ‌mousehide‌

  boolean

• ‌mousemodel‌

  one of “extend”, “popup”, “popup_setpos”

• ‌number‌

  boolean

• ‌relativenumber‌

  boolean

• ‌shiftwidth‌

  signed integer

• ‌smartcase‌

  boolean

• ‌tabstop‌

  signed integer

• ‌undodir‌

  list of string

• ‌undofile‌

  boolean

See the Vim documentation for detailed descriptions of these options. Use to manually set any options not listed above.

Type: submodule

Default:

{ }

Example:

{
  background = "dark";
  expandtab = true;
  history = 1000;
}

Declared by:

• <home-manager/modules/programs/vim.nix>