analyzer: Deprecate AbstractAnalysisRule.lintCodes

Work towards #50986

Change-Id: I4c86dbf806964c98f4a1c5854eb53c6c8cfe002b
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/428624
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: srawlins

pkg/analysis_server/tool/presubmit/verify_error_fix_status.dart

@@ -52,7 +52,7 @@ String? verifyErrorFixStatus() {
   registerLintRules();
   registerBuiltInFixGenerators();
   var lintRuleCodes = {
-    for (var rule in Registry.ruleRegistry.rules) ...rule.lintCodes,
+    for (var rule in Registry.ruleRegistry.rules) ...rule.diagnosticCodes,
   };
   var lintRuleNames = {for (var lintCode in lintRuleCodes) lintCode.uniqueName};
 

pkg/analysis_server_plugin/lib/src/plugin_server.dart

@@ -364,7 +364,7 @@ class PluginServer {
         // `benchhmark.dart` script does.
         rule.registerNodeProcessors(nodeRegistry, context);
       }
-      for (var code in rules.expand((r) => r.lintCodes)) {
+      for (var code in rules.expand((r) => r.diagnosticCodes)) {
         var existingPlugin = pluginCodeMapping[code.name];
         if (existingPlugin == null) {
           pluginCodeMapping[code.name] = configuration.name;

pkg/analyzer/lib/src/lint/linter.dart

@@ -55,14 +55,14 @@ sealed class AbstractAnalysisRule {
   bool get canUseParsedResult => false;
 
   /// The diagnostic codes associated with this analysis rule.
-  List<DiagnosticCode> get diagnosticCodes => lintCodes;
+  List<DiagnosticCode> get diagnosticCodes;
 
   /// A list of incompatible rule ids.
   List<String> get incompatibleRules => const [];
 
   /// The lint codes associated with this analysis rule.
-  // TODO(srawlins): Deprecate this in favor of `diagnosticCodes`.
-  List<LintCode> get lintCodes;
+  @Deprecated("Use 'diagnosticCodes' instead.")
+  List<DiagnosticCode> get lintCodes => diagnosticCodes;
 
   /// Returns a visitor that visits a [Pubspec] to perform analysis.
   ///
@@ -164,13 +164,13 @@ abstract class AnalysisRule extends AbstractAnalysisRule {
   /// The code to report for a violation.
   DiagnosticCode get diagnosticCode => lintCode;
 
+  @override
+  List<DiagnosticCode> get diagnosticCodes => [lintCode];
+
   /// The code to report for a violation.
   // TODO(srawlins): Deprecate this in favor of `diagnosticCode`.
   LintCode get lintCode;
 
-  @override
-  List<LintCode> get lintCodes => [lintCode];
-
   /// Reports a diagnostic at [node] with message [arguments] and
   /// [contextMessages].
   void reportAtNode(

pkg/analyzer/lib/src/lint/registry.dart

@@ -68,32 +68,32 @@ class Registry with IterableMixin<AbstractAnalysisRule> {
   /// Adds the given lint [rule] to this registry.
   void registerLintRule(AbstractAnalysisRule rule) {
     _lintRules[rule.name] = rule;
-    for (var lintCode in rule.lintCodes) {
-      _codeMap[lintCode.uniqueName] = lintCode;
+    for (var code in rule.diagnosticCodes) {
+      _codeMap[code.uniqueName] = code as LintCode;
     }
   }
 
   /// Adds the given warning [rule] to this registry.
   void registerWarningRule(AbstractAnalysisRule rule) {
     _warningRules[rule.name] = rule;
-    for (var lintCode in rule.lintCodes) {
-      _codeMap[lintCode.uniqueName] = lintCode;
+    for (var code in rule.diagnosticCodes) {
+      _codeMap[code.uniqueName] = code as LintCode;
     }
   }
 
   /// Removes the given lint [rule] from this registry.
   void unregisterLintRule(AbstractAnalysisRule rule) {
     _lintRules.remove(rule.name);
-    for (var lintCode in rule.lintCodes) {
-      _codeMap.remove(lintCode.uniqueName);
+    for (var code in rule.diagnosticCodes) {
+      _codeMap.remove(code.uniqueName);
     }
   }
 
   /// Removes the given warning [rule] from this registry.
   void unregisterWarningRule(AbstractAnalysisRule rule) {
     _warningRules.remove(rule.name);
-    for (var lintCode in rule.lintCodes) {
-      _codeMap.remove(lintCode.uniqueName);
+    for (var code in rule.diagnosticCodes) {
+      _codeMap.remove(code.uniqueName);
     }
   }
 }

pkg/analyzer/test/src/lint/lint_rule_test.dart

@@ -133,7 +133,7 @@ class TestRule extends MultiAnalysisRule {
   TestRule() : super(name: 'test_rule', description: '');
 
   @override
-  List<LintCode> get lintCodes => [code, customCode];
+  List<DiagnosticCode> get diagnosticCodes => [code, customCode];
 }
 
 class _MockSource implements Source {

pkg/linter/lib/src/rules/always_declare_return_types.dart

@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:analyzer/error/error.dart';
 
 import '../analyzer.dart';
 import '../extensions.dart';
@@ -16,7 +17,7 @@ class AlwaysDeclareReturnTypes extends MultiAnalysisRule {
     : super(name: LintNames.always_declare_return_types, description: _desc);
 
   @override
-  List<LintCode> get lintCodes => [
+  List<DiagnosticCode> get diagnosticCodes => [
     LinterLintCode.always_declare_return_types_of_functions,
     LinterLintCode.always_declare_return_types_of_methods,
   ];

pkg/linter/lib/src/rules/always_specify_types.dart

@@ -18,6 +18,14 @@ class AlwaysSpecifyTypes extends MultiAnalysisRule {
   AlwaysSpecifyTypes()
     : super(name: LintNames.always_specify_types, description: _desc);
 
+  @override
+  List<DiagnosticCode> get diagnosticCodes => [
+    LinterLintCode.always_specify_types_add_type,
+    LinterLintCode.always_specify_types_replace_keyword,
+    LinterLintCode.always_specify_types_specify_type,
+    LinterLintCode.always_specify_types_split_to_types,
+  ];
+
   @override
   List<String> get incompatibleRules => const [
     LintNames.avoid_types_on_closure_parameters,
@@ -26,14 +34,6 @@ class AlwaysSpecifyTypes extends MultiAnalysisRule {
     LintNames.omit_obvious_property_types,
   ];
 
-  @override
-  List<LintCode> get lintCodes => [
-    LinterLintCode.always_specify_types_add_type,
-    LinterLintCode.always_specify_types_replace_keyword,
-    LinterLintCode.always_specify_types_specify_type,
-    LinterLintCode.always_specify_types_split_to_types,
-  ];
-
   @override
   void registerNodeProcessors(
     NodeLintRegistry registry,

pkg/linter/lib/src/rules/analyzer_public_api.dart

@@ -7,6 +7,7 @@ import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/constant/value.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:analyzer/error/error.dart';
 
 import '../analyzer.dart';
 
@@ -89,7 +90,7 @@ class AnalyzerPublicApi extends MultiAnalysisRule {
     : super(name: ruleName, description: _desc, state: const State.internal());
 
   @override
-  List<LintCode> get lintCodes => [
+  List<DiagnosticCode> get diagnosticCodes => [
     badPartDirective,
     badType,
     exportsNonPublicName,

pkg/linter/lib/src/rules/avoid_catching_errors.dart

@@ -4,6 +4,7 @@
 
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:analyzer/error/error.dart';
 
 import '../analyzer.dart';
 import '../extensions.dart';
@@ -15,7 +16,7 @@ class AvoidCatchingErrors extends MultiAnalysisRule {
     : super(name: LintNames.avoid_catching_errors, description: _desc);
 
   @override
-  List<LintCode> get lintCodes => [
+  List<DiagnosticCode> get diagnosticCodes => [
     LinterLintCode.avoid_catching_errors_class,
     LinterLintCode.avoid_catching_errors_subclass,
   ];

pkg/linter/lib/src/rules/avoid_returning_null_for_void.dart

@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:analyzer/error/error.dart';
 
 import '../analyzer.dart';
 
@@ -15,7 +16,7 @@ class AvoidReturningNullForVoid extends MultiAnalysisRule {
     : super(name: LintNames.avoid_returning_null_for_void, description: _desc);
 
   @override
-  List<LintCode> get lintCodes => [
+  List<DiagnosticCode> get diagnosticCodes => [
     LinterLintCode.avoid_returning_null_for_void_from_function,
     LinterLintCode.avoid_returning_null_for_void_from_method,
   ];