adamcstephens / vscode-nix-ide

Nix language support for VSCode editor [maintainer: @jnoortheen]

nix-ide

Adds nix language support for VSCode Editor.

Features

• Syntax Highlight

  • Thanks to https://github.com/wmertens/sublime-nix for the grammar file

  

  • Nix code snippets inside markdown files also work.

  

• Full editing support when using a language server. Generally, any nix LSP implementation should work.
  The following are tested so far:

  • rnix-lsp

  • nil

  • nixd

    {
      "nix.enableLanguageServer": true,
      "nix.serverPath": "rnix-lsp"
      // "nix.serverPath": "nil"
      // "nix.serverPath": "nixd"
    }

  Pass settings to the language server via serverSettings.

  {
    "nix.serverSettings": {
      // settings for 'nil' LSP
      "nil": {
        "diagnostics": {
          "ignored": ["unused_binding", "unused_with"]
        },
        "formatting": {
          "command": ["nixpkgs-fmt"]
        }
      }
    }
  }

  {
      "nix.serverSettings": {
          // settings for 'nixd' LSP
          "nixd": {
              "eval": {
                  // stuff
              },
              "formatting": {
                  "command": "nixpkgs-fmt"
              },
              "options": {
                  "enable": true,
                  "target": {
                      // tweak arguments here
                      "args": [],
                      // NixOS options
                      "installable": "<flakeref>#nixosConfigurations.<name>.options"
  
                      // Flake-parts options
                      // "installable": "<flakeref>#debug.options"
  
                      // Home-manager options
                      // "installable": "<flakeref>#homeConfigurations.<name>.options"
                  }
              }
          }
    }
  }

• When Language Server support is not enabled the following tools are used to

  • Formatting support. Set nix.formatterPath to any command which can accept file contents on stdin and return formatted text on stdout; e.g.,

    {
      "nix.formatterPath": "nixpkgs-fmt" // default
      // "nix.formatterPath": "nixfmt"
      // "nix.formatterPath": ["treefmt", "--stdin", "{file}"]
      // "nix.formatterPath": ["nix", "fmt", "--", "-"] // using flakes with `formatter = pkgs.alejandra;`
    }

  • Error Report
    • Using nix-instantiate errors reported

  

• Snippets

Todos

PRs welcome for them

• embedded language syntax support for bash
• path completion - https://github.com/ChristianKohler/PathIntellisense

Installation

Visual Studio Code

Hit F1 and enter the ext install jnoortheen.nix-ide command or search for nix-ide.

*.vsix file

The extension can be downloaded from the release page.

Installing the extension Locally

Just clone the GitHub repository under your local extensions folder:

• Windows: %USERPROFILE%\.vscode\extensions
• Mac / Linux: $HOME/.vscode/extensions

Contributing

• Document the purpose of functions and classes.
• Please mention a new feature in the README.md Features section when adding it. Use screenshots when applicable.
• Conventional Commit style should be used for commit messages as it is used to generate changelog.

Development

There is direnv and nix-shell support so a dev environment can be created with the nix-shell command or a one-time direnv allow at the root of the repo.

Press F5 in VSCode to run an Extension Development Host instance with the extension installed.

TypeScript is used to develop the extension.

yarn install # install dependencies
yarn build   # build the extension

Releasing a new version

• fill .env from .env.template

# this is needed to publish extensions to [openvsx](https://open-vsx.org/) from local machine.
yarn env-cmd

# this will generate changelog and will create a GitHub release. This will also trigger jobs to publish the extension.
yarn release

# to manually publish the extension
yarn publish

---

Special thanks to

• wmertens for writing the syntax definitions.
• The extension vscode-fish is modified to work for nix .

Links

• Extension page at vscode marketplace
• https://open-vsx.org/extension/jnoortheen/nix-ide