flutter_style_todos

Use Flutter TODO format: // TODO(username): message, https://URL-to-issue.

DO use Flutter TODO format.

From the Flutter docs:

TODOs should include the string TODO in all caps, followed by the GitHub username of the person with the best context about the problem referenced by the TODO in parenthesis. A TODO is not a commitment that the person referenced will fix the problem, it is intended to be the person with enough context to explain the problem. Thus, when you create a TODO, it is almost always your username that is given.

GOOD:

// TODO(username): message.
// TODO(username): message, https://URL-to-issue.

To enable the flutter_style_todos rule, add flutter_style_todos under linter > rules in your analysis_options.yaml file:

linter:
  rules:
    - flutter_style_todos

If you're instead using the YAML map syntax to configure linter rules, add flutter_style_todos: true under linter > rules:

linter:
  rules:
    flutter_style_todos: true

Unless stated otherwise, the documentation on this site reflects Dart 3.6.0. Page last updated on 2025-01-27. View source or report an issue.