avoid_positional_boolean_parameters

Avoid positional boolean parameters.

This rule is available as of Dart 2.0.

From Effective Dart:

AVOID positional boolean parameters.

Positional boolean parameters are a bad practice because they are very ambiguous. Using named boolean parameters is much more readable because it inherently describes what the boolean value represents.

BAD:

Task(true);
Task(false);
ListBox(false, true, true);
Button(false);

GOOD:

Task.oneShot();
Task.repeating();
ListBox(scroll: true, showScrollbars: true);
Button(ButtonState.enabled);

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

linter:
  rules:
    - avoid_positional_boolean_parameters

Unless stated otherwise, the documentation on this site reflects Dart 3.5.4. Page last updated on 2024-07-03. View source or report an issue.