refactor: cleanup metric documentation (#547)

* refactor: cleanup metric documentation

* refactor: file metrics collector

Author: dkrutskikh

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * feat: introduce file metrics
+* refactor: cleanup metric documentation
 
 ## 4.6.0
 

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -194,6 +194,8 @@ class LintAnalyzer {
         final classMetrics =
             _checkClassMetrics(visitor, internalResult, config);
 
+        final fileMetrics = _checkFileMetrics(internalResult);
+
         final functionMetrics =
             _checkFunctionMetrics(visitor, internalResult, config);
 
@@ -208,12 +210,7 @@ class LintAnalyzer {
         return LintFileReport(
           path: filePath,
           relativePath: relativePath,
-          file: Report(
-            location:
-                nodeLocation(node: internalResult.unit, source: internalResult),
-            metrics: const [],
-            declaration: internalResult.unit,
-          ),
+          file: fileMetrics,
           classes: Map.unmodifiable(classMetrics
               .map<String, Report>((key, value) => MapEntry(key.name, value))),
           functions: Map.unmodifiable(functionMetrics.map<String, Report>(
@@ -325,6 +322,16 @@ class LintAnalyzer {
     return classRecords;
   }
 
+  Report _checkFileMetrics(InternalResolvedUnitResult source) {
+    final metrics = <MetricValue<num>>[];
+
+    return Report(
+      location: nodeLocation(node: source.unit, source: source),
+      declaration: source.unit,
+      metrics: metrics,
+    );
+  }
+
   Map<ScopedFunctionDeclaration, Report> _checkFunctionMetrics(
     ScopeVisitor visitor,
     InternalResolvedUnitResult source,

lib/src/analyzers/lint_analyzer/metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart

@@ -19,7 +19,6 @@ import 'cyclomatic_complexity_flow_visitor.dart';
 const _documentation = MetricDocumentation(
   name: 'Cyclomatic Complexity',
   shortName: 'CYCLO',
-  brief: 'The number of linearly-independent paths through a code block',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 20,
 );

lib/src/analyzers/lint_analyzer/metrics/metrics_list/halstead_volume/halstead_volume_metric.dart

@@ -16,8 +16,6 @@ import 'halstead_volume_ast_visitor.dart';
 const _documentation = MetricDocumentation(
   name: 'Halstead Volume',
   shortName: 'HALVOL',
-  brief:
-      'The Halstead Volume is based on the Length and the Vocabulary. You can view this as the "bulk" of the code – how much information does the reader of the code have to absorb to understand its meaning. The biggest influence on the Volume metric is the Halstead length which causes a linear increase in the Volume i.e doubling the Length will double the Volume. In the case of the Vocabulary the increase is logarithmic.',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 150,
 );

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

@@ -13,8 +13,6 @@ import '../models/metric_value.dart';
 const _documentation = MetricDocumentation(
   name: 'Lines of Code',
   shortName: 'LOC',
-  brief:
-      'The number of physical lines of code of a method, including blank lines and comments',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 100,
 );

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

@@ -18,8 +18,6 @@ import 'source_lines_of_code/source_lines_of_code_metric.dart';
 const _documentation = MetricDocumentation(
   name: 'Maintainability Index',
   shortName: 'MI',
-  brief:
-      'Maintainability Index is a software metric which measures how maintainable (easy to support and change) the source code is.',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 50,
 );

lib/src/analyzers/lint_analyzer/metrics/metrics_list/maximum_nesting_level/maximum_nesting_level_metric.dart

@@ -17,7 +17,6 @@ import 'nesting_level_visitor.dart';
 const _documentation = MetricDocumentation(
   name: 'Maximum Nesting Level',
   shortName: 'MAXNESTING',
-  brief: 'The maximum nesting level of control structures within a method',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 5,
 );

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

@@ -16,7 +16,6 @@ import '../scope_utils.dart';
 const _documentation = MetricDocumentation(
   name: 'Number of Methods',
   shortName: 'NOM',
-  brief: 'The number of methods of a class.',
   measuredType: EntityType.classEntity,
   recomendedThreshold: 10,
 );

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

@@ -14,7 +14,6 @@ import '../models/metric_value.dart';
 const _documentation = MetricDocumentation(
   name: 'Number of Parameters',
   shortName: 'NOP',
-  brief: 'Number of parameters received by a method',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 4,
 );

lib/src/analyzers/lint_analyzer/metrics/metrics_list/source_lines_of_code/source_lines_of_code_metric.dart

@@ -16,8 +16,6 @@ import 'source_code_visitor.dart';
 const _documentation = MetricDocumentation(
   name: 'Source lines of Code',
   shortName: 'SLOC',
-  brief:
-      'The approximate number of source code lines in a method, blank lines and comments are not counted.',
   measuredType: EntityType.methodEntity,
   recomendedThreshold: 50,
 );