feat: introduce --fatal-xxxx cli arguments (#447)

* feat: introduce `--fatal-xxxx` cli arguments

* refactor: cleanup

Author: dkrutskikh

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Add support for global rules-exclude
 * Add `Halstead Volume` metric.
 * Add ability to configure anti-pattern severity
+* Add `--fatal-warnings`, `--fatal-performance`, `--fatal-style` cli arguments.
 
 ## 4.2.1
 

README.md

@@ -143,30 +143,33 @@ Usage: metrics [arguments...] <directories>
 -h, --help                                        Print this usage information.
 
 
--r, --reporter=<console>                          The format of the output of the analysis
+-r, --reporter=<console>                          The format of the output of the analysis.
                                                   [console (default), console-verbose, codeclimate, github, gitlab, html, json]
--o, --output-directory=<OUTPUT>                   Write HTML output to OUTPUT
+-o, --output-directory=<OUTPUT>                   Write HTML output to OUTPUT.
                                                   (defaults to "metrics")
 
 
-    --cyclomatic-complexity=<20>                  Cyclomatic Complexity threshold
-    --halstead-volume=<150>                       Halstead Volume threshold
-    --lines-of-code=<100>                         Lines of Code threshold
-    --maximum-nesting-level=<5>                   Maximum Nesting Level threshold
-    --number-of-methods=<10>                      Number of Methods threshold
-    --number-of-parameters=<4>                    Number of Parameters threshold
-    --source-lines-of-code=<50>                   Source lines of Code threshold
-    --weight-of-class=<0.33>                      Weight Of a Class threshold
+    --cyclomatic-complexity=<20>                  Cyclomatic Complexity threshold.
+    --halstead-volume=<150>                       Halstead Volume threshold.
+    --lines-of-code=<100>                         Lines of Code threshold.
+    --maximum-nesting-level=<5>                   Maximum Nesting Level threshold.
+    --number-of-methods=<10>                      Number of Methods threshold.
+    --number-of-parameters=<4>                    Number of Parameters threshold.
+    --source-lines-of-code=<50>                   Source lines of Code threshold.
+    --weight-of-class=<0.33>                      Weight Of a Class threshold.
 
 
-    --root-folder=<./>                            Root folder
+    --root-folder=<./>                            Root folder.
                                                   (defaults to current directory)
-    --exclude=<{/**.g.dart,/**.template.dart}>    File paths in Glob syntax to be exclude
+    --exclude=<{/**.g.dart,/**.template.dart}>    File paths in Glob syntax to be exclude.
                                                   (defaults to "{/**.g.dart,/**.template.dart}")
 
 
-    --set-exit-on-violation-level=<warning>       Set exit code 2 if code violations same or higher level than selected are detected
+    --set-exit-on-violation-level=<warning>       Set exit code 2 if code violations same or higher level than selected are detected.
                                                   [noted, warning, alarm]
+    --[no-]fatal-style                            Treat style level issues as fatal.
+    --[no-]fatal-performance                      Treat performance level issues as fatal.
+    --[no-]fatal-warnings                         Treat warning level issues as fatal.
 ```
 
 ## Troubleshooting

lib/lint_analyzer.dart

@@ -7,3 +7,5 @@ export 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/issue.dart'
 export 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/lint_file_report.dart';
 export 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/replacement.dart';
 export 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/severity.dart';
+
+export 'package:dart_code_metrics/src/analyzers/lint_analyzer/utils/report_utils.dart';

lib/src/analyzers/lint_analyzer/reporters/utility_selector.dart

@@ -75,16 +75,6 @@ class UtilitySelector {
     );
   }
 
-  static MetricValueLevel maxViolationLevel(Iterable<LintFileReport> records) =>
-      records
-          .expand((fileRecord) => [
-                ...fileRecord.classes.values
-                    .map((report) => report.metricsLevel),
-                ...fileRecord.functions.values
-                    .map((report) => report.metricsLevel),
-              ])
-          .max;
-
   static FileMetricsReport mergeFileReports(
     FileMetricsReport lhs,
     FileMetricsReport rhs,

lib/src/analyzers/lint_analyzer/utils/report_utils.dart

@@ -0,0 +1,21 @@
+import 'package:collection/collection.dart';
+
+import '../metrics/models/metric_value_level.dart';
+import '../models/lint_file_report.dart';
+import '../models/severity.dart';
+
+MetricValueLevel maxMetricViolationLevel(Iterable<LintFileReport> records) =>
+    records
+        .expand(
+          (record) => [...record.classes.values, ...record.functions.values]
+              .map((report) => report.metricsLevel),
+        )
+        .max;
+
+bool hasIssueWithSevetiry(
+  Iterable<LintFileReport> records,
+  Severity severity,
+) =>
+    records.any((record) =>
+        record.issues.any((issue) => issue.severity == severity) ||
+        record.antiPatternCases.any((issue) => issue.severity == severity));

lib/src/cli/commands/analyze.dart

@@ -5,7 +5,8 @@ import 'package:collection/collection.dart';
 import '../../analyzers/lint_analyzer/lint_analyzer.dart';
 import '../../analyzers/lint_analyzer/metrics/metrics_factory.dart';
 import '../../analyzers/lint_analyzer/metrics/models/metric_value_level.dart';
-import '../../analyzers/lint_analyzer/reporters/utility_selector.dart';
+import '../../analyzers/lint_analyzer/models/severity.dart';
+import '../../analyzers/lint_analyzer/utils/report_utils.dart';
 import '../../config_builder/config_builder.dart';
 import '../../config_builder/models/deprecated_option.dart';
 import '../models/flag_names.dart';
@@ -39,13 +40,6 @@ class AnalyzeCommand extends BaseCommand {
   @override
   Future<void> runCommand() async {
     final parsedArgs = ParsedArguments(
-      rootFolder: argResults[FlagNames.rootFolder] as String,
-      reporterName: argResults[FlagNames.reporter] as String,
-      reportFolder: argResults[FlagNames.reportFolder] as String,
-      maximumAllowedLevel: MetricValueLevel.fromString(
-        argResults[FlagNames.setExitOnViolationLevel] as String?,
-      ),
-      folders: argResults.rest,
       excludePath: argResults[FlagNames.exclude] as String,
       metricsConfig: {
         for (final metric in getMetrics(config: {}))
@@ -57,24 +51,41 @@ class AnalyzeCommand extends BaseCommand {
     final config = ConfigBuilder.getLintConfigFromArgs(parsedArgs);
 
     final lintAnalyserResult = await _analyzer.runCliAnalysis(
-      parsedArgs.folders,
-      parsedArgs.rootFolder,
+      argResults.rest,
+      argResults[FlagNames.rootFolder] as String,
       config,
     );
 
     await _analyzer
         .getReporter(
-          name: parsedArgs.reporterName,
+          name: argResults[FlagNames.reporter] as String,
           output: stdout,
-          reportFolder: parsedArgs.reportFolder,
+          reportFolder: argResults[FlagNames.reportFolder] as String,
         )
         ?.report(lintAnalyserResult);
 
-    if (parsedArgs.maximumAllowedLevel != null &&
-        UtilitySelector.maxViolationLevel(lintAnalyserResult) >=
-            parsedArgs.maximumAllowedLevel!) {
+    if (hasIssueWithSevetiry(lintAnalyserResult, Severity.error)) {
+      exit(3);
+    } else if ((argResults[FlagNames.fatalWarnings] as bool) &&
+        hasIssueWithSevetiry(lintAnalyserResult, Severity.warning)) {
       exit(2);
     }
+
+    final maximumAllowedLevel = MetricValueLevel.fromString(
+      argResults[FlagNames.setExitOnViolationLevel] as String?,
+    );
+
+    if (maximumAllowedLevel != null &&
+        maxMetricViolationLevel(lintAnalyserResult) >= maximumAllowedLevel) {
+      exit(2);
+    }
+
+    if (((argResults[FlagNames.fatalPerformance] as bool) &&
+            hasIssueWithSevetiry(lintAnalyserResult, Severity.performance)) ||
+        ((argResults[FlagNames.fatalStyle] as bool) &&
+            hasIssueWithSevetiry(lintAnalyserResult, Severity.style))) {
+      exit(1);
+    }
   }
 
   void _addFlags() {
@@ -147,6 +158,20 @@ class AnalyzeCommand extends BaseCommand {
         valueHelp: 'warning',
         help:
             'Set exit code 2 if code violations same or higher level than selected are detected.',
+      )
+      ..addFlag(
+        FlagNames.fatalStyle,
+        help: 'Treat style level issues as fatal.',
+      )
+      ..addFlag(
+        FlagNames.fatalPerformance,
+        help: 'Treat performance level issues as fatal.',
+      )
+      ..addFlag(
+        FlagNames.fatalWarnings,
+        help: 'Treat warning level issues as fatal.',
+// TODO(dkrutrkikh): activate on next major version
+//        defaultsTo: true,
       );
   }
 }

lib/src/cli/models/flag_names.dart

@@ -19,4 +19,7 @@ class FlagNames {
 
   static const reportFolder = 'output-directory';
   static const setExitOnViolationLevel = 'set-exit-on-violation-level';
+  static const fatalStyle = 'fatal-style';
+  static const fatalPerformance = 'fatal-performance';
+  static const fatalWarnings = 'fatal-warnings';
 }

lib/src/cli/models/parsed_arguments.dart

@@ -1,23 +1,11 @@
 import 'package:meta/meta.dart';
 
-import '../../analyzers/lint_analyzer/metrics/models/metric_value_level.dart';
-
 @immutable
 class ParsedArguments {
-  final String rootFolder;
-  final String reporterName;
-  final String reportFolder;
-  final MetricValueLevel? maximumAllowedLevel;
-  final Iterable<String> folders;
   final String excludePath;
   final Map<String, Object> metricsConfig;
 
   const ParsedArguments({
-    required this.rootFolder,
-    required this.reporterName,
-    required this.reportFolder,
-    required this.maximumAllowedLevel,
-    required this.folders,
     required this.excludePath,
     required this.metricsConfig,
   });