analyzer: Move AnalysisErrorInfo into the linter test utilities

srawlins · Commit Queue · commit 4cb52741084d · 2024-10-29T16:04:59.000Z
Change-Id: If6115cd0d3ffe4416f13567b79c835d0ab90bc79 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/392280 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Phil Quitslund <pquitslund@google.com>
diff --git a/pkg/analyzer/lib/src/generated/engine.dart b/pkg/analyzer/lib/src/generated/engine.dart
@@ -5,10 +5,8 @@
 import 'package:_fe_analyzer_shared/src/scanner/string_canonicalizer.dart';
 import 'package:analyzer/dart/analysis/analysis_options.dart';
 import 'package:analyzer/dart/analysis/declared_variables.dart';
-import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
-import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/generated/source.dart' show SourceFactory;
 import 'package:meta/meta.dart';
 
@@ -108,31 +106,3 @@ class AnalysisEngine {
     pruneStringCanonicalizationCache();
   }
 }
-
-/// The analysis errors and line information for the errors.
-abstract class AnalysisErrorInfo {
-  /// Return the errors that as a result of the analysis, or `null` if there were
-  /// no errors.
-  List<AnalysisError> get errors;
-
-  /// Return the line information associated with the errors, or `null` if there
-  /// were no errors.
-  LineInfo get lineInfo;
-}
-
-/// The analysis errors and line info associated with a source.
-class AnalysisErrorInfoImpl implements AnalysisErrorInfo {
-  /// The analysis errors associated with a source, or `null` if there are no
-  /// errors.
-  @override
-  final List<AnalysisError> errors;
-
-  /// The line information associated with the errors, or `null` if there are no
-  /// errors.
-  @override
-  final LineInfo lineInfo;
-
-  /// Initialize an newly created error info with the given [errors] and
-  /// [lineInfo].
-  AnalysisErrorInfoImpl(this.errors, this.lineInfo);
-}
diff --git a/pkg/analyzer_cli/lib/src/analyzer_impl.dart b/pkg/analyzer_cli/lib/src/analyzer_impl.dart
@@ -36,7 +36,7 @@ class AnalyzerImpl {
   /// All files references by the analyzed library.
   final Set<String> files = <String>{};
 
-  /// All [AnalysisErrorInfo]s in the analyzed library.
+  /// All [ErrorsResult]s in the analyzed library.
   final List<ErrorsResult> errorsResults = [];
 
   /// If the file specified on the command line is part of a package, the name
diff --git a/pkg/analyzer_cli/test/mocks.dart b/pkg/analyzer_cli/test/mocks.dart
@@ -7,7 +7,6 @@ import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/diagnostic/diagnostic.dart';
-import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer_cli/src/options.dart';
 
 class MockAnalysisError implements AnalysisError {
@@ -52,16 +51,6 @@ class MockAnalysisError implements AnalysisError {
   Severity get severity => Severity.error;
 }
 
-class MockAnalysisErrorInfo implements AnalysisErrorInfo {
-  @override
-  LineInfo lineInfo;
-
-  @override
-  List<AnalysisError> errors;
-
-  MockAnalysisErrorInfo(this.lineInfo, this.errors);
-}
-
 class MockCommandLineOptions implements CommandLineOptions {
   bool enableTypeChecks = false;
   @override
diff --git a/pkg/linter/lib/src/analyzer.dart b/pkg/linter/lib/src/analyzer.dart
@@ -10,14 +10,10 @@ import 'package:analyzer/src/lint/util.dart' as util;
 
 export 'package:analyzer/dart/element/type_system.dart';
 export 'package:analyzer/source/line_info.dart';
-export 'package:analyzer/source/source.dart';
 export 'package:analyzer/src/dart/ast/token.dart';
 export 'package:analyzer/src/dart/element/inheritance_manager3.dart'
     show InheritanceManager3, Name;
 export 'package:analyzer/src/dart/error/lint_codes.dart';
-export 'package:analyzer/src/dart/resolver/exit_detector.dart';
-export 'package:analyzer/src/generated/engine.dart' show AnalysisErrorInfo;
-export 'package:analyzer/src/lint/lint_rule_timers.dart';
 export 'package:analyzer/src/lint/linter.dart'
     show
         dart2_12,
@@ -29,7 +25,6 @@ export 'package:analyzer/src/lint/linter.dart'
         NodeLintRegistry,
         State;
 export 'package:analyzer/src/lint/pub.dart' show PSEntry, PubspecVisitor;
-export 'package:analyzer/src/lint/util.dart' show FileSpelunker;
 export 'package:analyzer/src/utilities/extensions/ast.dart';
 export 'package:analyzer/src/workspace/pub.dart' show PubPackage;
 
diff --git a/pkg/linter/lib/src/rules/use_build_context_synchronously.dart b/pkg/linter/lib/src/rules/use_build_context_synchronously.dart
@@ -7,6 +7,8 @@ import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/element/element.dart';
 // ignore: implementation_imports
+import 'package:analyzer/src/dart/resolver/exit_detector.dart';
+// ignore: implementation_imports
 import 'package:analyzer/src/lint/linter.dart';
 import 'package:collection/collection.dart';
 import 'package:meta/meta.dart';
diff --git a/pkg/linter/lib/src/test_utilities/analysis_error_info.dart b/pkg/linter/lib/src/test_utilities/analysis_error_info.dart
@@ -0,0 +1,19 @@
+// Copyright (c) 2024, 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 'package:analyzer/error/error.dart';
+import 'package:analyzer/source/line_info.dart';
+
+/// The analysis errors and line info associated with a source.
+class AnalysisErrorInfo {
+  /// The analysis errors associated with a source, or `null` if there are no
+  /// errors.
+  final List<AnalysisError> errors;
+
+  /// The line information associated with the errors, or `null` if there are no
+  /// errors.
+  final LineInfo lineInfo;
+
+  AnalysisErrorInfo(this.errors, this.lineInfo);
+}
diff --git a/pkg/linter/lib/src/test_utilities/formatter.dart b/pkg/linter/lib/src/test_utilities/formatter.dart
@@ -6,9 +6,12 @@ import 'dart:io';
 import 'dart:math';
 
 import 'package:analyzer/error/error.dart';
+// ignore: implementation_imports
+import 'package:analyzer/src/lint/lint_rule_timers.dart';
 
 import '../analyzer.dart';
 import '../util/charcodes.dart' show $backslash, $pipe;
+import 'analysis_error_info.dart';
 
 // Number of times to perform linting to get stable benchmarks.
 const benchmarkRuns = 10;
diff --git a/pkg/linter/lib/src/test_utilities/lint_driver.dart b/pkg/linter/lib/src/test_utilities/lint_driver.dart
@@ -10,12 +10,14 @@ import 'package:analyzer/instrumentation/instrumentation.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
 // ignore: implementation_imports
-import 'package:analyzer/src/generated/engine.dart';
+import 'package:analyzer/src/generated/engine.dart' show AnalysisEngine;
 // ignore: implementation_imports
 import 'package:analyzer/src/lint/io.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/lint/linter.dart';
 
+import 'analysis_error_info.dart';
+
 class LintDriver {
   /// The files which have been analyzed so far.  This is used to compute the
   /// total number of files analyzed for statistics.
@@ -60,10 +62,7 @@ class LintDriver {
       var errorsResult = await analysisSession.getErrors(path);
       if (errorsResult is ErrorsResult) {
         result.add(
-          AnalysisErrorInfoImpl(
-            errorsResult.errors,
-            errorsResult.lineInfo,
-          ),
+          AnalysisErrorInfo(errorsResult.errors, errorsResult.lineInfo),
         );
       }
     }
diff --git a/pkg/linter/lib/src/test_utilities/test_linter.dart b/pkg/linter/lib/src/test_utilities/test_linter.dart
@@ -11,8 +11,6 @@ import 'package:analyzer/file_system/physical_file_system.dart' as file_system;
 import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 // ignore: implementation_imports
-import 'package:analyzer/src/generated/engine.dart' show AnalysisErrorInfo;
-// ignore: implementation_imports
 import 'package:analyzer/src/lint/io.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/lint/linter.dart';
@@ -21,6 +19,7 @@ import 'package:analyzer/src/lint/pub.dart';
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
 
+import 'analysis_error_info.dart';
 import 'lint_driver.dart';
 
 Source createSource(Uri uri) {
diff --git a/pkg/linter/test/formatter_test.dart b/pkg/linter/test/formatter_test.dart
@@ -3,8 +3,8 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/error/error.dart';
-import 'package:analyzer/src/generated/engine.dart';
 import 'package:linter/src/analyzer.dart';
+import 'package:linter/src/test_utilities/analysis_error_info.dart';
 import 'package:linter/src/test_utilities/formatter.dart';
 import 'package:test/test.dart';
 
@@ -38,7 +38,7 @@ void defineTests() {
       var error = AnalysisError.tmp(
           source: source, offset: 10, length: 3, errorCode: code);
 
-      var info = AnalysisErrorInfoImpl([error], lineInfo);
+      var info = AnalysisErrorInfo([error], lineInfo);
 
       var out = StringBuffer();
 
@@ -87,7 +87,7 @@ mock_code                               1
       var error = AnalysisError.tmp(
           source: source, offset: 12, length: 13, errorCode: code);
 
-      var info = AnalysisErrorInfoImpl([error], lineInfo);
+      var info = AnalysisErrorInfo([error], lineInfo);
 
       var out = StringBuffer();
 
diff --git a/pkg/linter/test/rule_test.dart b/pkg/linter/test/rule_test.dart
@@ -9,13 +9,14 @@ import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart';
-import 'package:analyzer/src/generated/engine.dart' show AnalysisErrorInfoImpl;
 import 'package:analyzer/src/lint/io.dart';
 import 'package:analyzer/src/lint/registry.dart';
+import 'package:analyzer/src/lint/util.dart' show FileSpelunker;
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/ast.dart';
 import 'package:linter/src/rules.dart';
 import 'package:linter/src/rules/package_prefixed_library_names.dart';
+import 'package:linter/src/test_utilities/analysis_error_info.dart';
 import 'package:linter/src/test_utilities/annotation.dart';
 import 'package:linter/src/test_utilities/formatter.dart';
 import 'package:linter/src/test_utilities/test_resource_provider.dart';
@@ -144,10 +145,7 @@ Future<Iterable<AnalysisErrorInfo>> _getErrorInfos(String ruleName, File file,
   var result =
       await context.currentSession.getResolvedUnit(path) as ResolvedUnitResult;
   return [
-    AnalysisErrorInfoImpl(
-      result.errors,
-      result.lineInfo,
-    )
+    AnalysisErrorInfo(result.errors, result.lineInfo),
   ];
 }
 
diff --git a/pkg/linter/tool/benchmark.dart b/pkg/linter/tool/benchmark.dart
@@ -8,11 +8,13 @@ import 'dart:math' as math;
 
 import 'package:analyzer/src/lint/config.dart';
 import 'package:analyzer/src/lint/io.dart';
+import 'package:analyzer/src/lint/lint_rule_timers.dart';
 import 'package:analyzer/src/lint/registry.dart';
 import 'package:args/args.dart';
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/extensions.dart';
 import 'package:linter/src/rules.dart';
+import 'package:linter/src/test_utilities/analysis_error_info.dart';
 import 'package:linter/src/test_utilities/formatter.dart';
 import 'package:linter/src/test_utilities/test_linter.dart';
 import 'package:yaml/yaml.dart';
@@ -26,8 +28,7 @@ Future<void> main(List<String> args) async {
 
 const unableToProcessExitCode = 64;
 
-Future<Iterable<AnalysisErrorInfo>> lintFiles(
-    TestLinter linter, List<File> filesToLint) async {
+Future<void> lintFiles(TestLinter linter, List<File> filesToLint) async {
   // Setup an error watcher to track whether an error was logged to stderr so
   // we can set the exit code accordingly.
   var errorWatcher = _ErrorWatchingSink(errorSink);
@@ -38,8 +39,6 @@ Future<Iterable<AnalysisErrorInfo>> lintFiles(
   } else if (errors.isNotEmpty) {
     exitCode = _maxSeverity(errors);
   }
-
-  return errors;
 }
 
 void printUsage(ArgParser parser, StringSink out, [String? error]) {
diff --git a/pkg/linter/tool/checks/driver.dart b/pkg/linter/tool/checks/driver.dart
@@ -11,12 +11,10 @@ import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart'; // ignore: implementation_imports
 import 'package:analyzer/src/dart/analysis/driver_based_analysis_context.dart'; // ignore: implementation_imports
-import 'package:analyzer/src/generated/engine.dart' // ignore: implementation_imports
-    show
-        AnalysisErrorInfoImpl;
 import 'package:analyzer/src/lint/registry.dart'; // ignore: implementation_imports
 import 'package:cli_util/cli_logging.dart';
 import 'package:linter/src/analyzer.dart';
+import 'package:linter/src/test_utilities/analysis_error_info.dart';
 import 'package:linter/src/test_utilities/formatter.dart';
 import 'package:path/path.dart' as path;
 
@@ -103,7 +101,7 @@ class Driver {
                     .where((e) => e.errorCode.name != 'TODO')
                     .toList();
                 if (filtered.isNotEmpty) {
-                  errors.add(AnalysisErrorInfoImpl(filtered, result.lineInfo));
+                  errors.add(AnalysisErrorInfo(filtered, result.lineInfo));
                 }
               }
             } on Exception catch (e) {
diff --git a/pkg/linter/tool/spelunk.dart b/pkg/linter/tool/spelunk.dart
@@ -2,8 +2,8 @@
 // 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 'package:analyzer/src/lint/util.dart' show FileSpelunker;
 import 'package:args/args.dart';
-import 'package:linter/src/analyzer.dart';
 
 /// AST Spelunker
 void main(List<String> args) {
