Options

aliases

Aliases to symlink nvim to.

Type

list of string

Default

[ ]

Example

[
  "vi"
  "vim"
]

appName

What to set $NVIM_APPNAME to

Type

string

Default

"mnw"

Example

"gerg"

desktopEntry

Whether to enable neovim's desktop entry.

Type

boolean

Default

true

Example

false

enable

Whether to enable mnw (Minimal Neovim Wrapper).

Type

boolean

Default

false

Example

true

extraBinPath

Extra packages to be put in neovim's PATH

Type

list of package

Default

[ ]

Example

[
  pkgs.rg
  pkgs.fzf
]

extraBuilderArgs

Extra attributes to pass to mkDerivation.

Type

attribute set of anything

Default

{ }

Example

{
  doInstallCheck = true;
  extraInstallCheckInputs = [ pkgs.hello ];
  installCheckPhase = ''
    hello
  '';
}

extraLuaPackages

A function which returns a list of extra needed lua packages.

Type

function that evaluates to a(n) list of package

Default

ps: [ ]

Example

ps: [ ps.jsregexp ]

finalPackage

The final package to be consumed by the user

Type

package

initLua

lua config text to load at startup

Type

strings concatenated with "\n"

Default

""

Example

''
  require("myConfig")
''

initViml

VimL config text to load at startup

Type

strings concatenated with "\n"

Default

""

Example

''
  echomsg 'hello world'
''

luaFiles

lua config files to load at startup

Type

list of path in the Nix store

Default

[ ]

Example

[
  (pkgs.writeText "init.lua" ''
    print('hello world')
  '')
]

neovim

The neovim package to use. Must be unwrapped

Type

package

Default

pkgs.neovim-unwrapped

Example

inputs.neovim-nightly-overlay.packages.${pkgs.stdenv.system}.default

vimlFiles

VimL config files to load at startup

Type

list of path in the Nix store

Default

[ ]

Example

[
  (pkgs.writeText "init.vim" ''
    echomsg 'hello world'
  '')
]

wrapperArgs

A list of arguments to be passed to makeWrapper

Type

list of string

Default

[ ]

Example

[
  "--set-default"
  "FZF_DEFAULT_OPTS"
  "--layout=reverse --inline-info"
]

Plugins Configuration

plugins

neovim plugins.

Type

submodule

Default

{ }

Example

{
  plugins = {
    # Plugins which can be reloaded without rebuilding
    # see dev mode in the docs
    dev.myconfig = {
      # This is the recommended way of passing your config
      pure = "myconfig";
      impure = "/home/user/nix-config/nvim";
    };

    # List of plugins to load automatically
    start = [
      # you can pass vimPlugins from nixpkgs
      pkgs.vimPlugins.lz-n

      # To pass a directory
      # ('plugins.dev.<name>' is preferred for directories)
      {
        name = "plugin";
        src = ./plugin;
      }


      # Custom plugin example
      {
        # "pname" and "version"
        # or "name" is required
        pname = "customPlugin";
        version = "1";

        name = "customPlugin-1";

        src = pkgs.fetchFromGitHub {
          owner = "";
          repo = "";
          ref = "";
          hash = "";
        };

        # Plugins can have other plugins as dependencies
        # this is mainly used in nixpkgs
        # avoid it if possible
        dependencies = [];
      }
    ];

    # List of plugins to not load automatically
    # (load with packadd or a lazy loading plugin )
    opt = [
      pkgs.vimPlugins.oil-nvim
    ];
  };
}

plugins.dev

Plugins for use with devMode. You most likely want to put your config here. (automatically loaded)

Type

attribute set of (submodule)

Default

{ }

Example

{
  myconfig = {
    pure = ./nvim;
    impure = "/home/user/nix-config/nvim";
  };
}

plugins.dev.<name>.impure

The impure absolute paths to the nvim plugin.

Type

absolute path

Example

/home/user/nix-config/nvim

plugins.dev.<name>.pure

The pure path to the nvim plugin.

Type

attribute set of anything

Example

./nvim

plugins.opt

Plugins to place in /opt (not automatically loaded)

Type

list of (attribute set of anything)

Default

[ ]

Example

[ pkgs.vimPlugins.oil-nvim ]

plugins.start

Plugins to place in /start (automatically loaded)

Type

list of (attribute set of anything)

Default

[ ]

Example

[ pkgs.vimPlugins.lz-n ]

Provider Configuration

providers.nodeJs.enable

Whether to enable and configure the Node.js provider.

Type

boolean

Default

false

Example

true

providers.nodeJs.neovimClientPackage

The neovim-node-client package to use.

Type

package

Default

pkgs.neovim-node-client

Example

pkgs.neovim-node-client

providers.nodeJs.package

The Node.js package to use.

Type

package

Default

pkgs.nodejs

Example

pkgs.nodejs_23

providers.perl.enable

Whether to enable and configure the perl provider.

Type

boolean

Default

false

Example

true

providers.perl.extraPackages

Extra packages to be included in the perl environment.

Note: you probably want to include NeovimExt and Appcpanminus if you change this from it's default value.

Type

function that evaluates to a(n) list of package

Default

p: [
  p.NeovimExt
  p.Appcpanminus
]

Example

p: [
  p.NeovimExt
  p.Appcpanminus
]

providers.perl.package

The perl package to use.

Type

package

Default

pkgs.perl

Example

pkgs.perl

providers.python3.enable

Whether to enable and configure the python3 provider.

Type

boolean

Default

false

Example

true

providers.python3.extraPackages

Extra packages to be included in the python3 environment.

Note: you probably want to include pynvim if you change this from it's default value.

Type

function that evaluates to a(n) list of package

Default

p: [ ppynvim ]

Example

py: [
  py.pynvim
  py.pybtex
]

providers.python3.package

The python3 package to use.

Type

package

Default

pkgs.python3

Example

pkgs.python39

providers.ruby.enable

Whether to enable and configure the ruby provider.

Type

boolean

Default

false

Example

true

providers.ruby.env

The ruby bundlerEnv to use.

Type

package

Default

pkgs.bundlerEnv {
  name = "neovim-ruby-env";
  gemdir = ../ruby_provider;
  postBuild = '''
    rm $out/bin/{bundle,bundler}
  ''';
}

Example

pkgs.bundlerEnv {
  name = "neovim-ruby-env";
  gemdir = ../ruby_provider;
}

providers.ruby.package

The ruby package to use.

Type

package

Default

programs.mnw.providers.ruby.env.ruby

Example

pkgs.ruby