oxalica/nil
1
1
Fork 0
mirror of https://github.com/oxalica/nil.git synced 2024-11-23 12:03:30 +03:00
Code Issues Projects Releases Wiki Activity
Yet another language server for Nix
156 Commits 8 Branches 16 Tags 1.5 MiB
Rust 95.7%
Nix 3.9%
Shell 0.2%
TypeScript 0.1%
8f9882d1ad
Go to file
oxalica 8f9882d1ad Always wrap error syntax in ERROR nodes 
This prevents error tokens accidentally affect the container node, eg.
the dangling `let` inside an Attrset.

Fixes #20
2022-09-25 21:39:52 +08:00
.github/workflows Fix flake-compat in CI 2022-09-22 22:00:32 +08:00
crates Always wrap error syntax in ERROR nodes 2022-09-25 21:39:52 +08:00
dev Add test env and fix README for vscod{e,ium} + Nix IDE 2022-09-24 17:57:05 +08:00
doc Update README and split out feature list 2022-09-23 00:22:03 +08:00
.gitignore Add overlays to flake 2022-09-25 17:14:20 +08:00
Cargo.lock Generate builtins from Nix 2022-09-22 18:26:56 +08:00
Cargo.toml Refactor workspace layout 2022-09-06 01:54:33 +08:00
default.nix Fix flake-compat in CI 2022-09-22 22:00:32 +08:00
flake.lock Update flake and README 2022-09-22 21:30:27 +08:00
flake.nix Add overlays to flake 2022-09-25 17:14:20 +08:00
LICENSE-APACHE Licenses 2022-08-01 09:12:08 +08:00
LICENSE-MIT Licenses 2022-08-01 09:12:08 +08:00
README.md Add test env and fix README for vscod{e,ium} + Nix IDE 2022-09-24 17:57:05 +08:00
rustfmt.toml Enforce merging of "use" stmts 2022-08-02 03:27:55 +08:00
shell.nix Fix flake-compat in CI 2022-09-22 22:00:32 +08:00

README.md

nil: Yet another language server for Nix

CI

🚧 This project is under development, but be happy to try it out!

Super fast incremental analysis! Scans all-packages.nix in less than 0.1s and completes with no delay!

Features

See release notes for change log between tagged unstable versions.

See doc/features.md for an incomplete list of notable features currently implemented or planned.

Installation

This program is already included in NixOS/nixpkgs under attribute nil, and are regularly updated.

  • If you use nix-env, run nix-env -iA nixpkgs.nil
  • If you use nix profile, run nix profile install nixpkgs#nil

Flake

This repo is also packaged via Nix flakes, the language server binary package is available through the default flake output github:oxalica/nil# with the path bin/nil.

You can enable flakes support in your nix configuration, and then run nix profile install github:oxalica/nil to get nil installed. You can also use this repository as a flake input and add its output to your own flake-managed systemwide or home configuration.

Flake output structure:

├───devShells
│   └───(...)
└───packages
    ├───x86_64-linux
    │   ├───default: package 'nil-unstable-2022-08-04'
    │   └───nil: package 'nil-unstable-2022-08-04'
    └───(...)

Editor integration

Neovim native LSP and nvim-lspconfig

We are officially supported by nvim-lspconfig, see upstream docs.

See also the example config for testing.

Vim/Neovim with coc.nvim

Merge this setting into your coc-settings.json, which can be opened by :CocConfig.

{
  "languageserver": {
    "nix": {
      "command": "nil",
      "filetypes": ["nix"],
      "rootPatterns":  ["flake.nix"]
    }
  }
}

See also the example config for testing.

Emacs with eglot

Add the following elisp code to your configuration. (using use-package)

(use-package nix-mode)
(use-package eglot
  :config
  ;; Ensure `nil` is in your PATH.
  (add-to-list 'eglot-server-programs '(nix-mode . ("nil")))
  :hook
  (nix-mode . eglot-ensure))

Vscode/Vscodium with Nix IDE

Modify the extension's settings in your settings.json.

{
  // ...
  "nix.enableLanguageServer": true, // Enable LSP.
  "nix.serverPath": "nil" // The path to the LSP server executable.
}

License

"nil" is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.