CLI
#
Usage#
RulesIndividual rules can be disabled via the --exclude
flag
#
Disabling rules via commentsRule violations can be ignored via the squawk-ignore
comment:
You can also ignore multiple rules by making a comma seperated list:
#
FilesFiles can be excluded from linting via the --exclude-path
flag. Glob matching is supported and the flag can be provided multiple times.
.squawk.toml
configuration file#
Rules can be disabled with a configuration file.
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.
The --exclude
, --exclude-path
, and --pg-version
flags will always be prioritized over the configuration file.
.squawk.toml
configurations#
Example #
Excluding rules#
Specifying postgres version#
Specifying whether SQL files will be wrapped in a transaction#
Using all optionsSee the Squawk website for documentation on each rule with examples and reasoning.