Skip to main content

messy-rule

Summary: Messy incremental rule

Category: Style

Avoid

package policy

allow if something

unrelated_rule if { # <--- this rule is breaking up allow
    # ...
}

allow if something_else # <--- should be with the first allow

Prefer

package policy

allow if something

allow if something_else

unrelated_rule if {
    # ...
}

Rationale​

In Rego, rules can can be formed of many 'rule heads', partial definitions covering specific cases which together make up the behaviour of the whole rule. Rules that are defined incrementally should have their definitions grouped together, as this makes the code easier to follow. While this is mostly a style preference, having incremental rules grouped also allows editors like VS Code to "know" that the rules belong together, allowing them to be smarter when displaying the symbols of a workspace.

Configuration Options​

This linter rule provides the following configuration options:

rules:
  style:
    messy-rule:
      # one of "error", "warning", "ignore"
      level: error