issue-167. added exclude params to some rules

shaark · shaark · commit b631295f1194 · 2024-12-05T10:45:00.000+02:00
diff --git a/lib/src/common/parameters/excluded_identifier_parameter.dart b/lib/src/common/parameters/excluded_identifier_parameter.dart
diff --git a/lib/src/common/parameters/excluded_identifiers_list_parameter.dart b/lib/src/common/parameters/excluded_identifiers_list_parameter.dart
@@ -1,9 +1,9 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:collection/collection.dart';
-import 'package:solid_lints/src/models/excluded_identifier_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifier_parameter.dart';
 
-/// A data model class that represents the exclude input
-/// parameters.
+/// A model representing "exclude" parameters for linting, defining
+/// identifiers (classes, methods, functions) to be ignored during analysis.
 class ExcludedIdentifiersListParameter {
   /// A list of identifiers (classes, methods, functions) that should be
   /// excluded from the lint.
@@ -33,12 +33,34 @@ class ExcludedIdentifiersListParameter {
     );
   }
 
+  /// Method for creating from json data with default params
+  factory ExcludedIdentifiersListParameter.defaultFromJson(
+    Map<String, dynamic> json,
+  ) {
+    final exclude = <ExcludedIdentifierParameter>[];
+
+    final excludeList =
+        json[ExcludedIdentifiersListParameter.excludeParameterName]
+                as Iterable? ??
+            [];
+
+    for (final item in excludeList) {
+      if (item is Map) {
+        exclude.add(ExcludedIdentifierParameter.fromJson(item));
+      }
+    }
+    return ExcludedIdentifiersListParameter(
+      exclude: exclude,
+    );
+  }
+
   /// Returns whether the target node should be ignored during analysis.
   bool shouldIgnore(Declaration node) {
     final methodName = node.declaredElement?.name;
 
-    final excludedItem =
-        exclude.firstWhereOrNull((e) => e.methodName == methodName);
+    final excludedItem = exclude.firstWhereOrNull(
+      (e) => e.methodName == methodName || e.className == methodName,
+    );
 
     if (excludedItem == null) return false;
 
diff --git a/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart b/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// A data model class that represents the "avoid returning widgets" input
 /// parameters.
@@ -14,10 +14,7 @@ class AvoidReturningWidgetsParameters {
   /// Method for creating from json data
   factory AvoidReturningWidgetsParameters.fromJson(Map<String, dynamic> json) {
     return AvoidReturningWidgetsParameters(
-      exclude: ExcludedIdentifiersListParameter.fromJson(
-        excludeList:
-            json[ExcludedIdentifiersListParameter.excludeParameterName] as Iterable? ?? [],
-      ),
+      exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
     );
   }
 }
diff --git a/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart b/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart
@@ -1,3 +1,4 @@
+
 import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:solid_lints/src/lints/avoid_unused_parameters/models/avoid_unused_parameters.dart';
@@ -93,19 +94,17 @@ class AvoidUnusedParametersRule extends SolidLintRule<AvoidUnusedParameters> {
     ErrorReporter reporter,
     CustomLintContext context,
   ) {
-    context.registry.addCompilationUnit((node) {
-      context.registry.addDeclaration((declarationNode) {
-        final isIgnored =
-            config.parameters.exclude.shouldIgnore(declarationNode);
+    context.registry.addDeclaration((node) {
+      final isIgnored = config.parameters.exclude.shouldIgnore(node);
+      
+      if (!isIgnored) {
         final visitor = AvoidUnusedParametersVisitor();
         node.accept(visitor);
 
-        if (!isIgnored) {
-          for (final element in visitor.unusedParameters) {
-            reporter.atNode(element, code);
-          }
+        for (final element in visitor.unusedParameters) {
+          reporter.atNode(element, code);
         }
-      });
+      }
     });
   }
 }
diff --git a/lib/src/lints/avoid_unused_parameters/models/avoid_unused_parameters.dart b/lib/src/lints/avoid_unused_parameters/models/avoid_unused_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// A data model class that represents the "avoid returning widgets" input
 /// parameters.
@@ -14,10 +14,7 @@ class AvoidUnusedParameters {
   /// Method for creating from json data
   factory AvoidUnusedParameters.fromJson(Map<String, dynamic> json) {
     return AvoidUnusedParameters(
-      exclude: ExcludedIdentifiersListParameter.fromJson(
-        excludeList:
-            json[ExcludedIdentifiersListParameter.excludeParameterName] as Iterable? ?? [],
-      ),
+      exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
     );
   }
 }
diff --git a/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart b/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart
@@ -51,17 +51,18 @@ class CyclomaticComplexityRule
     ErrorReporter reporter,
     CustomLintContext context,
   ) {
-    context.registry.addDeclaration((declarationNode) {
-      context.registry.addBlockFunctionBody((node) {
+    context.registry.addBlockFunctionBody((node) {
+      context.registry.addDeclaration((declarationNode) {
         final isIgnored =
             config.parameters.exclude.shouldIgnore(declarationNode);
-        final visitor = CyclomaticComplexityFlowVisitor();
-        node.visitChildren(visitor);
+        if (!isIgnored) {
+          final visitor = CyclomaticComplexityFlowVisitor();
+          node.visitChildren(visitor);
 
-        if (!isIgnored &&
-            visitor.complexityEntities.length + 1 >
-                config.parameters.maxComplexity) {
-          reporter.atNode(node, code);
+          if (visitor.complexityEntities.length + 1 >
+              config.parameters.maxComplexity) {
+            reporter.atNode(node, code);
+          }
         }
       });
     });
diff --git a/lib/src/lints/cyclomatic_complexity/models/cyclomatic_complexity_parameters.dart b/lib/src/lints/cyclomatic_complexity/models/cyclomatic_complexity_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// Cyclomatic complexity metric limits configuration.
 class CyclomaticComplexityParameters {
@@ -21,11 +21,6 @@ class CyclomaticComplexityParameters {
   factory CyclomaticComplexityParameters.fromJson(Map<String, Object?> json) =>
       CyclomaticComplexityParameters(
         maxComplexity: json['max_complexity'] as int? ?? _defaultMaxComplexity,
-        exclude: ExcludedIdentifiersListParameter.fromJson(
-          excludeList:
-              json[ExcludedIdentifiersListParameter.excludeParameterName]
-                      as Iterable? ??
-                  [],
-        ),
+        exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
       );
 }
diff --git a/lib/src/lints/function_lines_of_code/models/function_lines_of_code_parameters.dart b/lib/src/lints/function_lines_of_code/models/function_lines_of_code_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// A data model class that represents the "function lines of code" input
 /// parameters.
@@ -22,11 +22,6 @@ class FunctionLinesOfCodeParameters {
   factory FunctionLinesOfCodeParameters.fromJson(Map<String, Object?> json) =>
       FunctionLinesOfCodeParameters(
         maxLines: json['max_lines'] as int? ?? _defaultMaxLines,
-        exclude: ExcludedIdentifiersListParameter.fromJson(
-          excludeList:
-              json[ExcludedIdentifiersListParameter.excludeParameterName]
-                      as Iterable? ??
-                  [],
-        ),
+        exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
       );
 }
diff --git a/lib/src/lints/no_empty_block/models/no_empty_block_parameters.dart b/lib/src/lints/no_empty_block/models/no_empty_block_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// A data model class that represents the "avoid returning widgets" input
 /// parameters.
@@ -14,11 +14,7 @@ class NoEmptyBlockParameters {
   /// Method for creating from json data
   factory NoEmptyBlockParameters.fromJson(Map<String, dynamic> json) {
     return NoEmptyBlockParameters(
-      exclude: ExcludedIdentifiersListParameter.fromJson(
-        excludeList: json[ExcludedIdentifiersListParameter.excludeParameterName]
-                as Iterable? ??
-            [],
-      ),
+      exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
     );
   }
 }
diff --git a/lib/src/lints/no_empty_block/no_empty_block_rule.dart b/lib/src/lints/no_empty_block/no_empty_block_rule.dart
@@ -77,19 +77,16 @@ class NoEmptyBlockRule extends SolidLintRule<NoEmptyBlockParameters> {
     ErrorReporter reporter,
     CustomLintContext context,
   ) {
-    context.registry.addCompilationUnit((node) {
-      context.registry.addDeclaration((declarationNode) {
-        final isIgnored =
-            config.parameters.exclude.shouldIgnore(declarationNode);
+    context.registry.addDeclaration((node) {
+      final isIgnored = config.parameters.exclude.shouldIgnore(node);
+      if (!isIgnored) {
         final visitor = NoEmptyBlockVisitor();
         node.accept(visitor);
-        
-        if (!isIgnored) {
-          for (final emptyBlock in visitor.emptyBlocks) {
-            reporter.atNode(emptyBlock, code);
-          }
+
+        for (final emptyBlock in visitor.emptyBlocks) {
+          reporter.atNode(emptyBlock, code);
         }
-      });
+      }
     });
   }
 }
diff --git a/lib/src/lints/number_of_parameters/models/number_of_parameters_parameters.dart b/lib/src/lints/number_of_parameters/models/number_of_parameters_parameters.dart
@@ -1,4 +1,4 @@
-import 'package:solid_lints/src/models/excluded_identifiers_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 
 /// A data model class that represents the "number of parameters" input
 /// parameters.
@@ -21,11 +21,6 @@ class NumberOfParametersParameters {
   factory NumberOfParametersParameters.fromJson(Map<String, Object?> json) =>
       NumberOfParametersParameters(
         maxParameters: json['max_parameters'] as int? ?? _defaultMaxParameters,
-        exclude: ExcludedIdentifiersListParameter.fromJson(
-          excludeList:
-              json[ExcludedIdentifiersListParameter.excludeParameterName]
-                      as Iterable? ??
-                  [],
-        ),
+        exclude: ExcludedIdentifiersListParameter.defaultFromJson(json),
       );
 }
diff --git a/lint_test/analysis_options.yaml b/lint_test/analysis_options.yaml
@@ -6,23 +6,43 @@ custom_lint:
   rules:
     - cyclomatic_complexity:
       max_complexity: 4
+      exclude:
+        - method_name: excludeMethod
+          class_name: Exclude
+        - method_name: excludeMethod      
     - number_of_parameters:
       max_parameters: 2
+      exclude:
+        - method_name: avoidNumberOfParameters
+          class_name: Exclude
+        - method_name: avoidNumberOfParameters          
     - function_lines_of_code:
       max_lines: 50
     - avoid_non_null_assertion
     - avoid_late_keyword:
       allow_initialized: true
     - avoid_global_state
-    - avoid_returning_widgets
+    - avoid_returning_widgets:
+      exclude:
+        - method_name: excludeWidgetMethod
+          class_name: ExcludeWidget
+        - method_name: excludeMethod
     - avoid_unnecessary_setstate
     - double_literal_format
     - avoid_unnecessary_type_assertions
     - avoid_unnecessary_type_casts
     - avoid_unrelated_type_assertions
-    - avoid_unused_parameters
+    - avoid_unused_parameters:
+      exclude:
+        - method_name: excludeMethod
+          class_name: Exclude
+        - method_name: excludeMethod
     - newline_before_return
-    - no_empty_block
+    - no_empty_block:
+      exclude:
+        - method_name: excludeMethod
+          class_name: Exclude
+        - method_name: excludeMethod
     - no_equal_then_else
     - avoid_debug_print_in_release
     - prefer_early_return
diff --git a/lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart b/lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart
@@ -65,7 +65,7 @@ Widget build() {
   return Offstage();
 }
 
-// expect_lint: avoid_returning_widgets
+// no lint
 SizedBox excludeMethod() => const SizedBox();
 
 class ExcludeWidget extends StatelessWidget {
@@ -76,7 +76,7 @@ class ExcludeWidget extends StatelessWidget {
     return const Placeholder();
   }
 
-  // expect_lint: avoid_returning_widgets
+  // no lint
   Widget excludeWidgetMethod() => const SizedBox();
 
   // expect_lint: avoid_returning_widgets
diff --git a/lint_test/avoid_unused_parameters_test.dart b/lint_test/avoid_unused_parameters_test.dart
@@ -207,3 +207,20 @@ class UsingConstructorParameterInInitializer {
     print(_value);
   }
 }
+
+// no lint
+void excludeMethod(String s) {
+  return;
+}
+
+class Exclude {
+  // no lint
+  void excludeMethod(String s) {
+    return;
+  }
+
+// expect_lint: avoid_unused_parameters
+  void excludeMethod2(String s) {
+    return;
+  }
+}
diff --git a/lint_test/avoid_unused_parameters_test/analysis_options.yaml b/lint_test/avoid_unused_parameters_test/analysis_options.yaml
@@ -0,0 +1,11 @@
+analyzer:
+  plugins:
+    - ../custom_lint
+
+custom_lint:
+  rules:
+    - avoid_unused_parameters:
+      exclude:
+        - method_name: excludeMethod
+          class_name: Exclude
+        - method_name: excludeMethod
diff --git a/lint_test/cyclomatic_complexity_test.dart b/lint_test/cyclomatic_complexity_test.dart
@@ -31,3 +31,27 @@ class A {
     if (true) {}
   }
 }
+
+// no lint
+void excludeMethod() {
+  if (true) {
+    if (true) {
+      if (true) {
+        if (true) {}
+      }
+    }
+  }
+}
+
+class Exclude {
+  // no lint
+  void excludeMethod() {
+    if (true) {
+      if (true) {
+        if (true) {
+          if (true) {}
+        }
+      }
+    }
+  }
+}
diff --git a/lint_test/function_lines_of_code_test/analysis_options.yaml b/lint_test/function_lines_of_code_test/analysis_options.yaml
@@ -6,6 +6,6 @@ custom_lint:
   rules:
     - function_lines_of_code:
       max_lines: 5
-      excludeNames:
-        - "longFunctionExcluded"
-        - "longMethodExcluded"
+      exclude:
+         - method_name: longFunctionExcluded
+         - method_name: longMethodExcluded
diff --git a/lint_test/no_empty_block_test.dart b/lint_test/no_empty_block_test.dart
@@ -49,3 +49,11 @@ class A {
     // TODO: implement toDoMethod
   }
 }
+
+// no lint
+void excludeMethod() {}
+
+class Exclude {
+  // no lint
+  void excludeMethod() {}
+}
diff --git a/lint_test/number_of_parameters_test.dart b/lint_test/number_of_parameters_test.dart
