feat: pattern severity (#446)

* feat: introduce Pattern.severity

* refactor: move readSeverity to lint_utlis

* feat: read pattern severity from config

* refactor: remove duplicate code

* documentation: update changelog

Author: dkrutskikh

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Add support for global rules-exclude
 * Add `Halstead Volume` metric.
+* Add ability to configure anti-pattern severity
 
 ## 4.2.1
 

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -208,14 +208,9 @@ class MetricsAnalyzerPlugin extends ServerPlugin {
 
       if (report != null) {
         result.addAll([
-          ...report.issues
-              .map((issue) =>
-                  codeIssueToAnalysisErrorFixes(issue, analysisResult))
-              .toList(),
-          ...report.antiPatternCases
-              .map(designIssueToAnalysisErrorFixes)
-              .toList(),
-        ]);
+          ...report.issues,
+          ...report.antiPatternCases,
+        ].map((issue) => codeIssueToAnalysisErrorFixes(issue, analysisResult)));
       }
 
       // Temporary disable deprecation check

lib/src/analyzer_plugin/analyzer_plugin_utils.dart

@@ -58,26 +58,6 @@ plugin.AnalysisErrorFixes codeIssueToAnalysisErrorFixes(
   );
 }
 
-plugin.AnalysisErrorFixes designIssueToAnalysisErrorFixes(Issue issue) =>
-    plugin.AnalysisErrorFixes(plugin.AnalysisError(
-      plugin.AnalysisErrorSeverity.INFO,
-      plugin.AnalysisErrorType.HINT,
-      plugin.Location(
-        uriToPath(issue.location.sourceUrl) ?? '',
-        issue.location.start.offset,
-        issue.location.length,
-        issue.location.start.line,
-        issue.location.start.column,
-        endLine: issue.location.end.line,
-        endColumn: issue.location.end.column,
-      ),
-      issue.message,
-      issue.ruleId,
-      correction: issue.verboseMessage,
-      url: issue.documentation.toString(),
-      hasFix: false,
-    ));
-
 plugin.AnalysisErrorFixes metricReportToAnalysisErrorFixes(
   SourceLocation startLocation,
   int length,

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_method.dart

@@ -2,13 +2,15 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/type.dart';
 
 import '../../../../utils/node_utils.dart';
+import '../../lint_utils.dart';
 import '../../metrics/metric_utils.dart';
 import '../../metrics/metrics_list/source_lines_of_code/source_code_visitor.dart';
 import '../../metrics/metrics_list/source_lines_of_code/source_lines_of_code_metric.dart';
 import '../../models/entity_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/scoped_function_declaration.dart';
+import '../../models/severity.dart';
 import '../../rules/flutter_rule_utils.dart';
 import '../models/obsolete_pattern.dart';
 import '../models/pattern_documentation.dart';
@@ -17,7 +19,7 @@ import '../pattern_utils.dart';
 class LongMethod extends ObsoletePattern {
   static const String patternId = 'long-method';
 
-  LongMethod()
+  LongMethod([Map<String, Object> config = const {}])
       : super(
           id: patternId,
           documentation: const PatternDocumentation(
@@ -26,6 +28,7 @@ class LongMethod extends ObsoletePattern {
                 'Long blocks of code are difficult to reuse and understand because they are usually responsible for more than one thing. Separating those to several short ones with proper names helps you reuse your code and understand it better without reading methods body.',
             supportedType: EntityType.methodEntity,
           ),
+          severity: readSeverity(config, Severity.none),
         );
 
   @override

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_parameter_list.dart

@@ -1,19 +1,21 @@
 import '../../../../utils/node_utils.dart';
+import '../../lint_utils.dart';
 import '../../metrics/metric_utils.dart';
 import '../../metrics/metrics_list/number_of_parameters_metric.dart';
 import '../../models/entity_type.dart';
 import '../../models/function_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/scoped_function_declaration.dart';
+import '../../models/severity.dart';
 import '../models/obsolete_pattern.dart';
 import '../models/pattern_documentation.dart';
 import '../pattern_utils.dart';
 
 class LongParameterList extends ObsoletePattern {
   static const String patternId = 'long-parameter-list';
 
-  LongParameterList()
+  LongParameterList([Map<String, Object> config = const {}])
       : super(
           id: patternId,
           documentation: const PatternDocumentation(
@@ -22,6 +24,7 @@ class LongParameterList extends ObsoletePattern {
                 'Long parameter lists are difficult to understand and use. Wrapping them into an object allows grouping parameters and change transferred data only by the object modification.',
             supportedType: EntityType.methodEntity,
           ),
+          severity: readSeverity(config, Severity.none),
         );
 
   @override

lib/src/analyzers/lint_analyzer/anti_patterns/models/obsolete_pattern.dart

@@ -2,16 +2,19 @@ import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/report.dart';
 import '../../models/scoped_function_declaration.dart';
+import '../../models/severity.dart';
 import 'pattern.dart';
 import 'pattern_documentation.dart';
 
 abstract class ObsoletePattern extends Pattern {
   const ObsoletePattern({
     required String id,
     required PatternDocumentation documentation,
+    required Severity severity,
   }) : super(
           id: id,
           documentation: documentation,
+          severity: severity,
         );
 
   Iterable<Issue> legacyCheck(

lib/src/analyzers/lint_analyzer/anti_patterns/models/pattern.dart

@@ -1,6 +1,7 @@
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/report.dart';
+import '../../models/severity.dart';
 import 'pattern_documentation.dart';
 
 /// An interface to communicate with a patterns
@@ -13,9 +14,13 @@ abstract class Pattern {
   /// The documentation associated with the pattern
   final PatternDocumentation documentation;
 
+  /// The severity of issues emitted by the pattern
+  final Severity severity;
+
   const Pattern({
     required this.id,
     required this.documentation,
+    required this.severity,
   });
 
   /// Returns [Iterable] with [Issue]'s detected while check the passed [source]

lib/src/analyzers/lint_analyzer/anti_patterns/pattern_utils.dart

@@ -3,7 +3,6 @@ import 'package:source_span/source_span.dart';
 
 import '../models/issue.dart';
 import '../models/scoped_function_declaration.dart';
-import '../models/severity.dart';
 import 'models/pattern.dart';
 
 Issue createIssue({
@@ -16,7 +15,7 @@ Issue createIssue({
       ruleId: pattern.id,
       documentation: documentation(pattern),
       location: location,
-      severity: Severity.none,
+      severity: pattern.severity,
       message: message,
       verboseMessage: verboseMessage,
     );

lib/src/analyzers/lint_analyzer/anti_patterns/patterns_factory.dart

@@ -4,8 +4,8 @@ import 'models/obsolete_pattern.dart';
 
 final _implementedPatterns =
     <String, ObsoletePattern Function(Map<String, Object>)>{
-  LongMethod.patternId: (config) => LongMethod(),
-  LongParameterList.patternId: (config) => LongParameterList(),
+  LongMethod.patternId: (config) => LongMethod(config),
+  LongParameterList.patternId: (config) => LongParameterList(config),
 };
 
 Iterable<ObsoletePattern> get allPatterns =>

lib/src/analyzers/lint_analyzer/lint_utils.dart

@@ -0,0 +1,5 @@
+import 'models/severity.dart';
+
+/// Returns a [Severity] from map based [config] otherwise [defaultValue]
+Severity readSeverity(Map<String, Object?> config, Severity defaultValue) =>
+    Severity.fromString(config['severity'] as String?) ?? defaultValue;