analyzer: Deprecate ErrorCode in favor of replacement: DiagnosticCode

Work towards #60635

Change-Id: I0cfc0bff4e5d10b7cb373f77de55fffc13b8cf76
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/426641
Reviewed-by: Paul Berry <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>

Author: srawlins

pkg/_fe_analyzer_shared/lib/src/base/errors.dart

@@ -13,7 +13,8 @@ import 'customized_codes.dart';
 /// Generally, messages should follow the [Guide for Writing
 /// Diagnostics](https://github.com/dart-lang/sdk/blob/main/pkg/front_end/lib/src/base/diagnostics.md).
 @AnalyzerPublicApi(message: 'exported by package:analyzer/error/error.dart')
-typedef DiagnosticCode = ErrorCode;
+@Deprecated("Use 'DiagnosticCode' instead.")
+typedef ErrorCode = DiagnosticCode;
 
 /// An error code associated with an `AnalysisError`.
 ///
@@ -23,7 +24,7 @@ typedef DiagnosticCode = ErrorCode;
 /// Note that this class name, `ErrorCode`, is soft-deprecated in favor of the
 /// type alias, `DiagnosticCode`.
 @AnalyzerPublicApi(message: 'exported by package:analyzer/error/error.dart')
-abstract class ErrorCode {
+abstract class DiagnosticCode {
   /// Regular expression for identifying positional arguments in error messages.
   static final RegExp _positionalArgumentRegExp = new RegExp(r'{(\d+)\}');
 
@@ -58,7 +59,7 @@ abstract class ErrorCode {
    * template. The correction associated with the error will be created from the
    * given [correctionMessage] template.
    */
-  const ErrorCode({
+  const DiagnosticCode({
     String? correctionMessage,
     this.hasPublishedDocs = false,
     this.isUnresolvedIdentifier = false,
@@ -133,7 +134,7 @@ abstract class ErrorCode {
 typedef ErrorSeverity = DiagnosticSeverity;
 
 /**
- * The severity of an [ErrorCode].
+ * The severity of an [DiagnosticCode].
  *
  * Note that this class name, `ErrorSeverity`, is soft-deprecated in favor of
  * the type alias, [DiagnosticSeverity].

pkg/_fe_analyzer_shared/lib/src/scanner/errors.dart

@@ -121,7 +121,7 @@ typedef ReportError(
 /**
  * The error codes used for errors detected by the scanner.
  */
-class ScannerErrorCode extends ErrorCode {
+class ScannerErrorCode extends DiagnosticCode {
   /**
    * Parameters:
    * 0: the token that was expected but not found

pkg/analyzer/CHANGELOG.md

@@ -8,8 +8,9 @@
 * Deprecate `XyzElement2` classes; use `XyzElement` instead.
 * Deprecate `AnalysisError.correction` field; use
   `AnalysisError.correctionMessage` instead.
-* Deprecate `ErrorType`; use `DiagnosticType` instead.
+* Deprecate `ErrorCode`; use `DiagnosticCode` instead.
 * Deprecate `ErrorSeverity`; use `DiagnosticSeverity` instead.
+* Deprecate `ErrorType`; use `DiagnosticType` instead.
 * Change `ElementDirective` from `sealed` to `abstract`.
   This allows the analyzer to have an internal implementation
   class corresponding to `ElementDirective`.

pkg/analyzer/api.txt

@@ -4330,13 +4330,13 @@ package:analyzer/dart/sdk/build_sdk_summary.dart:
   buildSdkSummary (function: Future<Uint8List> Function({String? embedderYamlPath, required ResourceProvider resourceProvider, required String sdkPath}))
 package:analyzer/diagnostic/diagnostic.dart:
   Diagnostic (class extends Object):
-    forValues (constructor: Diagnostic Function({List<DiagnosticMessage> contextMessages, String? correctionMessage, Object? data, required ErrorCode errorCode, required int length, required String message, required int offset, required Source source}))
-    tmp (constructor: Diagnostic Function({List<Object?> arguments, List<DiagnosticMessage> contextMessages, Object? data, required ErrorCode errorCode, required int length, required int offset, required Source source}))
+    forValues (constructor: Diagnostic Function({List<DiagnosticMessage> contextMessages, String? correctionMessage, Object? data, required DiagnosticCode errorCode, required int length, required String message, required int offset, required Source source}))
+    tmp (constructor: Diagnostic Function({List<Object?> arguments, List<DiagnosticMessage> contextMessages, Object? data, required DiagnosticCode errorCode, required int length, required int offset, required Source source}))
     contextMessages (getter: List<DiagnosticMessage>)
     correction (getter: String?, deprecated)
     correctionMessage (getter: String?)
     data (getter: Object?)
-    errorCode (getter: ErrorCode)
+    errorCode (getter: DiagnosticCode)
     hashCode (getter: int)
     length (getter: int)
     message (getter: String)
@@ -4359,8 +4359,22 @@ package:analyzer/diagnostic/diagnostic.dart:
     values (static getter: List<Severity>)
     warning (static getter: Severity)
 package:analyzer/error/error.dart:
-  errorCodeValues (static getter: List<ErrorCode>)
-  errorCodeByUniqueName (function: ErrorCode? Function(String))
+  errorCodeValues (static getter: List<DiagnosticCode>)
+  errorCodeByUniqueName (function: DiagnosticCode? Function(String))
+  DiagnosticCode (class extends Object):
+    new (constructor: DiagnosticCode Function({String? correctionMessage, bool hasPublishedDocs, bool isUnresolvedIdentifier, required String name, required String problemMessage, required String uniqueName}))
+    correctionMessage (getter: String?)
+    errorSeverity (getter: DiagnosticSeverity)
+    hasPublishedDocs (getter: bool)
+    isIgnorable (getter: bool)
+    isUnresolvedIdentifier (getter: bool)
+    name (getter: String)
+    numParameters (getter: int)
+    problemMessage (getter: String)
+    type (getter: DiagnosticType)
+    uniqueName (getter: String)
+    url (getter: String?)
+    toString (method: String Function())
   DiagnosticSeverity (class extends Object implements Comparable<DiagnosticSeverity>):
     ERROR (static getter: DiagnosticSeverity)
     INFO (static getter: DiagnosticSeverity)
@@ -4393,29 +4407,15 @@ package:analyzer/error/error.dart:
     severity (getter: DiagnosticSeverity)
     compareTo (method: int Function(DiagnosticType))
     toString (method: String Function())
-  ErrorCode (class extends Object):
-    new (constructor: ErrorCode Function({String? correctionMessage, bool hasPublishedDocs, bool isUnresolvedIdentifier, required String name, required String problemMessage, required String uniqueName}))
-    correctionMessage (getter: String?)
-    errorSeverity (getter: DiagnosticSeverity)
-    hasPublishedDocs (getter: bool)
-    isIgnorable (getter: bool)
-    isUnresolvedIdentifier (getter: bool)
-    name (getter: String)
-    numParameters (getter: int)
-    problemMessage (getter: String)
-    type (getter: DiagnosticType)
-    uniqueName (getter: String)
-    url (getter: String?)
-    toString (method: String Function())
-  LintCode (class extends ErrorCode):
+  LintCode (class extends DiagnosticCode):
     new (constructor: LintCode Function(String, String, {String? correctionMessage, bool hasPublishedDocs, String? uniqueName}))
     errorSeverity (getter: DiagnosticSeverity)
     hashCode (getter: int)
     type (getter: DiagnosticType)
     url (getter: String?)
     == (method: bool Function(Object))
   AnalysisError (type alias for Diagnostic)
-  DiagnosticCode (type alias for ErrorCode)
+  ErrorCode (type alias for DiagnosticCode, deprecated)
   ErrorSeverity (type alias for DiagnosticSeverity, deprecated)
   ErrorType (type alias for DiagnosticType, deprecated)
 package:analyzer/error/listener.dart:
@@ -4432,13 +4432,13 @@ package:analyzer/error/listener.dart:
     lockLevel (getter: int)
     lockLevel= (setter: int)
     source (getter: Source)
-    atConstructorDeclaration (method: void Function(ConstructorDeclaration, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
-    atElement2 (method: void Function(Element, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}), experimental)
-    atEntity (method: void Function(SyntacticEntity, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
-    atNode (method: void Function(AstNode, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
-    atOffset (method: void Function({List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data, required ErrorCode errorCode, required int length, required int offset}))
-    atSourceSpan (method: void Function(SourceSpan, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
-    atToken (method: void Function(Token, ErrorCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
+    atConstructorDeclaration (method: void Function(ConstructorDeclaration, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
+    atElement2 (method: void Function(Element, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}), experimental)
+    atEntity (method: void Function(SyntacticEntity, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
+    atNode (method: void Function(AstNode, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
+    atOffset (method: void Function({List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data, required DiagnosticCode errorCode, required int length, required int offset}))
+    atSourceSpan (method: void Function(SourceSpan, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
+    atToken (method: void Function(Token, DiagnosticCode, {List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data}))
     reportError (method: void Function(Diagnostic))
   RecordingErrorListener (class extends Object implements AnalysisErrorListener):
     new (constructor: RecordingErrorListener Function())

pkg/analyzer/lib/diagnostic/diagnostic.dart

@@ -65,7 +65,8 @@ class Diagnostic {
     required Source source,
     required int offset,
     required int length,
-    required ErrorCode errorCode,
+    // TODO(srawlins): Rename to `diagnosticCode`.
+    required DiagnosticCode errorCode,
     List<Object?> arguments = const [],
     List<DiagnosticMessage> contextMessages = const [],
     Object? data,

pkg/analyzer/lib/error/error.dart

@@ -16,17 +16,19 @@ export 'package:_fe_analyzer_shared/src/base/errors.dart'
         DiagnosticCode,
         DiagnosticSeverity,
         DiagnosticType,
+        // Continue exporting the deprecated element until it is removed.
+        // ignore: deprecated_member_use
         ErrorCode,
-        // Continue exporting the deleted element until it is removed.
+        // Continue exporting the deprecated element until it is removed.
         // ignore: deprecated_member_use
         ErrorSeverity,
-        // Continue exporting the deleted element until it is removed.
+        // Continue exporting the deprecated element until it is removed.
         // ignore: deprecated_member_use
         ErrorType;
 export 'package:analyzer/src/dart/error/lint_codes.dart' show LintCode;
 export 'package:analyzer/src/error/error_code_values.g.dart';
 
-/// The lazy initialized map from [ErrorCode.uniqueName] to the
+/// The lazy initialized map from [DiagnosticCode.uniqueName] to the
 /// [DiagnosticCode] instance.
 final HashMap<String, DiagnosticCode> _uniqueNameToCodeMap =
     _computeUniqueNameToCodeMap();
@@ -37,8 +39,8 @@ DiagnosticCode? errorCodeByUniqueName(String uniqueName) {
   return _uniqueNameToCodeMap[uniqueName];
 }
 
-/// Return the map from [ErrorCode.uniqueName] to the [DiagnosticCode] instance
-/// for all [errorCodeValues].
+/// Return the map from [DiagnosticCode.uniqueName] to the [DiagnosticCode]
+/// instance for all [errorCodeValues].
 HashMap<String, DiagnosticCode> _computeUniqueNameToCodeMap() {
   var result = HashMap<String, DiagnosticCode>();
   for (DiagnosticCode diagnosticCode in errorCodeValues) {

pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart

@@ -20,7 +20,7 @@ library;
 
 import "package:analyzer/error/error.dart";
 
-class AnalysisOptionsErrorCode extends ErrorCode {
+class AnalysisOptionsErrorCode extends DiagnosticCode {
   ///  An error code indicating that there is a syntactic error in the included
   ///  file.
   ///
@@ -65,7 +65,7 @@ class AnalysisOptionsErrorCode extends ErrorCode {
   DiagnosticType get type => DiagnosticType.COMPILE_TIME_ERROR;
 }
 
-class AnalysisOptionsWarningCode extends ErrorCode {
+class AnalysisOptionsWarningCode extends DiagnosticCode {
   ///  An error code indicating that the given option is deprecated.
   ///
   ///  Parameters:

pkg/analyzer/lib/src/dart/error/ffi_code.g.dart

@@ -20,7 +20,7 @@ library;
 
 import "package:analyzer/error/error.dart";
 
-class FfiCode extends ErrorCode {
+class FfiCode extends DiagnosticCode {
   ///  No parameters.
   static const FfiCode ABI_SPECIFIC_INTEGER_INVALID = FfiCode(
     'ABI_SPECIFIC_INTEGER_INVALID',

pkg/analyzer/lib/src/dart/error/hint_codes.g.dart

@@ -20,7 +20,7 @@ library;
 
 import "package:analyzer/error/error.dart";
 
-class HintCode extends ErrorCode {
+class HintCode extends DiagnosticCode {
   ///  No parameters.
   ///
   ///  Note: Since this diagnostic is only produced in pre-3.0 code, we do not

pkg/analyzer/lib/src/dart/error/lint_codes.dart

@@ -15,7 +15,7 @@ import 'package:analyzer/error/error.dart';
 /// unintended code, maintainability, style and other best practices that might
 /// be aggregated to define a project's style guide.
 @AnalyzerPublicApi(message: 'exported by lib/error/error.dart')
-class LintCode extends ErrorCode {
+class LintCode extends DiagnosticCode {
   const LintCode(
     String name,
     String problemMessage, {