Skip to main content

prefer-date-format

added in: 1.7.0
warning
⚙️🛠

Warns when DateTime, values are formatted with toString instead of DateFormat.format().

⚙️ Config​

Set ignored-invocations (default is none) to ignore toString calls inside a specific invocation.

dart_code_metrics:
  ...
  rules:
    ...
    - prefer-date-format:
        ignored-invocations:
           - someInvocation

Example​

❌ Bad:

void main() {
  final DateTime dateTimeValue = DateTime.now();

  final dateTimeString = dateTimeValue.toString(); // LINT
  final dateTimeString = '$dateTimeValue'; // LINT
}

✅ Good:

void main() {
  final DateTime dateTimeValue = DateTime.now();

  final dateTimeString = DateFormat().format(dateTimeValue);
  final dateTimeString = '${DateFormat().format(dateTimeValue)}';
}