squawk-cli 0.12.0 → 0.14.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 +30 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -65,7 +65,7 @@ squawk
|
|
|
65
65
|
Find problems in your SQL
|
|
66
66
|
|
|
67
67
|
USAGE:
|
|
68
|
-
squawk [FLAGS] [OPTIONS] [
|
|
68
|
+
squawk [FLAGS] [OPTIONS] [path]... [SUBCOMMAND]
|
|
69
69
|
|
|
70
70
|
FLAGS:
|
|
71
71
|
-h, --help
|
|
@@ -77,24 +77,37 @@ FLAGS:
|
|
|
77
77
|
-V, --version
|
|
78
78
|
Prints version information
|
|
79
79
|
|
|
80
|
+
--verbose
|
|
81
|
+
Enable debug logging output
|
|
82
|
+
|
|
80
83
|
|
|
81
84
|
OPTIONS:
|
|
82
|
-
|
|
83
|
-
|
|
85
|
+
-c, --config <config-path>
|
|
86
|
+
Path to the squawk config file (.squawk.toml)
|
|
87
|
+
|
|
88
|
+
--dump-ast <ast-format>
|
|
89
|
+
Output AST in JSON [possible values: Raw, Parsed, Debug]
|
|
84
90
|
|
|
85
|
-
-e, --exclude <
|
|
91
|
+
-e, --exclude <rule>...
|
|
86
92
|
Exclude specific warnings
|
|
87
93
|
|
|
88
94
|
For example: --exclude=require-concurrent-index-creation,ban-drop-database
|
|
89
|
-
--explain <
|
|
95
|
+
--explain <rule>
|
|
90
96
|
Provide documentation on the given rule
|
|
91
97
|
|
|
98
|
+
--pg-version <pg-version>
|
|
99
|
+
Specify postgres version
|
|
100
|
+
|
|
101
|
+
For example: --pg-version=13.0
|
|
92
102
|
--reporter <reporter>
|
|
93
103
|
Style of error reporting [possible values: Tty, Gcc, Json]
|
|
94
104
|
|
|
105
|
+
--stdin-filepath <filepath>
|
|
106
|
+
Path to use in reporting for stdin
|
|
107
|
+
|
|
95
108
|
|
|
96
109
|
ARGS:
|
|
97
|
-
<
|
|
110
|
+
<path>...
|
|
98
111
|
Paths to search
|
|
99
112
|
|
|
100
113
|
|
|
@@ -194,6 +207,17 @@ cargo run
|
|
|
194
207
|
./s/fmt
|
|
195
208
|
```
|
|
196
209
|
|
|
210
|
+
... or with nix:
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
$ nix develop
|
|
214
|
+
[nix-shell]$ cargo run
|
|
215
|
+
[nix-shell]$ cargo insta review
|
|
216
|
+
[nix-shell]$ ./s/test
|
|
217
|
+
[nix-shell]$ ./s/lint
|
|
218
|
+
[nix-shell]$ ./s/fmt
|
|
219
|
+
```
|
|
220
|
+
|
|
197
221
|
### releasing a new version
|
|
198
222
|
|
|
199
223
|
1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
|