Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

rule: Disable leaked_internal_reference for test files #1228

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

charlieegan3
Copy link
Member

Option added to turn back on if needed

Option added to turn back on if needed

Signed-off-by: Charlie Egan <charlie@styra.com>

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't super clear here that this rule is disabled by default for tests. I'd put more emphasis on that, given that it's probably the only rule where that is the case.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's fair, I have updated in 1abaa96

Signed-off-by: Charlie Egan <charlie@styra.com>
@charlieegan3 charlieegan3 merged commit 96e4804 into StyraInc:main Oct 31, 2024
4 checks passed
charlieegan3 added a commit to charlieegan3/regal that referenced this pull request Jan 6, 2025
* rule: Disable leaked_internal_reference for test files

Option added to turn back on if needed

Signed-off-by: Charlie Egan <charlie@styra.com>

* Explain the rule is of by default for tests

Signed-off-by: Charlie Egan <charlie@styra.com>

---------

Signed-off-by: Charlie Egan <charlie@styra.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants