Refactor rule metadata logic #174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some additional refactoring made possible now that each rule resides in its own file. Extend this further to have each rule in its own package, and move the metadata from the `report` rule in each package and to the package declaration. We may then use `rego.metadata.chain()` instead, which includes the path of the package containing both the category and the title, thus allowing us to skip having to redeclare that in annotations. This has a number of benefits: - Tests are now proper _unit_ tests, and no longer test the whole category. - Checking if a rule is ignored can now be the responsibility of the main rule, and linter rules need no longer be concerned with that unless they have unique configuration options. - Reduce the amount of clutter in each rule related to metadata, and with that the possibility of mistakes. Signed-off-by: Anders Eknert <anders@styra.com>
charlieegan3
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some additional refactoring made possible now that each rule resides in its own file. Extend this further to have each rule in its own package, and move the metadata from the
reportrule in each package and to the package declaration. We may then userego.metadata.chain()instead, which includes the path of the package containing both the category and the title, thus allowing us to skip having to redeclare that in annotations.This has a number of benefits: