Skip to content

Commit

Permalink
Explain the rule is of by default for tests
Browse files Browse the repository at this point in the history
Signed-off-by: Charlie Egan <charlie@styra.com>
  • Loading branch information
charlieegan3 committed Oct 31, 2024
1 parent 147a447 commit 1abaa96
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/rules/bugs/leaked-internal-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ mean that the benefits listed above won't apply to your project.

## Exceptions

In test files and packages, it can be useful to reference internal rules and
functions to ensure good test coverage. If you want to run this rule for test
files too, you can set `include-test-files: true` in the configuration for this
rule.
This rule is not enabled by default for test files. In tests, it can be useful
to reference internal rules and functions to achieve good test coverage, which
would be a violation of this rule. If you want to run this rule for tests
too, you can set `include-test-files: true` in the configuration for this rule
in your Regal config file.

## Configuration Options

Expand Down

0 comments on commit 1abaa96

Please # to comment.