feat: introduce summary report models (#496)

* chore: cleanup collect coverage workflow

* feat: introduce summary report models

* refactor: pass summary records to report

* feat: introduce simple summary report

* chore: update changelog

* chore: fixes after review

* chore: fixes after review

* refactor: rename SummaryLintReportRecord.overflows to SummaryLintReportRecord.violations

* chore: update tests

* chore: fixes after review

Author: dkrutskikh

.github/workflows/build.yaml

@@ -37,10 +37,10 @@ jobs:
         if: success()
         run: |
           dart test --coverage=coverage
-          dart pub run coverage:format_coverage --packages=.packages -i coverage -o coverage/coverage.lcov --lcov --report-on=lib
+          dart run coverage:format_coverage --packages=.packages -i coverage -o coverage/coverage.lcov --lcov --report-on=lib
           dart run tool/uncovered_coverage.dart
           dart test test/fake_test.dart --coverage=coverage
-          dart pub run coverage:format_coverage --packages=.packages -i coverage -o coverage/coverage.lcov --lcov --report-on=lib
+          dart run coverage:format_coverage --packages=.packages -i coverage -o coverage/coverage.lcov --lcov --report-on=lib
           bash <(curl -s https://codecov.io/bash) -f coverage/coverage.lcov
 
   minimal-dart:

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * feat: add static code diagnostics `prefer-correct-type-name`, `prefer-last`, `avoid-nested-conditional-expressions`.
+* feat: introduce summary report.
 * chore: deprecate documentation in Github repo.
 * chore: restrict `analyzer` version to `>=2.4.0 <2.7.0`.
 

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -12,6 +12,8 @@ import '../../utils/file_utils.dart';
 import '../../utils/node_utils.dart';
 import 'lint_analysis_config.dart';
 import 'lint_config.dart';
+import 'metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
+import 'metrics/metrics_list/source_lines_of_code/source_lines_of_code_metric.dart';
 import 'metrics/models/metric_value.dart';
 import 'metrics/scope_visitor.dart';
 import 'models/internal_resolved_unit_result.dart';
@@ -20,8 +22,10 @@ import 'models/lint_file_report.dart';
 import 'models/report.dart';
 import 'models/scoped_class_declaration.dart';
 import 'models/scoped_function_declaration.dart';
+import 'models/summary_lint_report_record.dart';
 import 'models/suppression.dart';
 import 'reporters/reporter_factory.dart';
+import 'utils/report_utils.dart';
 
 class LintAnalyzer {
   const LintAnalyzer();
@@ -112,6 +116,40 @@ class LintAnalyzer {
     return analyzerResult;
   }
 
+  Iterable<SummaryLintReportRecord> getSummary(
+    Iterable<LintFileReport> records,
+  ) =>
+      [
+        SummaryLintReportRecord<Iterable<String>>(
+          title: 'Scanned folders',
+          value: scannedFolders(records),
+        ),
+        SummaryLintReportRecord<int>(
+          title: 'Total scanned files',
+          value: totalFiles(records),
+        ),
+        SummaryLintReportRecord<int>(
+          title: 'Total lines of source code',
+          value: totalSLOC(records),
+        ),
+        SummaryLintReportRecord<int>(
+          title: 'Total classes',
+          value: totalClasses(records),
+        ),
+        SummaryLintReportRecord<num>(
+          title: 'Average Cyclomatic Number per line of code',
+          value: averageCYCLO(records),
+          violations:
+              metricViolations(records, CyclomaticComplexityMetric.metricId),
+        ),
+        SummaryLintReportRecord<int>(
+          title: 'Average Source Lines of Code per method',
+          value: averageSLOC(records),
+          violations:
+              metricViolations(records, SourceLinesOfCodeMetric.metricId),
+        ),
+      ];
+
   LintFileReport? _analyzeFile(
     ResolvedUnitResult result,
     LintAnalysisConfig config,

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

@@ -0,0 +1,20 @@
+import 'package:meta/meta.dart';
+
+import 'summary_lint_report_record_status.dart';
+
+@immutable
+class SummaryLintReportRecord<T> {
+  final SummaryLintReportRecordStatus status;
+
+  final String title;
+
+  final T value;
+  final T? violations;
+
+  const SummaryLintReportRecord({
+    this.status = SummaryLintReportRecordStatus.none,
+    required this.title,
+    required this.value,
+    this.violations,
+  });
+}

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

@@ -0,0 +1,34 @@
+/// Enum class represent of summary report.
+class SummaryLintReportRecordStatus {
+  /// Error.
+  ///
+  /// Status indicates that a record contains error information.
+  /// Commonly represend by ❌ emoji
+  static const error = SummaryLintReportRecordStatus._('error');
+
+  /// Warning.
+  ///
+  /// Status indicates that a record requires user attention.
+  /// Commonly represend by ⚠️ emoji.
+  static const warning = SummaryLintReportRecordStatus._('warning');
+
+  /// OK.
+  ///
+  /// Standard status for successful record.
+  /// Commonly represend by ✅ emoji.
+  static const ok = SummaryLintReportRecordStatus._('ok');
+
+  /// None.
+  ///
+  /// Status for a record without a decision.
+  static const none = SummaryLintReportRecordStatus._('none');
+
+  static const values = [error, warning, ok, none];
+
+  final String _value;
+
+  const SummaryLintReportRecordStatus._(this._value);
+
+  @override
+  String toString() => _value;
+}

lib/src/analyzers/lint_analyzer/reporters/reporters_list/code_climate/lint_code_climate_reporter.dart

@@ -9,20 +9,25 @@ import '../../../models/issue.dart';
 import '../../../models/lint_file_report.dart';
 import '../../../models/report.dart';
 import '../../../models/severity.dart';
+import '../../../models/summary_lint_report_record.dart';
 import 'models/code_climate_issue.dart';
 import 'models/code_climate_issue_category.dart';
 import 'models/code_climate_issue_location.dart';
 import 'models/code_climate_issue_severity.dart';
 
-class LintCodeClimateReporter extends CodeClimateReporter<LintFileReport> {
+class LintCodeClimateReporter
+    extends CodeClimateReporter<LintFileReport, SummaryLintReportRecord> {
   LintCodeClimateReporter(IOSink output, {bool gitlabCompatible = false})
       : super(
           output,
           gitlabCompatible: gitlabCompatible,
         );
 
   @override
-  Future<void> report(Iterable<LintFileReport> records) async {
+  Future<void> report(
+    Iterable<LintFileReport> records, {
+    Iterable<SummaryLintReportRecord> summary = const [],
+  }) async {
     if (records.isEmpty) {
       return;
     }

lib/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter.dart

@@ -7,9 +7,11 @@ import '../../../metrics/models/metric_value_level.dart';
 import '../../../models/issue.dart';
 import '../../../models/lint_file_report.dart';
 import '../../../models/report.dart';
+import '../../../models/summary_lint_report_record.dart';
 import 'lint_console_reporter_helper.dart';
 
-class LintConsoleReporter extends ConsoleReporter<LintFileReport> {
+class LintConsoleReporter
+    extends ConsoleReporter<LintFileReport, SummaryLintReportRecord> {
   /// If true will report info about all files even if they're not above warning threshold
   final bool reportAll;
 
@@ -18,7 +20,10 @@ class LintConsoleReporter extends ConsoleReporter<LintFileReport> {
   LintConsoleReporter(IOSink output, {this.reportAll = false}) : super(output);
 
   @override
-  Future<void> report(Iterable<LintFileReport> records) async {
+  Future<void> report(
+    Iterable<LintFileReport> records, {
+    Iterable<SummaryLintReportRecord> summary = const [],
+  }) async {
     if (records.isEmpty) {
       return;
     }

lib/src/analyzers/lint_analyzer/reporters/reporters_list/github/lint_github_reporter.dart

@@ -3,15 +3,20 @@ import 'dart:io';
 import '../../../../../reporters/models/github_reporter.dart';
 import '../../../models/lint_file_report.dart';
 import '../../../models/severity.dart';
+import '../../../models/summary_lint_report_record.dart';
 
 const _deprecationMessage =
     'DEPRECATED! This reporter is deprecated and will be removed in 5.0.0. You can migrate on our GitHub Action.';
 
-class LintGitHubReporter extends GitHubReporter<LintFileReport> {
+class LintGitHubReporter
+    extends GitHubReporter<LintFileReport, SummaryLintReportRecord> {
   const LintGitHubReporter(IOSink output) : super(output);
 
   @override
-  Future<void> report(Iterable<LintFileReport> records) async {
+  Future<void> report(
+    Iterable<LintFileReport> records, {
+    Iterable<SummaryLintReportRecord> summary = const [],
+  }) async {
     if (records.isEmpty) {
       return;
     }

lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/lint_html_reporter.dart

@@ -10,6 +10,7 @@ import '../../../../../reporters/models/html_reporter.dart';
 import '../../../metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
 import '../../../metrics/models/metric_value_level.dart';
 import '../../../models/lint_file_report.dart';
+import '../../../models/summary_lint_report_record.dart';
 import '../../utility_selector.dart';
 import 'components/icon.dart';
 import 'components/issue_details_tooltip.dart';
@@ -60,11 +61,15 @@ class ReportTableRecord {
   });
 }
 
-class LintHtmlReporter extends HtmlReporter<LintFileReport> {
+class LintHtmlReporter
+    extends HtmlReporter<LintFileReport, SummaryLintReportRecord> {
   LintHtmlReporter(String reportFolder) : super(reportFolder);
 
   @override
-  Future<void> report(Iterable<LintFileReport> records) async {
+  Future<void> report(
+    Iterable<LintFileReport> records, {
+    Iterable<SummaryLintReportRecord> summary = const [],
+  }) async {
     await super.report(records);
 
     for (final record in records) {

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

@@ -11,13 +11,18 @@ import '../../../models/issue.dart';
 import '../../../models/lint_file_report.dart';
 import '../../../models/replacement.dart';
 import '../../../models/report.dart';
+import '../../../models/summary_lint_report_record.dart';
 
 @immutable
-class LintJsonReporter extends JsonReporter<LintFileReport> {
+class LintJsonReporter
+    extends JsonReporter<LintFileReport, SummaryLintReportRecord> {
   const LintJsonReporter(IOSink output) : super(output, 2);
 
   @override
-  Future<void> report(Iterable<LintFileReport> records) async {
+  Future<void> report(
+    Iterable<LintFileReport> records, {
+    Iterable<SummaryLintReportRecord> summary = const [],
+  }) async {
     if (records.isEmpty) {
       return;
     }
@@ -26,6 +31,12 @@ class LintJsonReporter extends JsonReporter<LintFileReport> {
       'formatVersion': formatVersion,
       'timestamp': getTimestamp(),
       'records': records.map(_lintFileReportToJson).toList(),
+      if (summary.isNotEmpty)
+        'summary': summary
+            .map((record) => _summaryLintReportRecordToJson(
+                  record as SummaryLintReportRecord<Object>,
+                ))
+            .toList(),
     });
 
     output.write(encodedReport);
@@ -39,9 +50,24 @@ class LintJsonReporter extends JsonReporter<LintFileReport> {
         'antiPatternCases': _issueToJson(report.antiPatternCases),
       };
 
-  Map<String, Map<String, Object>> _reportToJson(
-    Map<String, Report> reports,
-  ) =>
+  Map<String, Object> _summaryLintReportRecordToJson(
+    SummaryLintReportRecord<Object> record,
+  ) {
+    final recordValue = record.value;
+    final recordViolations = record.violations;
+
+    return {
+      'status': record.status.toString(),
+      'title': record.title,
+      'value': recordValue is Iterable ? recordValue.toList() : recordValue,
+      if (recordViolations != null)
+        'violations': recordViolations is Iterable
+            ? recordViolations.toList()
+            : recordViolations,
+    };
+  }
+
+  Map<String, Map<String, Object>> _reportToJson(Map<String, Report> reports) =>
       reports.map((key, value) => MapEntry(key, {
             'codeSpan': _sourceSpanToJson(value.location),
             'metrics': _metricValuesToJson(value.metrics),