Skip to content

Commit

Permalink
Update docs on CLI switches
Browse files Browse the repository at this point in the history
  • Loading branch information
René Föhring committed Apr 10, 2020
1 parent bd60640 commit 0aa523a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions guides/configuration/cli_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ The second example illustrates how the command takes a comma-separated list. All

You can use partial names to quickly exclude checks. `mix credo --ignore nameredec` will exclude all checks for variables/parameters having the same name as declared functions by matching Credo.Check.Warning.**NameRedeclarationBy...**

### Re-enable disabled checks

Use `--enable-disabled-checks [pattern]` to re-enable checks that were disabled in the config using `{CheckModule, false}`. This comes in handy when using checks on a case-by-case basis

As with other check-related switches, `pattern` is a comma-delimted list of patterns:

```bash
$ mix credo info --enable-disabled-checks Credo.Check.Readability.Specs,Credo.Check.Refactor.DoubleBooleanNegation
```

Of course, we can have the same effect by choosing the pattern less explicitly:

```bash
$ mix credo info --enable-disabled-checks specs,double
```


### Parsing source from STDIN

Expand Down

0 comments on commit 0aa523a

Please sign in to comment.