ContextQMD
Back to Opa

no-whitespace-comment

docs/projects/regal/rules/style/no-whitespace-comment.md

1.16.11.1 KB
Original Source

no-whitespace-comment

Summary: Comment should start with whitespace

Category: Style

Automatically fixable: Yes

Avoid

rego
package policy

#Deny by default
default allow := false

#Allow only admins
allow if "admin" in input.user.roles

Prefer

rego
package policy

# Deny by default
default allow := false

# Allow only admins
allow if "admin" in input.user.roles

Rationale

Comments should be preceded by a single space, as this makes them easier to read.

Configuration Options

This linter rule provides the following configuration options:

yaml
rules:
  style:
    no-whitespace-comment:
      # one of "error", "warning", "ignore"
      level: error
      # optional pattern to except from this rule
      # this example would allow comments like "#--"
      # use or (`|`) to separate multiple patterns
      except-pattern: "^--"