ContextQMD
Back to Opa

yoda-condition

docs/projects/regal/rules/style/yoda-condition.md

1.16.11.0 KB
Original Source

yoda-condition

Summary: Yoda condition, it is

Category: Style

Avoid

rego
package policy

allow if {
    "GET" == input.request.method
    "users" == input.request.path[0]
}

Prefer

rego
package policy

allow if {
    input.request.method == "GET"
    input.request.path[0] == "users"
}

Rationale

Yoda conditions — expressions where the constant portion of a comparison is placed on the left-hand side of the comparison — provide no benefits in Rego. They do however add a certain amount of cognitive overhead for most policy authors in the galaxy.

Configuration Options

This linter rule provides the following configuration options:

yaml
rules:
  style:
    yoda-condition:
      # one of "error", "warning", "ignore"
      level: error