Editor Modes for Nix Files

⤟︎

This article or section is a candidate for merging with Nix (language). Further information may be found in the relevant discussion page.

Nix language has decent syntax highlighting (SH) support among popular code editors, but refactoring/autocomplete is still rare. Below is a list of editor modes for Nix syntax.

Language servers

Most popular editors have support for the language server protocol, the following language servers can be used to provide features like completions and go-to-definition.

• nil
• nixd
• rnix-lsp (deprecated)

Emacs

• nix-mode official available in melpa
• @marsam's nix-mode
• nix-buffer
• nix-update-el

Vim

vim-addon-nix

This plugin supports syntax highlighting and simple syntax and undeclared variable checking.

• vim-addon-nix on github

Usage with VAM package manager:

{ # /etc/nixos/configuration.nix
  environment.systemPackages = [
    (pkgs.vim_configurable.customize {
      name = "vim";
      vimrcConfig.vam.pluginDictionaries = [
        # vim-nix handles indentation better but does not perform sanity
        { names = [ "vim-addon-nix" ]; ft_regex = "^nix\$"; }
      ];
    })
  ];
}

vim-nix

vim-nix *only* supports syntax-highighting.

• vim-nix on github

Usage with vim package manager:

{ # /etc/nixos/configuration.nix
  environment.systemPackages = [
    (pkgs.vim_configurable.customize {
      name = "vim";
      vimrcConfig.packages.myplugins = with pkgs.vimPlugins; {
        start = [ vim-nix ]; # load plugin on startup
      };
    })
  ];
}

Neovim

In addition to the Vim plugins listed above, nvim-treesitter also has support for nix.

{
  programs.neovim = {
    configure = {
      packages.all.start = with pkgs.vimPlugins; [
        (nvim-treesitter.withPlugins (ps: [ ps.nix ]))
        # or
        nvim-treesitter.withAllGrammars # to install all grammars (including nix)
      ];
    };
  };
}

IntelliJ IDEA

• nix-idea on github

Eclipse

• nix-eclipse - development stopped in 2010

Sublime Text

• sublime-nix on github

Atom

• atom-nix on github

Visual Studio Code

• vscode-nix on github
• vscode-nix-ide on GitHub and VSCode Store with support to format and lint

Howl

• howl-nix on github

Far2l

• far2l with nix syntax highlighting patch in nixpkgs

nano

• nanonix

micro

Syntax highlighting is built-in. LSP support is available through the lsp plugin.

Codemirror

• codemirror-lang-nix

Zed

• zed-nix on github

Relevant pages

• Overview of the Nix Expression Language
• Nix Expression Language: Tips & Tricks
• Learning resources