refactor: cleanup rules documentation (#550)

* refactor: remove unused PatternDocumentation

* refactor: remove unused RuleDocumentation

* chore: update changelog

* chore: add some tests

Author: dkrutskikh

CHANGELOG.md

@@ -3,7 +3,7 @@
 ## Unreleased
 
 * feat: introduce file metrics
-* refactor: cleanup anti-patterns, metrics documentation
+* refactor: cleanup anti-patterns, metrics and rules documentation
 
 ## 4.6.0
 

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

@@ -17,7 +17,6 @@ import '../../models/scoped_function_declaration.dart';
 import '../../models/severity.dart';
 import '../../rules/flutter_rule_utils.dart';
 import '../models/pattern.dart';
-import '../models/pattern_documentation.dart';
 import '../pattern_utils.dart';
 
 class LongMethod extends Pattern {
@@ -37,10 +36,7 @@ class LongMethod extends Pattern {
         ),
         super(
           id: patternId,
-          documentation: const PatternDocumentation(
-            name: 'Long Method',
-            supportedType: EntityType.methodEntity,
-          ),
+          supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
         );
 

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

@@ -14,7 +14,6 @@ import '../../models/scoped_class_declaration.dart';
 import '../../models/scoped_function_declaration.dart';
 import '../../models/severity.dart';
 import '../models/pattern.dart';
-import '../models/pattern_documentation.dart';
 import '../pattern_utils.dart';
 
 class LongParameterList extends Pattern {
@@ -35,10 +34,7 @@ class LongParameterList extends Pattern {
         ),
         super(
           id: patternId,
-          documentation: const PatternDocumentation(
-            name: 'Long Parameter List',
-            supportedType: EntityType.methodEntity,
-          ),
+          supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
         );
 

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

@@ -1,10 +1,10 @@
+import '../../models/entity_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/report.dart';
 import '../../models/scoped_class_declaration.dart';
 import '../../models/scoped_function_declaration.dart';
 import '../../models/severity.dart';
-import 'pattern_documentation.dart';
 
 /// An interface to communicate with a patterns
 ///
@@ -13,8 +13,8 @@ abstract class Pattern {
   /// The id of the pattern.
   final String id;
 
-  /// The documentation associated with the pattern.
-  final PatternDocumentation documentation;
+  /// The type of entities which will be analyzed by the pattern.
+  final EntityType supportedType;
 
   /// The severity of issues emitted by the pattern.
   final Severity severity;
@@ -24,7 +24,7 @@ abstract class Pattern {
 
   const Pattern({
     required this.id,
-    required this.documentation,
+    required this.supportedType,
     required this.severity,
   });
 

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

@@ -1,19 +1,16 @@
 import '../../models/severity.dart';
 import 'rule.dart';
-import 'rule_documentation.dart';
 import 'rule_type.dart';
 
 /// Represents a base class for angular-specific rules.
 abstract class AngularRule extends Rule {
   const AngularRule({
     required String id,
-    required RuleDocumentation documentation,
     required Severity severity,
     required Iterable<String> excludes,
   }) : super(
           id: id,
           type: RuleType.angular,
-          documentation: documentation,
           severity: severity,
           excludes: excludes,
         );

lib/src/analyzers/lint_analyzer/rules/models/angular_rule.dart

@@ -1,19 +1,16 @@
 import '../../models/severity.dart';
 import 'rule.dart';
-import 'rule_documentation.dart';
 import 'rule_type.dart';
 
 /// Represents a base class for common rules.
 abstract class CommonRule extends Rule {
   const CommonRule({
     required String id,
-    required RuleDocumentation documentation,
     required Severity severity,
     required Iterable<String> excludes,
   }) : super(
           id: id,
           type: RuleType.common,
-          documentation: documentation,
           severity: severity,
           excludes: excludes,
         );

lib/src/analyzers/lint_analyzer/rules/models/common_rule.dart

@@ -1,19 +1,16 @@
 import '../../models/severity.dart';
 import 'rule.dart';
-import 'rule_documentation.dart';
 import 'rule_type.dart';
 
 /// Represents a base class for Flutter-specific rules.
 abstract class FlutterRule extends Rule {
   const FlutterRule({
     required String id,
-    required RuleDocumentation documentation,
     required Severity severity,
     required Iterable<String> excludes,
   }) : super(
           id: id,
           type: RuleType.flutter,
-          documentation: documentation,
           severity: severity,
           excludes: excludes,
         );

lib/src/analyzers/lint_analyzer/rules/models/flutter_rule.dart

@@ -1,19 +1,16 @@
 import '../../models/severity.dart';
 import 'rule.dart';
-import 'rule_documentation.dart';
 import 'rule_type.dart';
 
 /// Represents a base class for intl-specific rules.
 abstract class IntlRule extends Rule {
   const IntlRule({
     required String id,
-    required RuleDocumentation documentation,
     required Severity severity,
     required Iterable<String> excludes,
   }) : super(
           id: id,
           type: RuleType.intl,
-          documentation: documentation,
           severity: severity,
           excludes: excludes,
         );

lib/src/analyzers/lint_analyzer/rules/models/intl_rule.dart

@@ -1,7 +1,6 @@
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/severity.dart';
-import 'rule_documentation.dart';
 import 'rule_type.dart';
 
 /// An interface to communicate with a rules
@@ -14,9 +13,6 @@ abstract class Rule {
   /// The type of the rule.
   final RuleType type;
 
-  /// The documentation associated with the rule
-  final RuleDocumentation documentation;
-
   /// The severity of issues emitted by the rule
   final Severity severity;
 
@@ -27,7 +23,6 @@ abstract class Rule {
   const Rule({
     required this.id,
     required this.type,
-    required this.documentation,
     required this.severity,
     required this.excludes,
   });