Skip to main content

internal-entrypoint

Summary: Entrypoint can't be marked internal

Category: Bugs

Avoid

package policy

import rego.v1

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

Prefer

package policy

import rego.v1

# 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

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!