How to install rnix-lsp on NixOS?

Install via nix-env with the master.tar.gz archive, as shown in the README, but note that this method might not be version-pinned and could break with updates. For more stability, consider using a Nix flake or overlay if available.

Does rnix-lsp work with NeoVim?

Yes, rnix-lsp supports NeoVim through plugins like coc.nvim or LanguageClient-neovim, but configuration may require tweaking since the instructions aren't fully tested. Check the GitHub issues for community fixes if setup fails.

rnix-lsp vs nil: which is better?

rnix-lsp is built on the rnix parser and focuses on basic LSP features, while nil (another Nix LSP) might offer different capabilities or stability. Choose rnix-lsp for community support and integration with nixpkgs-fmt, but nil could be preferable for those needing more experimental features or better performance.

How to debug rnix-lsp errors?

Enable logging with RUST_LOG=trace and redirect stderr to a file, as per the README. This provides detailed traces to diagnose issues, but be prepared for verbose output and manual interpretation due to the beta nature of the project.

What editors does rnix-lsp support?

It supports Vim/Neovim, Emacs, Kakoune, and VSCode via extensions, but integration is community-contributed and may have gaps. Always verify the latest README or GitHub issues for updates on specific editor setups.

Is rnix-lsp stable enough for daily use?

No, the project explicitly warns of beta-level quality and expected breakages, so it's best for developers who can tolerate instability. For production workflows, consider using it cautiously or exploring alternatives with more maturity.

Open-Awesome

rnix-lsp

MITRust

A language server for Nix providing syntax checking, completion, renaming, and formatting.

GitHub

713 stars41 forks0 contributors

What is rnix-lsp?

rnix-lsp is a language server for the Nix programming language that provides syntax checking, code completion, renaming, goto definition, and formatting capabilities. It solves the problem of lacking robust editor support for Nix by integrating with popular code editors to enhance developer productivity.

Target Audience

Nix developers and system administrators who write Nix expressions and need advanced editor tooling for syntax validation, navigation, and code formatting.

Value Proposition

Developers choose rnix-lsp because it is the primary open-source language server for Nix, built on the reliable rnix parser, and it integrates seamlessly with major editors like Vim, Emacs, and VSCode.

Overview

WIP Language Server for Nix! [maintainer=@aaronjanse]

Use Cases

Best For

Writing and validating Nix expressions in real-time
Navigating complex Nix codebases with goto definition
Refactoring Nix code with rename functionality
Formatting Nix code consistently with nixpkgs-fmt
Enhancing editor support for Nix development
Integrating Nix tooling into Vim, Emacs, or VSCode

Not Ideal For

Projects requiring stable, production-ready language server support without breaking changes
Teams developing on Mac OS who need guaranteed cross-platform compatibility
Developers needing advanced IDE features like semantic linting, debugging, or deep refactoring beyond basic operations
Environments using editors with untested integration or where setup requires extensive manual configuration

Pros & Cons

Pros

Reliable Syntax Diagnostics

Provides real-time syntax checking using the rnix parser, offering accurate error detection for Nix code without external tools.

Essential Editor Tooling

Integrates basic LSP features like completion, renaming, and goto definition, enhancing productivity for common Nix development tasks.

Built-in Formatting Support

Seamlessly integrates with nixpkgs-fmt for code formatting, ensuring consistent style directly within the editor workflow.

Community-Driven Development

Maintained by the Nix community with active support on Matrix, fostering collaboration and updates based on user feedback.

Cons

Unstable Beta Quality

Admits to being 'beta-level at best' with expected breakages and no semver compatibility before 1.x.y, making it risky for critical projects.

Limited Platform Guarantees

Mac OS support is not guaranteed, as noted in PR #61, which can exclude developers on Apple ecosystems.

Sparse Integration Testing

Editor integration instructions are not fully tested per the README, often requiring users to raise issues or submit PRs for fixes.

Frequently Asked Questions

Related Projects

Devbox

Instant, easy, and predictable development environments

Stars11,583

Forks316

Last commit4 days ago

flox

The Deterministic Foundation for your SDLC

A fast, persistent use_nix/use_flake implementation for direnv [maintainer=@Mic92 / @bbenne10]

Stars2,661

Forks142

Last commit5 days ago

attic

Multi-tenant Nix Binary Cache

Stars1,884

Forks167

Last commit2 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub