Skip to main content

rule-name-repeats-package

Summary: Avoid repeating package path in rule names

Category: Style

Avoid

package policy.authz

import rego.v1

authz_allow if {
    user.is_admin
}

Prefer

package policy.authz

import rego.v1

allow if {
    user.is_admin
}

Rationale​

When rules are referenced outside the package in which they are defined, they will be referenced using the package path. For example, the allow rule in the example package, is available at data.example.allow. When rule names include all or part of their package paths, this creates repetition in such references. For example, authz_allow in a package authz is referenced with: data.authz.authz_allow. This repetition is undesirable as the reference is longer than needed, and harder to read.

This rule was inspired by Go Code Review Comments.

Configuration Options​

This linter rule provides the following configuration options:

rules:
  style:
    rule-name-repeats-package:
      # 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!