Profpatsch / vscode-nix-ide

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

Home Page:https://marketplace.visualstudio.com/items?itemName=jnoortheen.nix-ide

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nix README

Adds nix language support for VSCode Editor.

Features

  • Syntax Highlight

    • 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
    • Error Report
      • Using nix-instantiate errors reported

  • Snippets

Todos

PRs welcome for them

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

About

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

https://marketplace.visualstudio.com/items?itemName=jnoortheen.nix-ide

License:MIT License


Languages

Language:TypeScript 98.3%Language:Shell 1.1%Language:JavaScript 0.6%