v0.4.0

This release brings three new rules related to comments and metadata annotations:

• invalid-metadata-attribute (bugs category) flags custom attributes in metadata annotations not placed under the custom attribute.
• detached-metadata (style category) flags metadata annotations that are "detached" by whitespace from their package or rule.
• no-whitespace-comment (style category) simply flags comments where the first character following the # is not whitespace.

Additionally, new end-to-end tests exposed a few mistakes in a previous refactoring, which have been fixed. This mistake meant that v0.3.0 failed to correctly run the line-length and function-arg-return rules... so if you started from that release you're really getting five new rules with v0.4.0... good thing we're keeping a fast paced release cadence! Thanks to @kristiansvalland for reporting on this regression.

Changelog

• 17bc200: Add no-whitespace-comment style rule (@anderseknert)
• 2f68245: Add invalid-metadata-attribute rule (@anderseknert)
• a093ff6: Bump github.com/open-policy-agent/opa from 0.53.1 to 0.54.0 (#189) (@dependabot[bot])
• 00c2455: New style rule: detached-metadata (#190) (@anderseknert)
• 147a373: Add codeql.yml (#184) (@anderseknert)
• cb516a4: Add e2e test of all rules (#192) (@anderseknert)

v0.3.0

This release improves the use-assignment-operator rule to include many more cases than previously reported.

Additionally, this release fixes a number of issues uncovered when running Regal against some large real-world policy libraries. A few of these were false positives, i.e. where Regal would report issues where there were none, and a few were cases that Regal previously missed.

On the community side, a link to the blog about the ideas behind Regal was added to the README.

Changelog

• 422bd80: Add link to blog (#173) (@anderseknert)
• cafd6b7: Refactor rule metadata logic (#174) (@anderseknert)
• 54b7669: Fix unconditional-assignment with else clause (#179) (@anderseknert)
• ebc5059: test-outside-test-package: functions prefixed test_ aren't tests (#177) (@anderseknert)
• 16f1894: Improve use-assignment-operator rule (#175) (@anderseknert)
• 64c99c6: external-reference: don't count wildcard as external ref (#181) (@anderseknert)
• 6dcc15e: Don't assume a single wildcard in custom-has-key-construct (#183) (@anderseknert)

v0.2.0

This release adds a new idiomatic category, meant for rules that indicate that there is a more idiomatic way to do something. Two new rules have been added to that category:

• custom-has-key-construct
• custom-in-construct

These rules will flag custom implementations of "has_key" function and "contains" respectively, as more idiomatic ways to achieve the same are now available (see links for details).

Additionally, this release fixes a bug where Regal would fail on inputs where a function was declared more than one time in a policy (i.e. with the same name).

On the community side, we've added a logo and a a code of conduct doc.

The rules have also been refactored so that now each rule resides in its own file rather than all of them being grouped in a big file per category. This makes it easier to quickly find rules to work with, and hopefully also to contribute new ones.

Changelog

• b1ad172: Add CoC (#166) (@anderseknert)
• 8852a3a: Add logo (#167) (@charlieegan3)
• aab76ff: Don't crash on identically named functions (#169) (@anderseknert)
• b57ac0e: refactor: one rule, one file (#170) (@anderseknert)
• 67b0ed8: Add idiomatic category (#171) (@anderseknert)
• a9c350b: Remove unused imports (#172) (@anderseknert)

v0.1.1

Changelog

• a415b35: Use lowercase chars in registry name (#165) (@charlieegan3)

v0.1.0-beta2

Changelog

• df3a806: Bump github.com/open-policy-agent/opa from 0.53.0 to 0.53.1 (@dependabot[bot])
• cb62e97: Merge pull request #149 from StyraInc/dependabot/go_modules/github.com/open-policy-agent/opa-0.53.1 (@charlieegan3)
• 3715726: Address issue in version format (#150) (@charlieegan3)
• bfb9d45: Refine regal definition (#151) (@charlieegan3)
• e98b60a: Bump OPA and built-in metadata (#155) (@anderseknert)
• 131bd2c: Update example to be more sensible (#156) (@anderseknert)
• 562d430: Wait for linting tasks to start before waiting (#158) (@charlieegan3)

v0.1.0-beta1

Changelog

• ec7874b: Rule: rule-named-if (#141) (@anderseknert)
• e711ca3: Rule: function-arg-return (#143) (@anderseknert)
• 04fc6dc: Allow loading of config from arg paths (@charlieegan3)
• c9cfeea: Handle empty config files with clearer message (@charlieegan3)
• 91e88e8: Merge pull request #145 from StyraInc/config-loading (@charlieegan3)
• 0d83026: linter_test: fix typo (#148) (@srenatus)
• 92a941f: e2e: add very basic e2e tests (#147) (@srenatus)
• c045881: Add LICENSE (@anderseknert)

v0.0.0-alpha4

Changelog

• ed142a7: Only run build on branch push (#123) (@charlieegan3)
• 9165eb1: Fix missing text in unconditional-assignment rule (#124) (@anderseknert)
• d5e1405: Implement simple concurrent Rego evaluation (@charlieegan3)
• beaf789: Appease the linter (@charlieegan3)
• 4946807: Merge pull request #125 from StyraInc/parallel (@charlieegan3)
• 269484a: functions/print-or-trace-call (#126) (@anderseknert)
• 535433f: Bump dependencies (#133) (@anderseknert)
• 7518be5: bugs/not-equals-in-loop (#130) (@anderseknert)
• 1099a2c: Use custom regal.last built-in for last array element lookup (#128) (@anderseknert)
• 322a6b1: Add CLI flags to enable/disable rules (#134) (@anderseknert)
• efa5c10: Reorganize categories (#135) (@anderseknert)
• a35a034: Various improvements for release (#136) (@anderseknert)
• 81b53fc: Minor README fixes (#139) (@anderseknert)

v0.0.0-alpha3

Changelog

• 924d3a0: Rule: imports/redundant-alias (#116) (@anderseknert)
• d842766: Ensure merge overwrite in user config for Go rules (#120) (@anderseknert)
• b24752f: Rule: bugs/unused-return-value (#112) (@anderseknert)
• e952896: Use inviter for Slack link (@anderseknert)
• 0c78e67: Add brew config back (@charlieegan3)
• 8091b9a: Merge pull request #121 from StyraInc/inviter-link (@charlieegan3)
• b417470: Merge pull request #122 from StyraInc/brew (@charlieegan3)

v0.0.0-alpha2

Changelog

• 5c5650f: Drop brews config for now (@charlieegan3)
• e364bef: Merge pull request #111 from StyraInc/drop-brews (@charlieegan3)

v0.0.0-alpha1

Changelog

• c60ea1d: Add := for assignment check in map generating rules (@anderseknert)
• 4381af6: Add rule on reference to input or data in fn body (@anderseknert)
• 06220e6: Rule: future keywords wildcard import (@anderseknert)
• 535e8a1: Prefer snake_case in rule names (@anderseknert)
• 6cbf9d2: Remove scope from output (@anderseknert)
• 440c1f7: Merge pull request #10 from StyraInc/more-rules (@anderseknert)
• 305443a: Expand snake_case check (@anderseknert)
• 9820fa8: Merge pull request #12 from StyraInc/snake_case (@anderseknert)
• 2c83dd3: * Add rule for importing input (@anderseknert)
• e52fbeb: Merge pull request #14 from StyraInc/even-more-rules (@anderseknert)
• 79ec2f9: Two more rules (@anderseknert)
• 0ba15f9: Merge pull request #15 from StyraInc/rules-rule (@anderseknert)
• 6329be8: Rule name shadows built-in function (@anderseknert)
• ad5b25f: Merge pull request #16 from StyraInc/rule-shadows-builtin (@anderseknert)
• 88a7da6: Create simple executable (@anderseknert)
• bcf81d9: Merge pull request #23 from StyraInc/executable (@anderseknert)
• 9d1c55e: Bump golang.org/x/net from 0.5.0 to 0.7.0 (@dependabot[bot])
• 3b7def4: Merge pull request #28 from StyraInc/dependabot/go_modules/golang.org/x/net-0.7.0 (@anderseknert)
• 4ce44ed: Add simple CI build (@anderseknert)
• a4aada1: Merge pull request #31 from StyraInc/github-actions-build (@anderseknert)
• 18063fb: Allow linting directories (@anderseknert)
• 14b77f8: Merge pull request #33 from StyraInc/lint-dirs (@anderseknert)
• 123fbc3: First stab at configuration (@anderseknert)
• e3b6771: Merge pull request #37 from StyraInc/config-first-stab (@anderseknert)
• e6dbd77: Bump github.com/open-policy-agent/opa from 0.49.2 to 0.50.0 (@dependabot[bot])
• ee75578: Merge pull request #41 from StyraInc/dependabot/go_modules/github.com/open-policy-agent/opa-0.50.0 (@anderseknert)
• 14abd2b: Bump actions/setup-go from 3 to 4 (@dependabot[bot])
• 25e7f8b: Bump github.com/open-policy-agent/opa from 0.50.0 to 0.50.1 (@dependabot[bot])
• 85c24ac: Merge pull request #44 from StyraInc/dependabot/go_modules/github.com/open-policy-agent/opa-0.50.1 (@anderseknert)
• f77cf1f: Merge pull request #43 from StyraInc/dependabot/github_actions/actions/setup-go-4 (@anderseknert)
• 33eac55: Add user configuration capabilities (@anderseknert)
• 1ba3fcf: Merge pull request #45 from StyraInc/user-config (@anderseknert)
• ce73b6b: Linter fixes: godot (@anderseknert)
• fc54394: Linter fixes: wsl (@anderseknert)
• dacc629: Linter fixes: various (@anderseknert)
• b9aaae8: Linter fixes: gci (@anderseknert)
• e98b1ea: Linter fixes: gofump (@anderseknert)
• 657ec22: Linter fixes: the rest (@anderseknert)
• 6f868f9: Merge pull request #47 from StyraInc/golangci-lint (@anderseknert)
• 0fa86e1: Add lint command and timeout flag (@anderseknert)
• 5ac3ea7: Add --config-file option (@anderseknert)
• fc19c8b: Merge pull request #50 from StyraInc/timeout (@anderseknert)
• a17cabb: Merge pull request #54 from StyraInc/config-next-stab (@anderseknert)
• cfb8805: Bump github.com/open-policy-agent/opa from 0.50.1 to 0.50.2 (@dependabot[bot])
• 1a45334: Merge pull request #55 from StyraInc/dependabot/go_modules/github.com/open-policy-agent/opa-0.50.2 (@anderseknert)
• ac26d4e: Allow custom rules (@anderseknert)
• 9e41d1d: Merge pull request #56 from StyraInc/custom-rules (@anderseknert)
• 39d8d3b: chore: bump OPA deps (#57) (@anderseknert)
• dadec06: Include location (#58) (@anderseknert)
• d0ccfbf: Add opa-fmt rule (#62) (@anderseknert)
• cf94bd2: Reject any refs in function body not found in args (#63) (@anderseknert)
• 999863a: Add reporter interface and implementations (#64) (@anderseknert)
• 70de700: Add parsing of ignore directives (#67) (@anderseknert)
• 596eace: Add ast.find_vars utility function (#69) (@anderseknert)
• 537dc9a: Delete mistakenly commited file (@anderseknert)
• 4b2d671: Linter, lint thyself! (#70) (@anderseknert)
• 50670d2: Bump github.com/open-policy-agent/opa from 0.50.2 to 0.51.0 (#72) (@dependabot[bot])
• 35df6c9: Fixes (#73) (@anderseknert)
• 71132e3: Bump github.com/spf13/cobra from 1.6.1 to 1.7.0 (#74) (@dependabot[bot])
• 57ff636: Add community section to README (#84) (@anderseknert)
• 53b584b: Find vars in more locations (#75) (@anderseknert)
• 780c1dc: Add import shadowing rule (#76) (@anderseknert)
• 7fffd8e: Use in for membership checks (#77) (@anderseknert)
• 994bbb3: Warn on identically named tests (#78) (@anderseknert)
• 861b252: Rule: line-length (#80) (@anderseknert)
• 54e8813: Add regal parse command (#81) (@anderseknert)
• 3c6ee58: Extend "in" check to any datatype (#87) (@anderseknert)
• 3f5b6a8: Reporter improvements (#88) (@anderseknert)
• 3705a30: Fix merge mishap (#90) (@anderseknert)
• d2753f9: Add command for generating markdown table from rule annotations (#89) (@anderseknert)
• 29e93fd: Various fixes (#91) (@anderseknert)
• e917c1e: Add bugs category, and two new rules (#96) (@anderseknert)
• e1cdcde: Add regal test command (#98) (@anderseknert)
• 428cf7a: Bump dependencies (#99) (@anderseknert)
• ed87abf: Use exit code 1 on violations (#101) (@anderseknert)
• 50de8ac: Add rule severity of warning (#104) (@anderseknert)
• 82678fb: Add docs for use-assignment-operator (#100) (@anderseknert)
• 4c0b0ca: More docs (#105) (@anderseknert)
• b8e3442: Parameterize docs base URL (#106) (@anderseknert)
• a2038c6: Add docs for rules on imports (#107) (@anderseknert)
• 83a7c28: Add docs for rules and style category (#109) (@anderseknert)
• f5c3f48: Add docs for 'testing' and 'variables' category (#110) (@anderseknert)
• 8d56110: Add goreleaser functionality (#108) (@charlieegan3)