feat: add logger and progress indication (#1014)

* feat: add logger and progress indication

* chore: update changelog

* chore: restore cli runner api

* feat: support verbose logger

* test: update tests

* test: update tests

* feat: add new version check

* chore: fix analyzer

* fix: add override

Author: incendial

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+* feat: add logger and progress indication.
 * chore: changed min `SDK` version to `2.17.1`.
 
 ## 4.19.1

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -6,6 +6,7 @@ import 'package:path/path.dart';
 
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/analysis_options.dart';
+import '../../logger/logger.dart';
 import '../../reporters/models/file_report.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/analyzer_utils.dart';
@@ -31,7 +32,9 @@ import 'utils/report_utils.dart';
 
 /// The analyzer responsible for collecting lint reports.
 class LintAnalyzer {
-  const LintAnalyzer();
+  final Logger? _logger;
+
+  const LintAnalyzer([this._logger]);
 
   /// Returns a reporter for the given [name]. Use the reporter
   /// to convert analysis reports to console, JSON or other supported format.
@@ -93,7 +96,17 @@ class LintAnalyzer {
 
       final analyzedFiles =
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
+
+      final contextsLength = collection.contexts.length;
+      final filesLength = analyzedFiles.length;
+      final updateMessage = contextsLength == 1
+          ? 'Analyzing $filesLength file(s)'
+          : 'Analyzing ${collection.contexts.indexOf(context) + 1}/$contextsLength contexts with $filesLength file(s)';
+      _logger?.progress.update(updateMessage);
+
       for (final filePath in analyzedFiles) {
+        _logger?.infoVerbose('Analyzing $filePath');
+
         final unit = await context.currentSession.getResolvedUnit(filePath);
         if (unit is ResolvedUnitResult) {
           final result = _analyzeFile(
@@ -104,6 +117,10 @@ class LintAnalyzer {
           );
 
           if (result != null) {
+            _logger?.infoVerbose(
+              'Analysis result: found ${result.issues.length} issues',
+            );
+
             analyzerResult.add(result);
           }
         }
@@ -176,78 +193,60 @@ class LintAnalyzer {
     String rootFolder, {
     String? filePath,
   }) {
-    if (filePath != null && _isSupported(result)) {
-      final ignores = Suppression(result.content, result.lineInfo);
-      final internalResult = InternalResolvedUnitResult(
-        filePath,
-        result.content,
-        result.unit,
-        result.lineInfo,
-      );
-      final relativePath = relative(filePath, from: rootFolder);
-
-      final issues = <Issue>[];
-      if (!isExcluded(filePath, config.rulesExcludes)) {
-        issues.addAll(
-          _checkOnCodeIssues(
-            ignores,
-            internalResult,
-            config,
-          ),
-        );
-      }
+    if (filePath == null || !_isSupported(result)) {
+      return null;
+    }
 
-      if (!isExcluded(filePath, config.metricsExcludes)) {
-        final visitor = ScopeVisitor();
-        internalResult.unit.visitChildren(visitor);
-
-        final classMetrics =
-            _checkClassMetrics(visitor, internalResult, config);
-
-        final fileMetrics = _checkFileMetrics(visitor, internalResult, config);
-
-        final functionMetrics =
-            _checkFunctionMetrics(visitor, internalResult, config);
-
-        final antiPatterns = _checkOnAntiPatterns(
-          ignores,
-          internalResult,
-          config,
-          classMetrics,
-          functionMetrics,
-        );
-
-        return LintFileReport(
-          path: filePath,
-          relativePath: relativePath,
-          file: fileMetrics,
-          classes: Map.unmodifiable(classMetrics
-              .map<String, Report>((key, value) => MapEntry(key.name, value))),
-          functions: Map.unmodifiable(functionMetrics.map<String, Report>(
-            (key, value) => MapEntry(key.fullName, value),
-          )),
-          issues: issues,
-          antiPatternCases: antiPatterns,
-        );
-      }
+    final ignores = Suppression(result.content, result.lineInfo);
+    final internalResult = InternalResolvedUnitResult(
+      filePath,
+      result.content,
+      result.unit,
+      result.lineInfo,
+    );
+    final relativePath = relative(filePath, from: rootFolder);
+
+    final issues = <Issue>[];
+    if (!isExcluded(filePath, config.rulesExcludes)) {
+      issues.addAll(_checkOnCodeIssues(ignores, internalResult, config));
+    }
+
+    if (!isExcluded(filePath, config.metricsExcludes)) {
+      final visitor = ScopeVisitor();
+      internalResult.unit.visitChildren(visitor);
+
+      final classMetrics = _checkClassMetrics(visitor, internalResult, config);
+      final fileMetrics = _checkFileMetrics(visitor, internalResult, config);
+      final functionMetrics =
+          _checkFunctionMetrics(visitor, internalResult, config);
+      final antiPatterns = _checkOnAntiPatterns(
+        ignores,
+        internalResult,
+        config,
+        classMetrics,
+        functionMetrics,
+      );
 
       return LintFileReport(
         path: filePath,
         relativePath: relativePath,
-        file: Report(
-          location:
-              nodeLocation(node: internalResult.unit, source: internalResult),
-          metrics: const [],
-          declaration: internalResult.unit,
-        ),
-        classes: const {},
-        functions: const {},
+        file: fileMetrics,
+        classes: Map.unmodifiable(classMetrics
+            .map<String, Report>((key, value) => MapEntry(key.name, value))),
+        functions: Map.unmodifiable(functionMetrics.map<String, Report>(
+          (key, value) => MapEntry(key.fullName, value),
+        )),
         issues: issues,
-        antiPatternCases: const [],
+        antiPatternCases: antiPatterns,
       );
     }
 
-    return null;
+    return LintFileReport.onlyIssues(
+      path: filePath,
+      relativePath: relativePath,
+      file: _getEmptyFileReport(internalResult),
+      issues: issues,
+    );
   }
 
   Iterable<Issue> _checkOnCodeIssues(
@@ -368,6 +367,14 @@ class LintAnalyzer {
     );
   }
 
+  Report _getEmptyFileReport(InternalResolvedUnitResult internalResult) =>
+      Report(
+        location:
+            nodeLocation(node: internalResult.unit, source: internalResult),
+        metrics: const [],
+        declaration: internalResult.unit,
+      );
+
   Map<ScopedFunctionDeclaration, Report> _checkFunctionMetrics(
     ScopeVisitor visitor,
     InternalResolvedUnitResult source,

lib/src/analyzers/lint_analyzer/models/lint_file_report.dart

@@ -36,4 +36,13 @@ class LintFileReport implements FileReport {
     required this.issues,
     required this.antiPatternCases,
   });
+
+  const LintFileReport.onlyIssues({
+    required this.path,
+    required this.relativePath,
+    required this.file,
+    required this.issues,
+  })  : classes = const {},
+        functions = const {},
+        antiPatternCases = const {};
 }

lib/src/analyzers/unnecessary_nullable_analyzer/unnecessary_nullable_analyzer.dart

@@ -15,6 +15,7 @@ import 'package:source_span/source_span.dart';
 
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/analysis_options.dart';
+import '../../logger/logger.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/analyzer_utils.dart';
 import '../../utils/flutter_types_utils.dart';
@@ -33,7 +34,9 @@ import 'unnecessary_nullable_config.dart';
 class UnnecessaryNullableAnalyzer {
   static const _ignoreName = 'unnecessary-nullable';
 
-  const UnnecessaryNullableAnalyzer();
+  final Logger? _logger;
+
+  const UnnecessaryNullableAnalyzer([this._logger]);
 
   /// Returns a reporter for the given [name]. Use the reporter
   /// to convert analysis reports to console, JSON or other supported format.
@@ -75,22 +78,42 @@ class UnnecessaryNullableAnalyzer {
 
       final analyzedFiles =
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
+
+      final contextsLength = collection.contexts.length;
+      final filesLength = analyzedFiles.length;
+      final updateMessage = contextsLength == 1
+          ? 'Checking unnecessary nullable parameters for $filesLength file(s)'
+          : 'Checking unnecessary nullable parameters for ${collection.contexts.indexOf(context) + 1}/$contextsLength contexts with $filesLength file(s)';
+      _logger?.progress.update(updateMessage);
+
       for (final filePath in analyzedFiles) {
+        _logger?.infoVerbose('Analyzing $filePath');
+
         final unit = await context.currentSession.getResolvedUnit(filePath);
 
         final invocationsUsage = _analyzeInvocationsUsage(unit);
         if (invocationsUsage != null) {
+          _logger?.infoVerbose(
+            'Found invocations: ${invocationsUsage.elements.length}',
+          );
+
           invocationsUsages.merge(invocationsUsage);
         }
 
         if (!unnecessaryNullableAnalysisConfig.analyzerExcludedPatterns
             .any((pattern) => pattern.matches(filePath))) {
+          _logger
+              ?.infoVerbose('Found declarations: ${declarationsUsages.length}');
+
           declarationsUsages[filePath] = _analyzeDeclarationsUsage(unit);
         }
       }
     }
 
     if (!config.isMonorepo) {
+      _logger?.infoVerbose(
+        'Removing globally exported files with declarations from the analysis: ${invocationsUsages.exports.length}',
+      );
       invocationsUsages.exports.forEach(declarationsUsages.remove);
     }
 

lib/src/analyzers/unused_code_analyzer/unused_code_analyzer.dart

@@ -10,6 +10,7 @@ import 'package:source_span/source_span.dart';
 
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/analysis_options.dart';
+import '../../logger/logger.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/analyzer_utils.dart';
 import '../../utils/suppression.dart';
@@ -27,7 +28,9 @@ import 'used_code_visitor.dart';
 class UnusedCodeAnalyzer {
   static const _ignoreName = 'unused-code';
 
-  const UnusedCodeAnalyzer();
+  final Logger? _logger;
+
+  const UnusedCodeAnalyzer([this._logger]);
 
   /// Returns a reporter for the given [name]. Use the reporter
   /// to convert analysis reports to console, JSON or other supported format.
@@ -68,7 +71,17 @@ class UnusedCodeAnalyzer {
 
       final analyzedFiles =
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
+
+      final contextsLength = collection.contexts.length;
+      final filesLength = analyzedFiles.length;
+      final updateMessage = contextsLength == 1
+          ? 'Checking unused code for $filesLength file(s)'
+          : 'Checking unused code for ${collection.contexts.indexOf(context) + 1}/$contextsLength contexts with $filesLength file(s)';
+      _logger?.progress.update(updateMessage);
+
       for (final filePath in analyzedFiles) {
+        _logger?.infoVerbose('Analyzing $filePath');
+
         final unit = await context.currentSession.getResolvedUnit(filePath);
 
         final codeUsage = _analyzeFileCodeUsages(unit);
@@ -84,6 +97,9 @@ class UnusedCodeAnalyzer {
     }
 
     if (!config.isMonorepo) {
+      _logger?.infoVerbose(
+        'Removing globally exported files with code usages from the analysis: ${codeUsages.exports.length}',
+      );
       codeUsages.exports.forEach(publicCode.remove);
     }
 

lib/src/analyzers/unused_files_analyzer/unused_files_analyzer.dart

@@ -6,6 +6,7 @@ import 'package:path/path.dart';
 
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/analysis_options.dart';
+import '../../logger/logger.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/analyzer_utils.dart';
 import '../../utils/suppression.dart';
@@ -20,7 +21,9 @@ import 'unused_files_visitor.dart';
 class UnusedFilesAnalyzer {
   static const _ignoreName = 'unused-files';
 
-  const UnusedFilesAnalyzer();
+  final Logger? _logger;
+
+  const UnusedFilesAnalyzer([this._logger]);
 
   /// Returns a reporter for the given [name]. Use the reporter
   /// to convert analysis reports to console, JSON or other supported format.
@@ -63,6 +66,8 @@ class UnusedFilesAnalyzer {
       final analyzedFiles =
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
       for (final filePath in analyzedFiles) {
+        _logger?.infoVerbose('Analyzing $filePath');
+
         final unit = await context.currentSession.getResolvedUnit(filePath);
         unusedFiles.removeAll(_analyzeFile(filePath, unit, config.isMonorepo));
       }

lib/src/analyzers/unused_l10n_analyzer/unused_l10n_analyzer.dart

@@ -13,6 +13,7 @@ import 'package:source_span/source_span.dart';
 
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/analysis_options.dart';
+import '../../logger/logger.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/analyzer_utils.dart';
 import 'models/unused_l10n_file_report.dart';
@@ -25,7 +26,9 @@ import 'unused_l10n_visitor.dart';
 
 /// The analyzer responsible for collecting unused localization reports.
 class UnusedL10nAnalyzer {
-  const UnusedL10nAnalyzer();
+  final Logger? _logger;
+
+  const UnusedL10nAnalyzer([this._logger]);
 
   /// Returns a reporter for the given [name]. Use the reporter
   /// to convert analysis reports to console, JSON or other supported format.
@@ -67,6 +70,8 @@ class UnusedL10nAnalyzer {
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
 
       for (final filePath in analyzedFiles) {
+        _logger?.infoVerbose('Analyzing $filePath');
+
         final unit = await context.currentSession.getResolvedUnit(filePath);
 
         _analyzeFile(unit, unusedLocalizationAnalysisConfig.classPattern)