aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index cec99ef..ae525c9 100644
--- a/readme.md
+++ b/readme.md
@@ -90,6 +90,45 @@ statix check /path/to/dir -o json # only when compiled with --all-features
90statix check /path/to/dir -o errfmt # singleline, easy to integrate with vim 90statix check /path/to/dir -o errfmt # singleline, easy to integrate with vim
91``` 91```
92 92
93### Configuration
94
95Ignore lints and fixes by creating a `statix.toml` file at
96your project root:
97
98```
99# within statix.toml
100disabled = [
101 "unquoted_splices"
102]
103```
104
105`statix` automatically discovers the configuration file by
106traversing parents of the current directory and looking for
107a `statix.toml` file. Alternatively, you can pass the path
108to the `statix.toml` file on the command line with the
109`--config` flag (available on `statix check` and `statix
110fix`.
111
112The available lints are:
113
114```
115bool_comparison
116empty_let_in
117manual_inherit
118manual_inherit_from
119legacy_let_syntax
120collapsible_let_in
121eta_reduction
122useless_parens
123unquoted_splice
124empty_pattern
125redundant_pattern_bind
126unquoted_uri
127deprecated_is_null
128```
129
130All lints are enabled by default.
131
93## Architecture 132## Architecture
94 133
95`statix` has the following components: 134`statix` has the following components: