feat: introduce check-unused-l10n command (#467)

* feat: inroduce check-unused-l10n command

* chore: rename files

* test: add tests

* chore: add exports

* fix: fix readme

* test: update tests

* chore: review fixes and reporter refactoring

* test: update tests

* chore: update changelog

Author: incendial

CHANGELOG.md

@@ -2,11 +2,11 @@
 
 ## Unreleased
 
-* feat: Add static code diagnostic `prefer-const-border-radius`.
-* Improve static code diagnostic `prefer-extracting-callbacks`, don't trigger on empty function blocks.
-* Improve unused files check, add support for `vm:entry-point` annotation.
-* feat: ignore Flutter builder functions in `prefer-extracting-callbacks` rule.
-* fix: compute NumberOfParametersMetric only for functions and methods
+* feat: introduce `check-unused-l10n` command.
+* feat: add static code diagnostic `prefer-const-border-radius`.
+* feat: improve static code diagnostic `prefer-extracting-callbacks`: don't trigger on empty function blocks and ignore Flutter builder functions.
+* feat: improve unused files check, add support for `vm:entry-point` annotation.
+* fix: compute NumberOfParametersMetric only for functions and methods.
 
 ## 4.3.3
 

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -45,7 +45,7 @@ class LintAnalyzer {
     String rootFolder,
   ) {
     if (!isExcluded(result.path, config.globalExcludes)) {
-      return _runAnalysisForFile(
+      return _analyzeFile(
         result,
         config,
         rootFolder,
@@ -95,7 +95,7 @@ class LintAnalyzer {
       for (final filePath in analyzedFiles) {
         final unit = await context.currentSession.getResolvedUnit(filePath);
         if (unit is ResolvedUnitResult) {
-          final result = _runAnalysisForFile(
+          final result = _analyzeFile(
             unit,
             lintAnalysisConfig,
             rootFolder,
@@ -112,7 +112,7 @@ class LintAnalyzer {
     return analyzerResult;
   }
 
-  LintFileReport? _runAnalysisForFile(
+  LintFileReport? _analyzeFile(
     ResolvedUnitResult result,
     LintAnalysisConfig config,
     String rootFolder, {

lib/src/analyzers/lint_analyzer/reporters/reporters_list/json/lint_json_reporter.dart

@@ -22,19 +22,9 @@ class LintJsonReporter extends JsonReporter<LintFileReport> {
       return;
     }
 
-    final nowTime = DateTime.now();
-    final reportTime = DateTime(
-      nowTime.year,
-      nowTime.month,
-      nowTime.day,
-      nowTime.hour,
-      nowTime.minute,
-      nowTime.second,
-    );
-
     final encodedReport = json.encode({
       'formatVersion': formatVersion,
-      'timestamp': reportTime.toString(),
+      'timestamp': getTimestamp(),
       'records': records.map(_lintFileReportToJson).toList(),
     });
 

lib/src/analyzers/unused_files_analyzer/reporters/reporters_list/json/unused_files_json_reporter.dart

@@ -16,19 +16,9 @@ class UnusedFilesJsonReporter extends JsonReporter<UnusedFilesFileReport> {
       return;
     }
 
-    final nowTime = DateTime.now();
-    final reportTime = DateTime(
-      nowTime.year,
-      nowTime.month,
-      nowTime.day,
-      nowTime.hour,
-      nowTime.minute,
-      nowTime.second,
-    );
-
     final encodedReport = json.encode({
       'formatVersion': formatVersion,
-      'timestamp': reportTime.toString(),
+      'timestamp': getTimestamp(),
       'unusedFiles': records.map(_analysisRecordToJson).toList(),
     });
 

lib/src/analyzers/unused_l10n_analyzer/models/unused_l10n_file_report.dart

@@ -0,0 +1,25 @@
+import '../../../reporters/models/file_report.dart';
+import 'unused_l10n_issue.dart';
+
+class UnusedL10nFileReport implements FileReport {
+  /// The path to the target file.
+  @override
+  final String path;
+
+  /// The path to the target file relative to the package root.
+  @override
+  final String relativePath;
+
+  /// The issues detected in the target file.
+  final Iterable<UnusedL10nIssue> issues;
+
+  /// The name of a class with issues.
+  final String className;
+
+  const UnusedL10nFileReport({
+    required this.path,
+    required this.relativePath,
+    required this.issues,
+    required this.className,
+  });
+}

lib/src/analyzers/unused_l10n_analyzer/models/unused_l10n_issue.dart

@@ -0,0 +1,21 @@
+import 'package:meta/meta.dart';
+import 'package:source_span/source_span.dart';
+
+/// Represents an issue detected by the unused localization check.
+@immutable
+class UnusedL10nIssue {
+  /// The name of a class member, which is unused
+  final String memberName;
+
+  /// The source location associated with this issue.
+  final SourceLocation location;
+
+  /// Initialize a newly created [UnusedL10nIssue].
+  ///
+  /// The issue is associated with the given [location]. Used for
+  /// creating an unused localization report.
+  const UnusedL10nIssue({
+    required this.memberName,
+    required this.location,
+  });
+}

lib/src/analyzers/unused_l10n_analyzer/reporters/reporter_factory.dart

@@ -0,0 +1,24 @@
+import 'dart:io';
+
+import '../../../reporters/models/console_reporter.dart';
+import '../../../reporters/models/json_reporter.dart';
+import '../../../reporters/models/reporter.dart';
+import 'reporters_list/console/unused_l10n_console_reporter.dart';
+import 'reporters_list/json/unused_l10n_json_reporter.dart';
+
+// ignore: avoid_private_typedef_functions
+typedef _ReportersFactory = Reporter Function(IOSink output);
+
+final _implementedReports = <String, _ReportersFactory>{
+  ConsoleReporter.id: (output) => UnusedL10nConsoleReporter(output),
+  JsonReporter.id: (output) => UnusedL10nJsonReporter(output),
+};
+
+Reporter? reporter({
+  required String name,
+  required IOSink output,
+}) {
+  final constructor = _implementedReports[name];
+
+  return constructor != null ? constructor(output) : null;
+}

lib/src/analyzers/unused_l10n_analyzer/reporters/reporters_list/console/unused_l10n_console_reporter.dart

@@ -0,0 +1,53 @@
+import 'dart:io';
+
+import 'package:ansicolor/ansicolor.dart';
+
+import '../../../../../reporters/models/console_reporter.dart';
+import '../../../models/unused_l10n_file_report.dart';
+
+class UnusedL10nConsoleReporter extends ConsoleReporter<UnusedL10nFileReport> {
+  final _errorColor = AnsiPen()..red(bold: true);
+  final _warningColor = AnsiPen()..yellow(bold: true);
+  final _successColor = AnsiPen()..green();
+
+  UnusedL10nConsoleReporter(IOSink output) : super(output);
+
+  @override
+  Future<void> report(Iterable<UnusedL10nFileReport> records) async {
+    if (records.isEmpty) {
+      output.writeln('${_successColor('✔')} no unused localization found!');
+
+      return;
+    }
+
+    final sortedRecords = records.toList()
+      ..sort((a, b) => a.relativePath.compareTo(b.relativePath));
+
+    var warnings = 0;
+
+    for (final analysisRecord in sortedRecords) {
+      output.writeln('class ${analysisRecord.className}');
+
+      for (final issue in analysisRecord.issues) {
+        final line = issue.location.line;
+        final column = issue.location.column;
+        final path = analysisRecord.relativePath;
+
+        final offset = ''.padRight(3);
+        final pathOffset = offset.padRight(5);
+
+        output
+          ..writeln('$offset ${_warningColor('⚠')} unused ${issue.memberName}')
+          ..writeln('$pathOffset at $path:$line:$column');
+      }
+
+      warnings += analysisRecord.issues.length;
+
+      output.writeln('');
+    }
+
+    output.writeln(
+      '${_errorColor('✖')} total unused localization class fields, getters and methods - ${_errorColor(warnings)}',
+    );
+  }
+}

lib/src/analyzers/unused_l10n_analyzer/reporters/reporters_list/json/unused_l10n_json_reporter.dart

@@ -0,0 +1,44 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:meta/meta.dart';
+
+import '../../../../../reporters/models/json_reporter.dart';
+import '../../../models/unused_l10n_file_report.dart';
+import '../../../models/unused_l10n_issue.dart';
+
+@immutable
+class UnusedL10nJsonReporter extends JsonReporter<UnusedL10nFileReport> {
+  const UnusedL10nJsonReporter(IOSink output) : super(output, 2);
+
+  @override
+  Future<void> report(Iterable<UnusedL10nFileReport> records) async {
+    if (records.isEmpty) {
+      return;
+    }
+
+    final encodedReport = json.encode({
+      'formatVersion': formatVersion,
+      'timestamp': getTimestamp(),
+      'unusedLocalizations': records.map(_unusedL10nFileReportToJson).toList(),
+    });
+
+    output.write(encodedReport);
+  }
+
+  Map<String, Object> _unusedL10nFileReportToJson(
+    UnusedL10nFileReport report,
+  ) =>
+      {
+        'path': report.relativePath,
+        'className': report.className,
+        'issues': report.issues.map(_issueToJson).toList(),
+      };
+
+  Map<String, Object> _issueToJson(UnusedL10nIssue issue) => {
+        'memberName': issue.memberName,
+        'column': issue.location.column,
+        'line': issue.location.line,
+        'offset': issue.location.offset,
+      };
+}

lib/src/analyzers/unused_l10n_analyzer/unused_l10n_analysis_config.dart

@@ -0,0 +1,15 @@
+import 'package:glob/glob.dart';
+
+/// Represents converted unused localization config,
+/// which contains parsed entities.
+class UnusedL10nAnalysisConfig {
+  final Iterable<Glob> globalExcludes;
+  final Iterable<Glob> analyzerExcludedPatterns;
+  final RegExp classPattern;
+
+  UnusedL10nAnalysisConfig(
+    this.globalExcludes,
+    this.analyzerExcludedPatterns,
+    String? classPattern,
+  ) : classPattern = RegExp(classPattern ?? r'I18n$');
+}