Skip to main content

unresolved-reference

Summary: Unresolved Reference

Category: Imports

Avoid References to unresolved packages and rules.

Rationale​

This rule is similar to unresolved-import rule and has the same rationale: to avoid accidentally referencing rules and data that does not exist. As the name suggests, this rule is stricter than the unresolved-import rule, and will check for references to packages and rules that may not exist throughout the entire policy, rather than just the imports.

This rule will have Regal try to resolve all references to external packages and rules by scanning all the policies it is provided for packages, rules and functions that may resolve the reference. Note that Regal does not scan any data files. If no reference is found, the rule will flag it as unresolved.

Configuration Options​

This linter rule provides the following configuration options:

rules:
  imports:
    unresolved-reference:
      # one of "error", "warning", "ignore"
      level: error
      # list of paths that should be ignored
      # these may be paths to data, or rules that may
      # not be present at the time of linting
      # using glob syntax
      except-paths:
        - data.identity.users
        - data.permissions.*

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!