refactor: make violations field of summary lint report record as integer (#544)

* refactor: make metrics code more flexible

* refactor: make violations field of summary lint report record as integer

* chore: update cSpell dictionary

* fix: include_file_not_found in analysis_options.yaml

Author: dkrutskikh

.vscode/settings.json

@@ -2,25 +2,27 @@
     "files.eol": "\n",
     "files.insertFinalNewline": true,
     "cSpell.words": [
-        "Backport",
-        "Gitlab",
-        "Halstead",
-        "McCabe's",
-        "SLOC",
         "ansicolor",
+        "Backport",
         "codeclimate",
         "codecov",
         "cyclomatic",
         "dartanalyzer",
         "dartdocs",
         "dependabot",
         "dkrutskikh",
+        "Gitlab",
+        "Halstead",
         "incendial",
         "lcov",
+        "McCabe's",
         "mocktail",
         "nullsafety",
+        "pubignore",
         "pubspec",
         "semver",
-        "setstate"
+        "setstate",
+        "SLOC",
+        "unawaited"
     ]
 }

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+* refactor: make violations field of summary lint report record as integer
+
 ## 4.6.0
 
 * feat: CLI now can be compiled to and used as compiled executable.

lib/src/analyzers/lint_analyzer/metrics/metrics_list/maintainability_index_metric.dart

@@ -45,7 +45,7 @@ class MaintainabilityIndexMetric extends FunctionMetric<int> {
     Iterable<ScopedClassDeclaration> classDeclarations,
     Iterable<ScopedFunctionDeclaration> functionDeclarations,
     InternalResolvedUnitResult source,
-    Iterable<MetricValue<num>> otherMetricsValues,
+    Iterable<MetricValue> otherMetricsValues,
   ) =>
       super.supports(
         node,

lib/src/analyzers/lint_analyzer/metrics/metrics_list/number_of_parameters_metric.dart

@@ -40,7 +40,7 @@ class NumberOfParametersMetric extends FunctionMetric<int> {
     Iterable<ScopedClassDeclaration> classDeclarations,
     Iterable<ScopedFunctionDeclaration> functionDeclarations,
     InternalResolvedUnitResult source,
-    Iterable<MetricValue<num>> otherMetricsValues,
+    Iterable<MetricValue> otherMetricsValues,
   ) {
     if (node is FunctionDeclaration) {
       return true;

lib/src/analyzers/lint_analyzer/metrics/metrics_list/weight_of_class_metric.dart

@@ -44,7 +44,7 @@ class WeightOfClassMetric extends ClassMetric<double> {
     Iterable<ScopedClassDeclaration> classDeclarations,
     Iterable<ScopedFunctionDeclaration> functionDeclarations,
     InternalResolvedUnitResult source,
-    Iterable<MetricValue<num>> otherMetricsValues,
+    Iterable<MetricValue> otherMetricsValues,
   ) =>
       super.supports(
         node,

lib/src/analyzers/lint_analyzer/metrics/models/metric.dart

@@ -39,7 +39,7 @@ abstract class Metric<T extends num> {
     Iterable<ScopedClassDeclaration> classDeclarations,
     Iterable<ScopedFunctionDeclaration> functionDeclarations,
     InternalResolvedUnitResult source,
-    Iterable<MetricValue<num>> otherMetricsValues,
+    Iterable<MetricValue> otherMetricsValues,
   ) =>
       true;
 

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

@@ -10,12 +10,12 @@ class SummaryLintReportRecord<T> {
   final String title;
 
   final T value;
-  final T? violations;
+  final int violations;
 
   const SummaryLintReportRecord({
     this.status = SummaryLintReportRecordStatus.none,
     required this.title,
     required this.value,
-    this.violations,
+    this.violations = 0,
   });
 }

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

@@ -57,16 +57,12 @@ class LintJsonReporter
     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,
+      'violations': record.violations,
     };
   }
 

test/src/analyzers/lint_analyzer/reporters/reporters_list/lint_json_reporter_test.dart renamed to test/src/analyzers/lint_analyzer/reporters/reporters_list/json/lint_json_reporter_test.dart

@@ -6,7 +6,7 @@ import 'package:dart_code_metrics/src/analyzers/lint_analyzer/reporters/reporter
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
 
-import 'report_example.dart';
+import '../report_example.dart';
 
 class IOSinkMock extends Mock implements IOSink {}
 
@@ -89,6 +89,7 @@ void main() {
           'status': 'none',
           'title': 'Scanned package folders',
           'value': ['bin', 'example', 'lib', 'test'],
+          'violations': 0,
         }),
       );
 

tools/analyzer_plugin/analysis_options.yaml

@@ -7,3 +7,6 @@ environment:
 
 dependencies:
   dart_code_metrics: ^4.6.0
+
+dev_dependencies:
+  lints: ^1.0.1

tools/analyzer_plugin/pubspec.yaml

@@ -142,7 +142,7 @@ The reporter prints a single JSON object containing meta information and the vio
 - `status` - a status of information in this record
 - `title` - a message with information about the record
 - `value` - an actual value of this record (can be an array or a single value)
-- `violations` - a value of a violations of a metric associated with this record (can be an array or a single value) _(optional)_
+- `violations` - a value of a violations count of a metric associated with this record
 
 ```JSON
 {