Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
caitlinelfring committed Aug 12, 2021
1 parent 85a5c2c commit fa60209
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
12 changes: 12 additions & 0 deletions docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,15 @@ This will disable the default `whitelist` rule:
rules:
- name: whitelist
```
### Disable all Default Rules
There may be a case where you want full control over the rules you want to run with woke.
You can either disable each default rule via the instructions above.
Or you can run woke with `--disable-default-rules` to completely disable all default rules.

!!! note
`woke` will fail to run if you use `--disable-default-rules` without providing your own rules
because that would mean running `woke` without any rules, which is pointless.
17 changes: 9 additions & 8 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ Usage:
woke [globs ...] [flags]
Flags:
-c, --config string Config file (default is .woke.yaml in current directory, or $HOME)
--debug Enable debug logging
--exit-1-on-failure Exit with exit code 1 on failures
-h, --help help for woke
--no-ignore Ignored files in .gitignore, .ignore, .wokeignore, .git/info/exclude, and inline ignores are processed
-o, --output string Output type [text,simple,github-actions,json,sonarqube] (default "text")
--stdin Read from stdin
-v, --version version for woke
-c, --config string Config file (default is .woke.yaml in current directory, or $HOME)
--debug Enable debug logging
--disable-default-rules Disable the default ruleset
--exit-1-on-failure Exit with exit code 1 on failures
-h, --help help for woke
--no-ignore Ignored files in .gitignore, .ignore, .wokeignore, .git/info/exclude, and inline ignores are processed
-o, --output string Output type [text,simple,github-actions,json,sonarqube] (default "text")
--stdin Read from stdin
-v, --version version for woke
```

## Config file
Expand Down

0 comments on commit fa60209

Please sign in to comment.