internal-entrypoint

Summary: Entrypoint can't be marked internal

Category: Bugs

Avoid

package policy

# METADATA
# entrypoint: true
_authorized if {
    # some conditions
}

Prefer

package policy

# METADATA
# entrypoint: true
allow if _authorized

_authorized if {
    # some conditions
}

Rationale

Rules marked as internal using the underscore prefix convention cannot be used as entrypoints, as entrypoints by definition are public. Either rename the rule to mark it as public, or use another public rule as an entrypoint, which may reference the internal rule.

Configuration Options

This linter rule provides the following configuration options:

rules:
  bugs:
    internal-entrypoint:
      # one of "error", "warning", "ignore"
      level: error

Related Resources

• Rego Style Guide: Optionally, use leading underscore for rules intended for internal use
• Regal Docs: no-defined-entrypoint
• GitHub: Source Code