analyzer: Deprecate ErrorType in favor of new name, DiagnosticType

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

Author: srawlins

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

@@ -110,7 +110,7 @@ abstract class ErrorCode {
   /**
    * The type of the error.
    */
-  ErrorType get type;
+  DiagnosticType get type;
 
   /**
    * Return a URL that can be used to access documentation for diagnostics with
@@ -207,66 +207,67 @@ class ErrorSeverity implements Comparable<ErrorSeverity> {
   String toString() => name;
 }
 
-/// The type of a [DiagnosticCode].
 @AnalyzerPublicApi(message: 'exported by package:analyzer/error/error.dart')
-typedef DiagnosticType = ErrorType;
+@Deprecated("Use 'DiagnosticType' instead.")
+typedef ErrorType = DiagnosticType;
 
 /**
- * The type of an [ErrorCode].
- *
- * Note that this class name, `ErrorType`, is soft-deprecated in favor of
- * the type alias, [DiagnosticType].
+ * The type of a [DiagnosticCode].
  */
 @AnalyzerPublicApi(message: 'exported by package:analyzer/error/error.dart')
-class ErrorType implements Comparable<ErrorType> {
+class DiagnosticType implements Comparable<DiagnosticType> {
   /**
    * Task (todo) comments in user code.
    */
-  static const ErrorType TODO = const ErrorType('TODO', 0, ErrorSeverity.INFO);
+  static const DiagnosticType TODO =
+      const DiagnosticType('TODO', 0, ErrorSeverity.INFO);
 
   /**
    * Extra analysis run over the code to follow best practices, which are not in
    * the Dart Language Specification.
    */
-  static const ErrorType HINT = const ErrorType('HINT', 1, ErrorSeverity.INFO);
+  static const DiagnosticType HINT =
+      const DiagnosticType('HINT', 1, ErrorSeverity.INFO);
 
   /**
    * Compile-time errors are errors that preclude execution. A compile time
    * error must be reported by a Dart compiler before the erroneous code is
    * executed.
    */
-  static const ErrorType COMPILE_TIME_ERROR =
-      const ErrorType('COMPILE_TIME_ERROR', 2, ErrorSeverity.ERROR);
+  static const DiagnosticType COMPILE_TIME_ERROR =
+      const DiagnosticType('COMPILE_TIME_ERROR', 2, ErrorSeverity.ERROR);
 
   /**
    * Checked mode compile-time errors are errors that preclude execution in
    * checked mode.
    */
-  static const ErrorType CHECKED_MODE_COMPILE_TIME_ERROR = const ErrorType(
-      'CHECKED_MODE_COMPILE_TIME_ERROR', 3, ErrorSeverity.ERROR);
+  static const DiagnosticType CHECKED_MODE_COMPILE_TIME_ERROR =
+      const DiagnosticType(
+          'CHECKED_MODE_COMPILE_TIME_ERROR', 3, ErrorSeverity.ERROR);
 
   /**
    * Static warnings are those warnings reported by the static checker. They
    * have no effect on execution. Static warnings must be provided by Dart
    * compilers used during development.
    */
-  static const ErrorType STATIC_WARNING =
-      const ErrorType('STATIC_WARNING', 4, ErrorSeverity.WARNING);
+  static const DiagnosticType STATIC_WARNING =
+      const DiagnosticType('STATIC_WARNING', 4, ErrorSeverity.WARNING);
 
   /**
    * Syntactic errors are errors produced as a result of input that does not
    * conform to the grammar.
    */
-  static const ErrorType SYNTACTIC_ERROR =
-      const ErrorType('SYNTACTIC_ERROR', 6, ErrorSeverity.ERROR);
+  static const DiagnosticType SYNTACTIC_ERROR =
+      const DiagnosticType('SYNTACTIC_ERROR', 6, ErrorSeverity.ERROR);
 
   /**
    * Lint warnings describe style and best practice recommendations that can be
    * used to formalize a project's style guidelines.
    */
-  static const ErrorType LINT = const ErrorType('LINT', 7, ErrorSeverity.INFO);
+  static const DiagnosticType LINT =
+      const DiagnosticType('LINT', 7, ErrorSeverity.INFO);
 
-  static const List<ErrorType> values = const [
+  static const List<DiagnosticType> values = const [
     TODO,
     HINT,
     COMPILE_TIME_ERROR,
@@ -295,15 +296,15 @@ class ErrorType implements Comparable<ErrorType> {
    * Initialize a newly created error type to have the given [name] and
    * [severity].
    */
-  const ErrorType(this.name, this.ordinal, this.severity);
+  const DiagnosticType(this.name, this.ordinal, this.severity);
 
   String get displayName => name.toLowerCase().replaceAll('_', ' ');
 
   @override
   int get hashCode => ordinal;
 
   @override
-  int compareTo(ErrorType other) => ordinal - other.ordinal;
+  int compareTo(DiagnosticType other) => ordinal - other.ordinal;
 
   @override
   String toString() => name;

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

@@ -205,5 +205,5 @@ class ScannerErrorCode extends ErrorCode {
   ErrorSeverity get errorSeverity => ErrorSeverity.ERROR;
 
   @override
-  ErrorType get type => ErrorType.SYNTACTIC_ERROR;
+  DiagnosticType get type => DiagnosticType.SYNTACTIC_ERROR;
 }

pkg/analysis_server/lib/src/lsp/lsp_analysis_server.dart

@@ -1394,7 +1394,7 @@ class LspServerContextManagerCallbacks
 
   bool _shouldSendError(protocol.AnalysisError error) {
     // Non-TODOs are always shown.
-    if (error.type.name != ErrorType.TODO.name) {
+    if (error.type.name != DiagnosticType.TODO.name) {
       return true;
     }
 

pkg/analysis_server/lib/src/services/correction/dart/add_diagnostic_property_reference.dart

@@ -331,7 +331,7 @@ class AddDiagnosticPropertyReference extends ResolvedCorrectionProducer {
     var endOffset = startOffset + declaration.length;
     for (var error in unitResult.errors) {
       var errorCode = error.errorCode;
-      if (errorCode.type == ErrorType.LINT &&
+      if (errorCode.type == DiagnosticType.LINT &&
           errorCode == LinterLintCode.diagnostic_describe_all_properties &&
           error.offset > startOffset &&
           error.offset < endOffset) {

pkg/analysis_server/lib/src/services/correction/dart/replace_with_decorated_box.dart

@@ -120,7 +120,7 @@ class ReplaceWithDecoratedBox extends ResolvedCorrectionProducer {
     var constructorName = expression.constructorName;
     return unitResult.errors.any((error) {
       var errorCode = error.errorCode;
-      return errorCode.type == ErrorType.LINT &&
+      return errorCode.type == DiagnosticType.LINT &&
           errorCode == LinterLintCode.use_decorated_box &&
           error.offset == constructorName.offset &&
           error.length == constructorName.length;

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

@@ -191,5 +191,5 @@ class TransformSetErrorCode extends DiagnosticCode {
   ErrorSeverity get errorSeverity => ErrorSeverity.ERROR;
 
   @override
-  ErrorType get type => ErrorType.COMPILE_TIME_ERROR;
+  DiagnosticType get type => DiagnosticType.COMPILE_TIME_ERROR;
 }

pkg/analysis_server/test/protocol_server_test.dart

@@ -236,8 +236,8 @@ class EnumTest {
   }
 
   void test_AnalysisErrorType() {
-    EnumTester<engine.ErrorType, AnalysisErrorType>().run(
-      (engine.ErrorType engineErrorType) =>
+    EnumTester<engine.DiagnosticType, AnalysisErrorType>().run(
+      (engine.DiagnosticType engineErrorType) =>
           AnalysisErrorType.values.byName(engineErrorType.name),
     );
   }
@@ -387,7 +387,7 @@ class MockAnalysisError implements engine.AnalysisError {
 
 class MockDiagnosticCode implements engine.DiagnosticCode {
   @override
-  engine.ErrorType type;
+  engine.DiagnosticType type;
 
   @override
   engine.ErrorSeverity errorSeverity;
@@ -399,7 +399,7 @@ class MockDiagnosticCode implements engine.DiagnosticCode {
   String? url;
 
   MockDiagnosticCode({
-    this.type = engine.ErrorType.COMPILE_TIME_ERROR,
+    this.type = engine.DiagnosticType.COMPILE_TIME_ERROR,
     this.errorSeverity = engine.ErrorSeverity.ERROR,
     this.name = 'TEST_ERROR',
     this.url,

pkg/analysis_server/test/src/services/correction/fix/convert_for_each_to_for_loop_test.dart

@@ -487,7 +487,7 @@ void f(List<int> list) {
 }
 ''');
     await assertNoFix(
-      errorFilter: (error) => error.errorCode.type == ErrorType.LINT,
+      errorFilter: (error) => error.errorCode.type == DiagnosticType.LINT,
     );
   }
 
@@ -498,7 +498,7 @@ void f(List<int> list) {
 }
 ''');
     await assertNoFix(
-      errorFilter: (error) => error.errorCode.type == ErrorType.LINT,
+      errorFilter: (error) => error.errorCode.type == DiagnosticType.LINT,
     );
   }
 
@@ -509,7 +509,7 @@ void f(List<int> list, bool b) {
 }
 ''');
     await assertNoFix(
-      errorFilter: (error) => error.errorCode.type == ErrorType.LINT,
+      errorFilter: (error) => error.errorCode.type == DiagnosticType.LINT,
     );
   }
 
@@ -525,6 +525,6 @@ void f(List<int> list) {
     <int>{x};
   }
 }
-''', errorFilter: (error) => error.errorCode.type == ErrorType.LINT);
+''', errorFilter: (error) => error.errorCode.type == DiagnosticType.LINT);
   }
 }

pkg/analysis_server/tool/bulk_fix/supported_diagnostics.dart

@@ -16,7 +16,8 @@ Future<void> main() async {
 
   var hintEntries = registeredFixGenerators.nonLintProducers.entries.where(
     (e) =>
-        e.key.type == ErrorType.HINT || e.key.type == ErrorType.STATIC_WARNING,
+        e.key.type == DiagnosticType.HINT ||
+        e.key.type == DiagnosticType.STATIC_WARNING,
   );
 
   var diagnostics = [

pkg/analyzer/CHANGELOG.md

@@ -3,11 +3,12 @@
 * Remove deprecated `DartType.isStructurallyEqualTo`.
 * Remove deprecated `RecordType.positionalTypes`.
 * Remove deprecated `RecordType.sortedNamedTypes`.
-* Remove `ElementLocation` class, its values are not returned anymore.
-* Deprecated `element2.dart` library, import `element.dart`.
-* Deprecated `XyzElement2` classes, use `XyzElement` instead.
+* Remove `ElementLocation` class; its values are not returned anymore.
+* Deprecate `element2.dart` library; import `element.dart`.
+* Deprecate `XyzElement2` classes; use `XyzElement` instead.
 * Deprecate `AnalysisError.correction` field; use
   `AnalysisError.correctionMessage` instead.
+* Deprecate `ErrorType`; use `DiagnosticType` instead.
 
 ## 7.4.1
 * Restore `InstanceElement.augmented` getter.