nix README

Adds nix language support for VSCode Editor.

Features

• Syntax Highlight

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

  

  • nix code snippets inside markdown files also work.

  

• Full editing support with rnix-LSP

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

  • Formatting support
    • with the help of nixpkgs-format
  • 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 .

Installing the extension Locally

Just clone the GitHub repository under your local extensions folder:

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

Contributing

I have created this since the other nix-language extension hasn't been updated over an year. I just wanted to add formatting and error detection quickly. Contributions are very welcome. But please follow the below points.

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

Development

• TypeScript is used to develop the extension

  yarn install
  yarn build # this will build the extension

Special thanks to

• article to have all the pieces in one place to develop vscode extension with Fable .
• The extension vscode-fish is modified to work for nix .

Links

• Extension page