Use Regal for Rego linting #881
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
anderseknert
force-pushed
the
regal
branch
4 times, most recently
from
0f7dd73
to
8f0949e
Compare
This PR introduces [Regal](https://github.com/styrainc/regal) for linting the example policies in this project. The Rego found there is generally in a good shape, and the fixes done as part of this are mostly related to style. The code has been updated to conformance against the following rules: * [line-length](https://docs.styra.com/regal/rules/style/line-length) * [use-assignment-operator](https://docs.styra.com/regal/rules/style/use-assignment-operator) * [use-some-for-output-vars](https://docs.styra.com/regal/rules/idiomatic/use-some-for-output-vars) * [prefer-snake-case](https://docs.styra.com/regal/rules/style/prefer-snake-case) * [print-or-trace-call](https://docs.styra.com/regal/rules/testing/print-or-trace-call) A few rules are also ignored for now (`.regal/config.yaml`) and I'll leave it up to the maintainers to decide whether more rules should be enabled later. The PR also adds Regal to CI to lint any Rego introduced or changed in future PRs. For more information about Regal and its rules, see the [documentation](https://docs.styra.com/regal) for the project. Signed-off-by: Anders Eknert <anders@styra.com>
|
This looks fantastic to me. As you mentioned, we'll take this as is and play around with the additional rulesets. Much appreciated ❤️ |
jpreese
approved these changes
Oct 19, 2023
|
Awesome, John! I'd love to hear about your experience using Regal later 🙂 |
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.
This PR introduces Regal for linting the example policies in this project. The Rego found there is generally in a good shape, and the fixes done as part of this are mostly related to style.
The code has been updated to conformance against the following rules:
A few rules are also ignored for now (
.regal/config.yaml) and I'll leave it up to the maintainers to decide whether more rules should be enabled later.The PR also adds Regal to CI to lint any Rego introduced or changed in future PRs.
For more information about Regal and its rules, see the documentation for the project.