squawk-cli 0.11.3 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -111,6 +111,27 @@ Individual rules can be disabled via the `--exclude` flag
|
|
|
111
111
|
squawk --exclude=adding-field-with-default,disallowed-unique-constraint example.sql
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
+
### Configuration file
|
|
115
|
+
|
|
116
|
+
Rules can also be disabled with a configuration file.
|
|
117
|
+
|
|
118
|
+
By default, Squawk will traverse up from the current directory to find a `.squawk.toml` configuration file. You may specify a custom path with the `-c` or `--config` flag.
|
|
119
|
+
|
|
120
|
+
```shell
|
|
121
|
+
squawk --config=~/.squawk.toml example.sql
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
The `--exclude` flag will always be prioritized over the configuration file.
|
|
125
|
+
|
|
126
|
+
**Example `.squawk.toml`**
|
|
127
|
+
|
|
128
|
+
```toml
|
|
129
|
+
excluded_rules = [
|
|
130
|
+
"require-concurrent-index-creation",
|
|
131
|
+
"require-concurrent-index-deletion",
|
|
132
|
+
]
|
|
133
|
+
```
|
|
134
|
+
|
|
114
135
|
See the [Squawk website](https://squawkhq.com/docs/rules) for documentation on each rule with examples and reasoning.
|
|
115
136
|
|
|
116
137
|
## Bot Setup
|