Contents
Contents

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

This rule is available as of Dart 2.1.0.

This rule has a quick fix available.

Details

#

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:

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

Usage

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - flutter_style_todos