feat(query): add Regal for linting Rego #6774
Open
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
github-actions
bot
added
community
Hello, friends at Kics! This PR introduces [Regal](https://github.com/styrainc/regal) for linting the massive Rego library included in this project. Given the size of this policy library, it should come as no surprise that a linter has much to say :) I've tried to fix the reported issues that seem safe to address, while configuring Regal to ignore the rest, leaving it to the maintainers of this project to decide what they'll want to enforce going forward. I've annotated the provided config file with some pointers and suggestions to try and make that chore a little easier. Reported issues fixes as part of this: Idiomatic: * [custom-has-key-construct](https://docs.styra.com/regal/rules/idiomatic/custom-has-key-construct) * [custom-in-construct](https://docs.styra.com/regal/rules/idiomatic/custom-in-construct) Bugs: * [rule-shadows-builtin](https://docs.styra.com/regal/rules/bugs/rule-shadows-builtin) Style * [default-over-else](https://docs.styra.com/regal/rules/style/default-over-else) * [unconditional-assignment](https://docs.styra.com/regal/rules/style/unconditional-assignment) Imports * [redundant-alias](https://docs.styra.com/regal/rules/imports/redundant-alias) * [import-after-rule](https://docs.styra.com/regal/rules/imports/import-after-rule) I've also added linting of Rego as a new job for CI. Let me know what you all think! Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
changed the title
github-actions
bot
added
feature request
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.
Hello, friends at Kics! This PR introduces Regal for linting the massive Rego library included in this project. Given the size of this policy library, it should come as no surprise that a linter has much to say :) I've tried to fix the reported issues that seem safe to address, while configuring Regal to ignore the rest, leaving it to the maintainers of this project to decide what they'll want to enforce going forward. I've annotated the provided config file with some pointers and suggestions to try and make that chore a little easier.
Reported issues fixes as part of this:
Idiomatic:
Bugs:
Style
Imports
I've also added linting of Rego as a new job for CI.
Let me know what you all think!
I submit this contribution under the Apache-2.0 license.