lib/src/rules/prefer_equal_for_default_values.dart

// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import '../analyzer.dart';

const _desc = r'Use `=` to separate a named parameter from its default value.';

const _details = r'''
**DEPRECATED:** In Dart 2.19, 
the Dart analyzer reports the old `:` syntax as a warning
and will report it as an error in Dart 3.0.
As a result, this rule is unmaintained 
and will be removed in a future Linter release.

From the [style guide](https://dart.dev/guides/language/effective-dart/usage):

**DO** use `=` to separate a named parameter from its default value.

**BAD:**
```dart
m({a: 1})
```

**GOOD:**
```dart
m({a = 1})
```
''';

class PreferEqualForDefaultValues extends LintRule {
  static const LintCode code = LintCode('prefer_equal_for_default_values',
      "Default values should be introduced by '=' rather than ':'.",
      correctionMessage: "Try using '=' to introduce the default value.");

  PreferEqualForDefaultValues()
      : super(
            name: 'prefer_equal_for_default_values',
            description: _desc,
            details: _details,
            maturity: Maturity.deprecated,
            group: Group.style);

  @override
  LintCode get lintCode => code;

  // As of 2.19, this is a warning so we don't want to double-report and so
  // we don't register any processors.
}