mirror of
https://github.com/oppiliappan/statix.git
synced 2024-10-26 20:04:49 +03:00
lints and suggestions for the nix programming language
bin | ||
lib | ||
macros | ||
vfs | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
default.nix | ||
flake.lock | ||
flake.nix | ||
notes.txt | ||
readme.md | ||
shell.nix |
statix
statix
intends to be a static analysis tool for the
Nix programming language.
For the time-being, statix
works only with ASTs
produced by the rnix-parser
crate and does not evaluate
any nix code (imports, attr sets etc.).
Architecture
statix
has the following components:
bin
: the CLI/entrypointlib
: library of lints and utilities to define these lintsmacros
: procedural macros to help define a lint
bin
This is the main point of interaction between statix
and the end user. It's output is human-readable and should
also support JSON/errorfmt outputs for external tools to
use.
lib
A library of AST-based lints and utilities to help write those lints. It should be easy for newcomers to write lints without being familiar with the rest of the codebase.
macros
This crate intends to be a helper layer to declare lints and their metadata.
TODO
- Offline documentation for each lint
- Automatically fix all lints from suggestions generated
- Test suite for lints and suggestions