linter: Move LintDriver into linter package

The only remaining use of LintDriver was in `test_linter.dart` in the
linter package. Moving this code unveiled a bunch of stuff that could
be removed or made private:

* The only use of DriverOptions was the class LinterOptions which
  subclasses it; so just combine the two classes.
  * Once combined, we also see that none of `cacheSize, `enabledLints`,
    or `packageConfigPath` are every used; remove them. This also
    simplifies the code in `LintDriver.analyze`, in the call to create
    the `AnalysisContextCollection`.
* Move the top-level function `createSource` to `test_linter.dart`.
* Remove unused `TestLinter.numSourcesAnalyzed`.
* Remove unused `LintDriver.numSourcesAnalyzed`.
* The StdInstrumentation is only used locally; privatize it.
* test_linter.dart does not need to export any libraries.

Change-Id: I5eee9570eefa2ecb11e72852f5d46b2e6c12ea11
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/391321
Reviewed-by: Phil Quitslund <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>

Author: srawlins

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

@@ -25,7 +25,6 @@ import 'package:analyzer/src/dart/element/element.dart';
 import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer/src/dart/element/type_system.dart';
 import 'package:analyzer/src/error/codes.dart';
-import 'package:analyzer/src/lint/analysis.dart';
 import 'package:analyzer/src/lint/linter_visitor.dart' show NodeLintRegistry;
 import 'package:analyzer/src/lint/pub.dart';
 import 'package:analyzer/src/lint/registry.dart';
@@ -184,9 +183,15 @@ final class LinterContextWithResolvedResults implements LinterContext {
   LibraryElement2 get libraryElement2 => libraryElement as LibraryElement2;
 }
 
-class LinterOptions extends DriverOptions {
+class LinterOptions {
   final Iterable<LintRule> enabledRules;
 
+  /// The path to the Dart SDK.
+  String? dartSdkPath;
+
+  /// Whether to gather timing data during analysis.
+  bool enableTiming = false;
+
   LinterOptions({
     Iterable<LintRule>? enabledRules,
   }) : enabledRules = enabledRules ?? Registry.ruleRegistry;

pkg/analyzer/lib/src/lint/analysis.dart renamed to pkg/linter/lib/src/test_utilities/lint_driver.dart

@@ -1,55 +1,21 @@
-// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
+// 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.
 
-/// @docImport 'package:linter/src/test_utilities/test_linter.dart';
-library;
-
 import 'dart:io' as io;
 
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/file_system/file_system.dart';
-import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
-import 'package:analyzer/source/file_source.dart';
-import 'package:analyzer/source/source.dart';
+// ignore: implementation_imports
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
+// ignore: implementation_imports
 import 'package:analyzer/src/generated/engine.dart';
+// ignore: implementation_imports
 import 'package:analyzer/src/lint/io.dart';
+// ignore: implementation_imports
 import 'package:analyzer/src/lint/linter.dart';
 
-Source createSource(Uri uri) {
-  var filePath = uri.toFilePath();
-  var file = PhysicalResourceProvider.INSTANCE.getFile(filePath);
-  return FileSource(file, uri);
-}
-
-/// Print the given message and exit with the given [exitCode]
-void printAndFail(String message, {int exitCode = 15}) {
-  print(message);
-  io.exit(exitCode);
-}
-
-class DriverOptions {
-  /// The maximum number of sources for which AST structures should be kept
-  /// in the cache.  The default is 512.
-  int cacheSize = 512;
-
-  /// The path to the dart SDK.
-  String? dartSdkPath;
-
-  /// Whether to show lint warnings.
-  bool enableLints = true;
-
-  /// Whether to gather timing data during analysis.
-  bool enableTiming = false;
-
-  /// The path to a `.packages` configuration file
-  String? packageConfigPath;
-}
-
-/// A driver _only used_ by [TestLinter], which is only used by package:linter
-/// tests and tools.
 class LintDriver {
   /// The files which have been analyzed so far.  This is used to compute the
   /// total number of files analyzed for statistics.
@@ -61,19 +27,11 @@ class LintDriver {
 
   LintDriver(this.options, this._resourceProvider);
 
-  /// Return the number of sources that have been analyzed so far.
-  int get numSourcesAnalyzed => _filesAnalyzed.length;
-
   Future<List<AnalysisErrorInfo>> analyze(Iterable<io.File> files) async {
-    AnalysisEngine.instance.instrumentationService = StdInstrumentation();
-
-    // TODO(scheglov): Enforce normalized absolute paths in the config.
-    var packageConfigPath = options.packageConfigPath;
-    packageConfigPath = _absoluteNormalizedPath.ifNotNull(packageConfigPath);
+    AnalysisEngine.instance.instrumentationService = _StdInstrumentation();
 
     var contextCollection = AnalysisContextCollectionImpl(
       resourceProvider: _resourceProvider,
-      packagesFile: packageConfigPath,
       sdkPath: options.dartSdkPath,
       includedPaths:
           files.map((file) => _absoluteNormalizedPath(file.path)).toList(),
@@ -82,7 +40,7 @@ class LintDriver {
         required contextRoot,
         required sdk,
       }) {
-        analysisOptions.lint = options.enableLints;
+        analysisOptions.lint = true;
         analysisOptions.warning = false;
         analysisOptions.enableTiming = options.enableTiming;
         analysisOptions.lintRules =
@@ -114,15 +72,13 @@ class LintDriver {
 
   String _absoluteNormalizedPath(String path) {
     var pathContext = _resourceProvider.pathContext;
-    path = pathContext.absolute(path);
-    path = pathContext.normalize(path);
-    return path;
+    return pathContext.normalize(pathContext.absolute(path));
   }
 }
 
 /// Prints logging information comments to the [outSink] and error messages to
 /// [errorSink].
-class StdInstrumentation extends NoopInstrumentationService {
+class _StdInstrumentation extends NoopInstrumentationService {
   @override
   void logError(String message, [Object? exception]) {
     errorSink.writeln(message);
@@ -132,9 +88,11 @@ class StdInstrumentation extends NoopInstrumentationService {
   }
 
   @override
-  void logException(dynamic exception,
-      [StackTrace? stackTrace,
-      List<InstrumentationServiceAttachment>? attachments]) {
+  void logException(
+    exception, [
+    StackTrace? stackTrace,
+    List<InstrumentationServiceAttachment>? attachments,
+  ]) {
     errorSink.writeln(exception);
     errorSink.writeln(stackTrace);
   }
@@ -147,14 +105,3 @@ class StdInstrumentation extends NoopInstrumentationService {
     }
   }
 }
-
-extension _UnaryFunctionExtension<T, R> on R Function(T) {
-  /// Invoke this function if [t] is not `null`, otherwise return `null`.
-  R? ifNotNull(T? t) {
-    if (t != null) {
-      return this(t);
-    } else {
-      return null;
-    }
-  }
-}

pkg/linter/lib/src/test_utilities/test_linter.dart

@@ -8,22 +8,26 @@ import 'package:analyzer/error/error.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/file_system/file_system.dart' as file_system;
 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/analysis.dart';
-// ignore: implementation_imports
 import 'package:analyzer/src/lint/io.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/lint/linter.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/lint/pub.dart';
 import 'package:meta/meta.dart';
-import 'package:path/path.dart' as p;
+import 'package:path/path.dart' as path;
+
+import 'lint_driver.dart';
 
-export 'package:analyzer/src/lint/linter_visitor.dart' show NodeLintRegistry;
-export 'package:analyzer/src/lint/state.dart'
-    show dart2_12, dart3, dart3_3, State;
+Source createSource(Uri uri) {
+  var filePath = uri.toFilePath();
+  var file = file_system.PhysicalResourceProvider.INSTANCE.getFile(filePath);
+  return FileSource(file, uri);
+}
 
 /// Dart source linter, only for package:linter's tools and tests.
 class TestLinter implements AnalysisErrorListener {
@@ -32,11 +36,6 @@ class TestLinter implements AnalysisErrorListener {
   final LinterOptions options;
   final file_system.ResourceProvider _resourceProvider;
 
-  /// The total number of sources that were analyzed.
-  ///
-  /// Only valid after [lintFiles] has been called.
-  int numSourcesAnalyzed = 0;
-
   TestLinter(
     this.options, {
     file_system.ResourceProvider? resourceProvider,
@@ -47,9 +46,7 @@ class TestLinter implements AnalysisErrorListener {
     var errors = <AnalysisErrorInfo>[];
     var lintDriver = LintDriver(options, _resourceProvider);
     errors.addAll(await lintDriver.analyze(files.where(isDartFile)));
-    numSourcesAnalyzed = lintDriver.numSourcesAnalyzed;
     files.where(isPubspecFile).forEach((file) {
-      numSourcesAnalyzed++;
       var errorsForFile = lintPubspecSource(
         contents: file.readAsStringSync(),
         sourcePath: _resourceProvider.pathContext.normalize(file.absolute.path),
@@ -63,7 +60,7 @@ class TestLinter implements AnalysisErrorListener {
   Iterable<AnalysisErrorInfo> lintPubspecSource(
       {required String contents, String? sourcePath}) {
     var results = <AnalysisErrorInfo>[];
-    var sourceUrl = sourcePath == null ? null : p.toUri(sourcePath);
+    var sourceUrl = sourcePath == null ? null : path.toUri(sourcePath);
     var spec = Pubspec.parse(contents, sourceUrl: sourceUrl);
 
     for (var rule in options.enabledRules) {