annotation-without-metadata

Summary: Annotation without metadata

Category: Bugs

Avoid

package policy

# description: allow allows
allow if {
    # ... some conditions
}

Prefer

package policy

# METADATA
# description: allow allows
allow if {
    # ... some conditions
}

Rationale

A comment that starts with <annotation-attribute>: but is not part of a metadata block is likely a mistake. Add # METADATA above the line to turn it into a metadata block.

Configuration Options

This linter rule provides the following configuration options:

rules:
  bugs:
    annotation-without-metadata:
      # one of "error", "warning", "ignore"
      level: error

Related Resources

• OPA Docs: Annotations
• GitHub: Source Code