diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 14 |
1 files changed, 11 insertions, 3 deletions
@@ -57,7 +57,17 @@ Basic usage is as simple as: | |||
57 | statix check /path/to/dir | 57 | statix check /path/to/dir |
58 | 58 | ||
59 | # ignore generated files, such as Cargo.nix | 59 | # ignore generated files, such as Cargo.nix |
60 | statix check /path/to/dir -i '*Cargo.nix' | 60 | statix check /path/to/dir -i Cargo.nix |
61 | |||
62 | # ignore more than one file | ||
63 | statix check /path/to/dir -i a.nix b.nix c.nix | ||
64 | |||
65 | # ignore an entire directory | ||
66 | statix check /path/to/dir -i .direnv | ||
67 | |||
68 | # statix respects your .gitignore if it exists | ||
69 | # run statix in "unrestricted" mode, to disable that | ||
70 | statix check /path/to/dir -u | ||
61 | 71 | ||
62 | # see `statix -h` for a full list of options | 72 | # see `statix -h` for a full list of options |
63 | ``` | 73 | ``` |
@@ -115,8 +125,6 @@ their metadata. | |||
115 | 125 | ||
116 | ## TODO | 126 | ## TODO |
117 | 127 | ||
118 | - Offline documentation for each lint | ||
119 | - Test suite for lints and suggestions | 128 | - Test suite for lints and suggestions |
120 | - Vim plugin (qf list population, apply suggestions) | ||
121 | - Resolve imports and scopes for better lints | 129 | - Resolve imports and scopes for better lints |
122 | - Add silent flag that exits with status | 130 | - Add silent flag that exits with status |