Remove most use cases of LintFilter.

The only time a `filter` was passed to LinterOptions was in
`benchmark.dart` and in tests of the filter option. But then
`benchmark.dart` just grabs it back out, so we can remove it from
LinterOptions.

It can then be removed from all of the reporters (DetailedReporter,
ReportFormatter, SimpleFormatter).

Remove unused `quiet` option from these reporters as well.

I suspect more can be removed from the reporters (again they are only
used in tests; no uses in the wild) but I'll save those for later.

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

Author: srawlins

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

@@ -187,20 +187,13 @@ final class LinterContextWithResolvedResults implements LinterContext {
 class LinterOptions extends DriverOptions {
   final Iterable<LintRule> enabledRules;
   final String? analysisOptions;
-  LintFilter? filter;
 
   LinterOptions({
     Iterable<LintRule>? enabledRules,
     this.analysisOptions,
-    this.filter,
   }) : enabledRules = enabledRules ?? Registry.ruleRegistry;
 }
 
-/// Filtered lints are omitted from linter output.
-abstract class LintFilter {
-  bool filter(AnalysisError lint);
-}
-
 /// Describes a lint rule.
 abstract class LintRule {
   /// Used to report lint warnings.

pkg/linter/lib/src/analyzer.dart

@@ -22,7 +22,6 @@ export 'package:analyzer/src/lint/linter.dart'
         dart2_12,
         dart3,
         dart3_3,
-        LintFilter,
         LintRule,
         LinterContext,
         LinterOptions,

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

@@ -52,13 +52,15 @@ String _escapePipe(String input) {
 }
 
 class DetailedReporter extends SimpleFormatter {
-  DetailedReporter(super.errors, super.filter, super.out,
-      {super.fileCount,
-      super.elapsedMs,
-      super.fileRoot,
-      super.showStatistics,
-      super.machineOutput,
-      super.quiet});
+  DetailedReporter(
+    super.errors,
+    super.out, {
+    super.fileCount,
+    super.elapsedMs,
+    super.fileRoot,
+    super.showStatistics,
+    super.machineOutput,
+  });
 
   @override
   void writeLint(AnalysisError error, {int? offset, int? line, int? column}) {
@@ -79,20 +81,23 @@ class DetailedReporter extends SimpleFormatter {
 
 abstract class ReportFormatter {
   factory ReportFormatter(
-          Iterable<AnalysisErrorInfo> errors, LintFilter? filter, IOSink out,
-          {int? fileCount,
-          int? elapsedMs,
-          String? fileRoot,
-          bool showStatistics = false,
-          bool machineOutput = false,
-          bool quiet = false}) =>
-      DetailedReporter(errors, filter, out,
-          fileCount: fileCount,
-          fileRoot: fileRoot,
-          elapsedMs: elapsedMs,
-          showStatistics: showStatistics,
-          machineOutput: machineOutput,
-          quiet: quiet);
+    Iterable<AnalysisErrorInfo> errors,
+    IOSink out, {
+    int? fileCount,
+    int? elapsedMs,
+    String? fileRoot,
+    bool showStatistics = false,
+    bool machineOutput = false,
+  }) =>
+      DetailedReporter(
+        errors,
+        out,
+        fileCount: fileCount,
+        fileRoot: fileRoot,
+        elapsedMs: elapsedMs,
+        showStatistics: showStatistics,
+        machineOutput: machineOutput,
+      );
 
   void write();
 }
@@ -101,29 +106,25 @@ abstract class ReportFormatter {
 class SimpleFormatter implements ReportFormatter {
   final IOSink out;
   final Iterable<AnalysisErrorInfo> errors;
-  final LintFilter? filter;
 
   int errorCount = 0;
-  int filteredLintCount = 0;
 
   final int? fileCount;
   final int? elapsedMs;
   final String? fileRoot;
   final bool showStatistics;
   final bool machineOutput;
-  final bool quiet;
 
   /// Cached for the purposes of statistics report formatting.
   int _summaryLength = 0;
 
   Map<String, int> stats = <String, int>{};
 
-  SimpleFormatter(this.errors, this.filter, this.out,
+  SimpleFormatter(this.errors, this.out,
       {this.fileCount,
       this.fileRoot,
       this.elapsedMs,
       this.showStatistics = false,
-      this.quiet = false,
       this.machineOutput = false});
 
   /// Override to influence error sorting
@@ -204,23 +205,15 @@ class SimpleFormatter implements ReportFormatter {
   }
 
   void writeLints() {
-    var filter = this.filter;
     for (var info in errors) {
       for (var e in (info.errors.toList()..sort(compare))) {
-        if (filter != null && filter.filter(e)) {
-          filteredLintCount++;
-        } else {
-          ++errorCount;
-          if (!quiet) {
-            _writeLint(e, info.lineInfo);
-          }
-          _recordStats(e);
-        }
+        ++errorCount;
+        _writeLint(e, info.lineInfo);
+
+        _recordStats(e);
       }
     }
-    if (!quiet) {
-      out.writeln();
-    }
+    out.writeln();
   }
 
   void writeStatistics() {
@@ -230,8 +223,7 @@ class SimpleFormatter implements ReportFormatter {
 
   void writeSummary() {
     var summary = '${pluralize("file", fileCount)} analyzed, '
-        '${pluralize("issue", errorCount)} found'
-        "${filteredLintCount == 0 ? '' : ' ($filteredLintCount filtered)'}, in $elapsedMs ms.";
+        '${pluralize("issue", errorCount)} found, in $elapsedMs ms.';
     out.writeln(summary);
     // Cache for output table sizing
     _summaryLength = summary.length;

pkg/linter/test/formatter_test.dart

@@ -42,9 +42,8 @@ void defineTests() {
 
       var out = CollectingSink();
 
-      var reporter =
-          SimpleFormatter([info], null, out, fileCount: 1, elapsedMs: 13)
-            ..write();
+      var reporter = SimpleFormatter([info], out, fileCount: 1, elapsedMs: 13)
+        ..write();
 
       test('count', () {
         expect(reporter.errorCount, 1);
@@ -58,7 +57,7 @@ void defineTests() {
 
       test('stats', () {
         out.buffer.clear();
-        SimpleFormatter([info], null, out,
+        SimpleFormatter([info], out,
                 fileCount: 1, showStatistics: true, elapsedMs: 13)
             .write();
         expect(out.buffer.toString(),
@@ -93,29 +92,10 @@ mock_code                               1
 
       var out = CollectingSink();
 
-      group('filtered', () {
-        var reporter = SimpleFormatter([info], _RejectingFilter(), out,
-            fileCount: 1, elapsedMs: 13)
-          ..write();
-
-        test('error count', () {
-          expect(reporter.errorCount, 0);
-        });
-
-        test('filter count', () {
-          expect(reporter.filteredLintCount, 1);
-        });
-
-        test('write', () {
-          expect(out.buffer.toString().trim(),
-              '1 file analyzed, 0 issues found (1 filtered), in 13 ms.');
-        });
-      });
-
       group('machine-output', () {
         test('write', () {
           out.buffer.clear();
-          SimpleFormatter([info], null, out,
+          SimpleFormatter([info], out,
                   fileCount: 1, machineOutput: true, elapsedMs: 13)
               .write();
 
@@ -128,8 +108,3 @@ mock_code                               1
     });
   });
 }
-
-class _RejectingFilter extends LintFilter {
-  @override
-  bool filter(AnalysisError lint) => true;
-}

pkg/linter/test/rule_test.dart

@@ -230,15 +230,8 @@ void _validateExpectedLints(File file, Iterable<AnalysisErrorInfo> errorInfos,
   }
 }
 
-/// A [LintFilter] that filters no lint.
-class NoFilter implements LintFilter {
-  @override
-  bool filter(AnalysisError lint) => false;
-}
-
 /// A [DetailedReporter] that filters no lint, only used in debug mode, when
 /// actual lints do not match expectations.
 class ResultReporter extends DetailedReporter {
-  ResultReporter(Iterable<AnalysisErrorInfo> errors)
-      : super(errors, NoFilter(), stdout);
+  ResultReporter(Iterable<AnalysisErrorInfo> errors) : super(errors, stdout);
 }

pkg/linter/tool/benchmark.dart

@@ -29,7 +29,7 @@ Future<void> main(List<String> args) async {
 const unableToProcessExitCode = 64;
 
 Future<Iterable<AnalysisErrorInfo>> lintFiles(
-    TestLinter linter, List<File> filesToLint) async {
+    TestLinter linter, List<File> filesToLint, LintFilter filter) 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,7 +38,7 @@ Future<Iterable<AnalysisErrorInfo>> lintFiles(
   if (errorWatcher.encounteredError) {
     exitCode = loggedAnalyzerErrorExitCode;
   } else if (errors.isNotEmpty) {
-    exitCode = _maxSeverity(errors, linter.options.filter);
+    exitCode = _maxSeverity(errors, filter);
   }
 
   return errors;
@@ -95,12 +95,13 @@ Future<void> runLinter(List<String> args) async {
   var ruleNames = options['rules'];
 
   LinterOptions linterOptions;
+  LintFilter? filter;
   if (configFile is String) {
     var config = LintConfig.parse(readFile(configFile));
     var enabledRules = Registry.ruleRegistry.where((LintRule rule) =>
         !config.ruleConfigs.any((rc) => rc.disables(rule.name)));
-    var filter = _FileGlobFilter(config.fileIncludes, config.fileExcludes);
-    linterOptions = LinterOptions(enabledRules: enabledRules, filter: filter);
+    filter = _FileGlobFilter(config.fileIncludes, config.fileExcludes);
+    linterOptions = LinterOptions(enabledRules: enabledRules);
   } else if (ruleNames is Iterable<String> && ruleNames.isNotEmpty) {
     var rules = <LintRule>[];
     for (var ruleName in ruleNames) {
@@ -115,6 +116,7 @@ Future<void> runLinter(List<String> args) async {
   } else {
     linterOptions = LinterOptions();
   }
+  filter ??= _FileGlobFilter([], []);
 
   var customSdk = options['dart-sdk'];
   if (customSdk is String) {
@@ -130,14 +132,14 @@ Future<void> runLinter(List<String> args) async {
           .map(File.new),
   ];
 
-  await writeBenchmarks(outSink, filesToLint, linterOptions);
+  await writeBenchmarks(outSink, filesToLint, linterOptions, filter);
 }
 
-Future<void> writeBenchmarks(
-    IOSink out, List<File> filesToLint, LinterOptions linterOptions) async {
+Future<void> writeBenchmarks(IOSink out, List<File> filesToLint,
+    LinterOptions linterOptions, LintFilter filter) async {
   var timings = <String, int>{};
   for (var i = 0; i < benchmarkRuns; ++i) {
-    await lintFiles(TestLinter(linterOptions), filesToLint);
+    await lintFiles(TestLinter(linterOptions), filesToLint, filter);
     lintRuleTimers.timers.forEach((n, t) {
       var timing = t.elapsedMilliseconds;
       var previous = timings[n];
@@ -167,18 +169,19 @@ Future<void> writeBenchmarks(
   out.writeTimings(stats, 0);
 }
 
-Iterable<AnalysisError> _filtered(
-        Iterable<AnalysisError> errors, LintFilter? filter) =>
-    (filter == null)
-        ? errors
-        : errors.where((AnalysisError e) => !filter.filter(e));
-
-int _maxSeverity(List<AnalysisErrorInfo> infos, LintFilter? filter) {
-  var allErrors = _filtered(infos.expand((i) => i.errors), filter);
-  return allErrors.fold(
+int _maxSeverity(List<AnalysisErrorInfo> infos, LintFilter filter) {
+  var filteredErrors = infos
+      .expand((i) => i.errors)
+      .where((AnalysisError e) => !filter.filter(e));
+  return filteredErrors.fold(
       0, (value, e) => math.max(value, e.errorCode.errorSeverity.ordinal));
 }
 
+/// Filtered lints are omitted from linter output.
+abstract class LintFilter {
+  bool filter(AnalysisError lint);
+}
+
 class _ErrorWatchingSink implements IOSink {
   bool encounteredError = false;
 

pkg/linter/tool/checks/driver.dart

@@ -113,9 +113,7 @@ class Driver {
           }
         }
       }
-      ReportFormatter(
-              errors, null /*_TodoFilter()*/, silent ? MockIOSink() : io.stdout)
-          .write();
+      ReportFormatter(errors, silent ? MockIOSink() : io.stdout).write();
 
       for (var info in errors) {
         failedChecks.addAll(info.errors);