Nickel Language VS Code extension

Features

• Syntax highlighting
• Nickel Language Server (NLS) integration
• Code formatting (through NLS)

Prerequsites

The VSCode extension is available on the VSCode Market Place. You need the Nickel Language Server (NLS) installed independently from the VSCode extension. Installation methods for NLS are detailed below.

Install NLS

Using pre-built binaries

Each Nickel release comes with pre-built binaries including NLS for a few common platforms. You can download them from the GitHub releases page.

If your platform is not supported, you can try the methods below. You should prefer Nix or Cargo if you already have on of them installed. Otherwise, using Cargo might be the simplest option.

Using Nix

nix profile install nixpkgs#nls

Using Cargo

cargo install nickel-lang-lsp

Other installation methods

See the Nickel README and The LSP README.

Building from source

If you need to build the VSCode extension yourself, you'll need to build it from source. Different methods are detailed below.

With Nix

From the root of the Nickel project:

nix build .\#vscodeExtension

The VSIX extension will be at ./result/vscode-nickel.vsix.

With Yarn

From this directory:

yarn install && yarn compile && yarn vsce package --yarn

The VSIX extension will be at ./vscode-nickel-[version].vsix.

Updating package.json

Whenever you change package.json, you must run the following command:

yarn install && yarn2nix > yarn.nix

This will update:

• yarn.lock
• yarn.nix