provide_deprecation_message

Provide a deprecation message, via @Deprecated(“message”).

This rule is available as of Dart 2.2.0.

Rule sets: core, recommended, flutter

Details

DO specify a deprecation message (with migration instructions and/or a removal schedule) in the Deprecation constructor.

BAD:

@deprecated
void oldFunction(arg1, arg2) {}

GOOD:

@Deprecated("""
[oldFunction] is being deprecated in favor of [newFunction] (with slightly
different parameters; see [newFunction] for more information). [oldFunction]
will be removed on or after the 4.0.0 release.
""")
void oldFunction(arg1, arg2) {}

Usage

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

linter:
  rules:
    - provide_deprecation_message