Editor Modes for Nix Files: Difference between revisions

Revision as of 15:21, 5 February 2023

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 llanguage server protocol, the following language servers can be used to provide features like completions and go-to-definition.

nil
rnix-lsp

Emacs

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

Relevant pages

@@ Line 1: / Line 1: @@
 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 l[https://microsoft.github.io/language-server-protocol language server protocol], the following language servers can be used to provide features like completions and go-to-definition.
+* [https://github.com/oxalica/nil nil]
+* [https://github.com/nix-community/rnix-lsp rnix-lsp]
 == Emacs ==
@@ Line 6: / Line 11: @@
 * [https://github.com/shlevy/nix-buffer nix-buffer]
 * [https://github.com/jwiegley/nix-update-el nix-update-el]
-* [https://github.com/nix-community/rnix-lsp rnix-lsp]
 == Vim ==
-=== rnix-lsp ===
-* [https://github.com/nix-community/rnix-lsp rnix-lsp on github]
-instructions are in the readme
 === vim-addon-nix ===
@@ Line 45: / Line 46: @@
    ];
 }</syntaxHighlight>
+== Neovim ==
+In addition to the Vim plugins listed above, [https://github.com/nvim-treesitter/nvim-treesitter nvim-treesitter] also has support for nix.
+<syntaxHighlight lang="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)
+      ];
+    };
+  };
+}
+</syntaxHighlight>
 == IntelliJ IDEA ==