diff options
author | Akshay <[email protected]> | 2021-10-02 06:22:22 +0100 |
---|---|---|
committer | Akshay <[email protected]> | 2021-10-02 09:09:39 +0100 |
commit | 088559eedd40b16fff2ce97e48006580be39dd03 (patch) | |
tree | 46bb0ec90175d324e6b63d80f104e5ff9f42cea6 /readme.md | |
parent | a60429891fe9eb5290f95a52dd5e56f62d25d344 (diff) |
update docs; nix-analyzer -> statix
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -1,15 +1,15 @@ | |||
1 | ## nix-analyzer | 1 | ## statix |
2 | 2 | ||
3 | `nix-analyzer` intends to be a static analysis tool for the | 3 | `statix` intends to be a static analysis tool for the |
4 | Nix programming language. | 4 | Nix programming language. |
5 | 5 | ||
6 | For the time-being, `nix-analyzer` works only with ASTs | 6 | For the time-being, `statix` works only with ASTs |
7 | produced by the `rnix-parser` crate and does not evaluate | 7 | produced by the `rnix-parser` crate and does not evaluate |
8 | any nix code. | 8 | any nix code (imports, attr sets etc.). |
9 | 9 | ||
10 | ## Architecture | 10 | ## Architecture |
11 | 11 | ||
12 | `nix-analyzer` has the following components: | 12 | `statix` has the following components: |
13 | 13 | ||
14 | - `bin`: the CLI/entrypoint | 14 | - `bin`: the CLI/entrypoint |
15 | - `lib`: library of lints and utilities to define these | 15 | - `lib`: library of lints and utilities to define these |
@@ -18,7 +18,7 @@ any nix code. | |||
18 | 18 | ||
19 | ### `bin` | 19 | ### `bin` |
20 | 20 | ||
21 | This is the main point of interaction between `nix-analyzer` | 21 | This is the main point of interaction between `statix` |
22 | and the end user. It's output is human-readable and should | 22 | and the end user. It's output is human-readable and should |
23 | also support JSON/errorfmt outputs for external tools to | 23 | also support JSON/errorfmt outputs for external tools to |
24 | use. | 24 | use. |