Skip to main content

todo-comment

Summary: Avoid TODO Comments

Category: Style

Avoid

package policy

# TODO: implementation
allow := true

i := input.i + 1

# Fixme: surely there's a better way to do recursion
response := http.send({
    "url": "http://localhost:8080/v1/data/policy",
    "method": "POST",
    "body": {
        "input": {
            "i": i
        }
    }
})

Prefer

To fix the problem, or use an issue tracker to track it.

Rationale​

While TODO and FIXME comments are occasionally useful, they essentially provide a way to do issue tracking inside of the code rather than where issues belong — in your issue tracker.

Configuration Options​

This linter rule provides the following configuration options:

rules:
  style:
    todo-comment:
      # 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!