analyzer: Rename 'errorCode' parameters in ErrorReporter

Work towards #60635

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

Author: srawlins

pkg/analysis_server/lib/src/services/correction/fix/data_driven/code_fragment_parser.dart

@@ -83,7 +83,7 @@ class CodeFragmentParser {
         errorReporter.atOffset(
           offset: token.offset + delta,
           length: token.length,
-          errorCode: TransformSetErrorCode.wrongToken,
+          diagnosticCode: TransformSetErrorCode.wrongToken,
           arguments: ['.', token.kind.displayName],
         );
         return null;
@@ -113,7 +113,7 @@ class CodeFragmentParser {
       errorReporter.atOffset(
         offset: token.offset + delta,
         length: token.length,
-        errorCode: TransformSetErrorCode.unexpectedToken,
+        diagnosticCode: TransformSetErrorCode.unexpectedToken,
         arguments: [token.kind.displayName],
       );
       return null;
@@ -151,7 +151,7 @@ class CodeFragmentParser {
       errorReporter.atOffset(
         offset: offset + delta,
         length: length,
-        errorCode: TransformSetErrorCode.missingToken,
+        diagnosticCode: TransformSetErrorCode.missingToken,
         arguments: [validKindsDisplayString()],
       );
       return null;
@@ -160,7 +160,7 @@ class CodeFragmentParser {
       errorReporter.atOffset(
         offset: token.offset + delta,
         length: token.length,
-        errorCode: TransformSetErrorCode.wrongToken,
+        diagnosticCode: TransformSetErrorCode.wrongToken,
         arguments: [validKindsDisplayString(), token.kind.displayName],
       );
       return null;
@@ -233,7 +233,7 @@ class CodeFragmentParser {
       errorReporter.atOffset(
         offset: token.offset + delta,
         length: token.length,
-        errorCode: TransformSetErrorCode.unknownAccessor,
+        diagnosticCode: TransformSetErrorCode.unknownAccessor,
         arguments: [identifier],
       );
       return null;
@@ -313,7 +313,7 @@ class CodeFragmentParser {
           errorReporter.atOffset(
             offset: token.offset + delta,
             length: token.length,
-            errorCode: TransformSetErrorCode.undefinedVariable,
+            diagnosticCode: TransformSetErrorCode.undefinedVariable,
             arguments: [variableName],
           );
           return null;
@@ -344,7 +344,7 @@ class CodeFragmentParser {
     errorReporter.atOffset(
       offset: offset,
       length: length,
-      errorCode: TransformSetErrorCode.expectedPrimary,
+      diagnosticCode: TransformSetErrorCode.expectedPrimary,
     );
     return null;
   }
@@ -471,7 +471,7 @@ class _CodeFragmentScanner {
     errorReporter.atOffset(
       offset: offset + delta,
       length: 1,
-      errorCode: TransformSetErrorCode.invalidCharacter,
+      diagnosticCode: TransformSetErrorCode.invalidCharacter,
       arguments: [content.substring(offset, offset + 1)],
     );
     return null;

pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_parser.dart

@@ -195,7 +195,7 @@ class TransformSetParser {
         errorReporter.atOffset(
           offset: templateOffset + variableStart,
           length: 2,
-          errorCode: TransformSetErrorCode.missingTemplateEnd,
+          diagnosticCode: TransformSetErrorCode.missingTemplateEnd,
         );
         // Ignore the invalid component, treating it as if it extended to the
         // end of the template.
@@ -207,7 +207,7 @@ class TransformSetParser {
           errorReporter.atOffset(
             offset: templateOffset + template.indexOf(name, variableStart),
             length: name.length,
-            errorCode: TransformSetErrorCode.undefinedVariable,
+            diagnosticCode: TransformSetErrorCode.undefinedVariable,
             arguments: [name],
           );
           // Ignore the invalid component.
@@ -261,7 +261,7 @@ class TransformSetParser {
       errorReporter.atOffset(
         offset: offset,
         length: length,
-        errorCode: TransformSetErrorCode.yamlSyntaxError,
+        diagnosticCode: TransformSetErrorCode.yamlSyntaxError,
         arguments: [e.message],
       );
     }
@@ -280,7 +280,7 @@ class TransformSetParser {
     errorReporter.atOffset(
       offset: span.start.offset,
       length: span.length,
-      errorCode: code,
+      diagnosticCode: code,
       arguments: arguments,
     );
   }

pkg/analyzer/CHANGELOG.md

@@ -32,6 +32,8 @@
 * Deprecate `InterfaceElement.constructors2`, use `constructors` instead.
 * Deprecate `InterfaceFragment.constructors2`, use `constructors` instead.
 * Deprecate `JoinPatternVariableElement.variables2`, use `variables` instead.
+* Deprecate `ErrorReporter.atOffset`'s `errorCode` parameter; use
+  `diagnosticCode` instead.
 
 ## 7.4.1
 * Restore `InstanceElement.augmented` getter.

pkg/analyzer/api.txt

@@ -4464,7 +4464,7 @@ package:analyzer/error/listener.dart:
     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}))
+    atOffset (method: void Function({List<Object>? arguments, List<DiagnosticMessage>? contextMessages, Object? data, DiagnosticCode? diagnosticCode, 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))

pkg/analyzer/lib/error/listener.dart

@@ -65,11 +65,12 @@ class ErrorReporter {
 
   Source get source => _source;
 
-  /// Report a diagnostic with the given [errorCode] and [arguments].
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
   /// The location of the diagnostic will be the name of the [node].
   void atConstructorDeclaration(
     ConstructorDeclaration node,
-    DiagnosticCode errorCode, {
+    DiagnosticCode diagnosticCode, {
     List<Object>? arguments,
     List<DiagnosticMessage>? contextMessages,
     Object? data,
@@ -82,27 +83,28 @@ class ErrorReporter {
       atOffset(
         offset: offset,
         length: nameToken.end - offset,
-        errorCode: errorCode,
+        diagnosticCode: diagnosticCode,
         arguments: arguments,
       );
     } else {
-      atNode(node.returnType, errorCode, arguments: arguments);
+      atNode(node.returnType, diagnosticCode, arguments: arguments);
     }
   }
 
-  /// Report an error with the given [diagnosticCode] and [arguments].
-  /// The [element] is used to compute the location of the error.
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
+  /// The [element] is used to compute the location of the diagnostic.
   @experimental
   void atElement2(
-    Element element2,
+    Element element,
     DiagnosticCode diagnosticCode, {
     List<Object>? arguments,
     List<DiagnosticMessage>? contextMessages,
     Object? data,
   }) {
-    var nonSynthetic = element2.nonSynthetic2;
+    var nonSynthetic = element.nonSynthetic2;
     atOffset(
-      errorCode: diagnosticCode,
+      diagnosticCode: diagnosticCode,
       offset: nonSynthetic.firstFragment.nameOffset2 ?? -1,
       length: nonSynthetic.name3?.length ?? 0,
       arguments: arguments,
@@ -111,17 +113,18 @@ class ErrorReporter {
     );
   }
 
-  /// Report an error with the given [errorCode] and [arguments].
-  /// The [entity] is used to compute the location of the error.
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
+  /// The [entity] is used to compute the location of the diagnostic.
   void atEntity(
     SyntacticEntity entity,
-    DiagnosticCode errorCode, {
+    DiagnosticCode diagnosticCode, {
     List<Object>? arguments,
     List<DiagnosticMessage>? contextMessages,
     Object? data,
   }) {
     atOffset(
-      errorCode: errorCode,
+      diagnosticCode: diagnosticCode,
       offset: entity.offset,
       length: entity.length,
       arguments: arguments,
@@ -130,8 +133,9 @@ class ErrorReporter {
     );
   }
 
-  /// Report an error with the given [diagnosticCode] and [arguments].
-  /// The [node] is used to compute the location of the error.
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
+  /// The [node] is used to compute the location of the diagnostic.
   void atNode(
     AstNode node,
     DiagnosticCode diagnosticCode, {
@@ -140,7 +144,7 @@ class ErrorReporter {
     Object? data,
   }) {
     atOffset(
-      errorCode: diagnosticCode,
+      diagnosticCode: diagnosticCode,
       offset: node.offset,
       length: node.length,
       arguments: arguments,
@@ -149,19 +153,31 @@ class ErrorReporter {
     );
   }
 
-  /// Report an error with the given [errorCode] and [arguments]. The location
-  /// of the error is specified by the given [offset] and [length].
+  /// Reports a diagnostic with the given [diagnosticCode] (or [errorCode],
+  /// deprecated) and [arguments].
+  ///
+  /// The location of the diagnostic is specified by the given [offset] and
+  /// [length].
   void atOffset({
     required int offset,
     required int length,
-    required DiagnosticCode errorCode,
+    @Deprecated("Use 'diagnosticCode' instead") DiagnosticCode? errorCode,
+    DiagnosticCode? diagnosticCode,
     List<Object>? arguments,
     List<DiagnosticMessage>? contextMessages,
     Object? data,
   }) {
     if (lockLevel != 0) {
       return;
     }
+    if ((errorCode == null && diagnosticCode == null) ||
+        (errorCode != null && diagnosticCode != null)) {
+      throw ArgumentError(
+        "Exactly one of 'errorCode' (deprecated) and 'diagnosticCode' should be given",
+      );
+    }
+
+    diagnosticCode ??= errorCode!;
 
     if (arguments != null) {
       var invalid =
@@ -186,25 +202,26 @@ class ErrorReporter {
         source: _source,
         offset: offset,
         length: length,
-        errorCode: errorCode,
+        errorCode: diagnosticCode,
         arguments: arguments ?? const [],
         contextMessages: contextMessages,
         data: data,
       ),
     );
   }
 
-  /// Report an error with the given [errorCode] and [arguments].
-  /// The [span] is used to compute the location of the error.
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
+  /// The [span] is used to compute the location of the diagnostic.
   void atSourceSpan(
     SourceSpan span,
-    DiagnosticCode errorCode, {
+    DiagnosticCode diagnosticCode, {
     List<Object>? arguments,
     List<DiagnosticMessage>? contextMessages,
     Object? data,
   }) {
     atOffset(
-      errorCode: errorCode,
+      diagnosticCode: diagnosticCode,
       offset: span.start.offset,
       length: span.length,
       arguments: arguments,
@@ -213,8 +230,9 @@ class ErrorReporter {
     );
   }
 
-  /// Report an error with the given [diagnosticCode] and [arguments]. The [token] is
-  /// used to compute the location of the error.
+  /// Reports a diagnostic with the given [diagnosticCode] and [arguments].
+  ///
+  /// The [token] is used to compute the location of the diagnostic.
   void atToken(
     Token token,
     DiagnosticCode diagnosticCode, {
@@ -223,7 +241,7 @@ class ErrorReporter {
     Object? data,
   }) {
     atOffset(
-      errorCode: diagnosticCode,
+      diagnosticCode: diagnosticCode,
       offset: token.offset,
       length: token.length,
       arguments: arguments,

pkg/analyzer/lib/src/dart/constant/constant_verifier.dart

@@ -293,7 +293,7 @@ class ConstantVerifier extends RecursiveAstVisitor<void> {
               _errorReporter.atOffset(
                 offset: result.offset,
                 length: result.length,
-                errorCode: result.diagnosticCode,
+                diagnosticCode: result.diagnosticCode,
                 arguments: result.arguments,
                 contextMessages: result.contextMessages,
               );

pkg/analyzer/lib/src/dart/constant/evaluation.dart

@@ -605,7 +605,7 @@ class ConstantVisitor extends UnifyingAstVisitor<Constant> {
       _errorReporter.atOffset(
         offset: result.offset,
         length: result.length,
-        errorCode: result.diagnosticCode,
+        diagnosticCode: result.diagnosticCode,
         arguments: result.arguments,
         contextMessages: result.contextMessages,
       );
@@ -2225,7 +2225,7 @@ class ConstantVisitor extends UnifyingAstVisitor<Constant> {
           _errorReporter.atOffset(
             offset: expressionValue.offset,
             length: expressionValue.length,
-            errorCode: expressionValue.diagnosticCode,
+            diagnosticCode: expressionValue.diagnosticCode,
             arguments: expressionValue.arguments,
             contextMessages: expressionValue.contextMessages,
           );

pkg/analyzer/lib/src/dart/resolver/binary_expression_resolver.dart

@@ -154,7 +154,7 @@ class BinaryExpressionResolver {
       _errorReporter.atOffset(
         offset: offset,
         length: end.end - offset,
-        errorCode: errorCode,
+        diagnosticCode: errorCode,
       );
     }