Skip to main content

trailing-default-rule

Summary: Default rule should be declared first

Category: Style

Avoid

package policy

import rego.v1

allow if {
    # some conditions
}

default allow := false

Prefer

package policy

import rego.v1

default allow := false

allow if {
    # some conditions
}

Rationale​

Presenting the default value of a rule (if one is used) before the conditional rule assignments is a common practice, and it's often easier to to reason about conditional assignments knowing there is a default fallback value in place. For that reason, it's recommended to follow the convention and place the default rule declaration before rules conditionally assigning values.

Configuration Options​

This linter rule provides the following configuration options:

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

Community​

If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules, or just talk about Regal in general, please join us in the #regal channel in the Styra Community Slack!