add exclude params support to avoid_returning_widgets rule (#162)

* add exclude params support to avoid_returning_widgets rule

* refactor and fix class ignore `avoid_returning_widgets` rule

Author: 4akloon

lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart

@@ -1,7 +1,9 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/error/listener.dart';
+import 'package:collection/collection.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
 import 'package:solid_lints/src/utils/types_utils.dart';
@@ -48,7 +50,8 @@ import 'package:solid_lints/src/utils/types_utils.dart';
 ///   }
 /// }
 /// ```
-class AvoidReturningWidgetsRule extends SolidLintRule {
+class AvoidReturningWidgetsRule
+    extends SolidLintRule<AvoidReturningWidgetsParameters> {
   /// The [LintCode] of this lint rule that represents
   /// the error whether we return a widget.
   static const lintName = 'avoid_returning_widgets';
@@ -61,6 +64,7 @@ class AvoidReturningWidgetsRule extends SolidLintRule {
     final rule = RuleConfig(
       configs: configs,
       name: lintName,
+      paramsParser: AvoidReturningWidgetsParameters.fromJson,
       problemMessage: (_) =>
           'Returning a widget from a function is considered an anti-pattern. '
           'Unless you are overriding an existing method, '
@@ -92,11 +96,34 @@ class AvoidReturningWidgetsRule extends SolidLintRule {
 
       final isWidgetReturned = hasWidgetType(returnType);
 
+      final isIgnored = _shouldIgnore(node);
+
       final isOverriden = node.declaredElement?.hasOverride ?? false;
 
-      if (isWidgetReturned && !isOverriden) {
+      if (isWidgetReturned && !isOverriden && !isIgnored) {
         reporter.reportErrorForNode(code, node);
       }
     });
   }
+
+  bool _shouldIgnore(Declaration node) {
+    final methodName = node.declaredElement?.name;
+
+    final excludedItem = config.parameters.exclude
+        .firstWhereOrNull((e) => e.methodName == methodName);
+
+    if (excludedItem == null) return false;
+
+    final className = excludedItem.className;
+
+    if (className == null || node is! MethodDeclaration) {
+      return true;
+    } else {
+      final classDeclaration = node.thisOrAncestorOfType<ClassDeclaration>();
+
+      if (classDeclaration == null) return false;
+
+      return classDeclaration.name.toString() == className;
+    }
+  }
 }

lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_exclude.dart

@@ -0,0 +1,24 @@
+/// Model class for AvoidReturningWidgetsExclude parameters
+class AvoidReturningWidgetsExclude {
+  /// The name of the method that should be excluded from the lint.
+  final String methodName;
+
+  /// The name of the class that should be excluded from the lint.
+  final String? className;
+
+  /// Constructor for [AvoidReturningWidgetsExclude] model
+  const AvoidReturningWidgetsExclude({
+    required this.methodName,
+    required this.className,
+  });
+
+  ///
+  factory AvoidReturningWidgetsExclude.fromJson(
+    Map<dynamic, dynamic> json,
+  ) {
+    return AvoidReturningWidgetsExclude(
+      methodName: json['method_name'] as String,
+      className: json['class_name'] as String?,
+    );
+  }
+}

lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart

@@ -0,0 +1,28 @@
+import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_exclude.dart';
+
+/// A data model class that represents the "avoid returning widgets" input
+/// parameters.
+class AvoidReturningWidgetsParameters {
+  /// A list of methods that should be excluded from the lint.
+  final List<AvoidReturningWidgetsExclude> exclude;
+
+  /// Constructor for [AvoidReturningWidgetsParameters] model
+  AvoidReturningWidgetsParameters({
+    required this.exclude,
+  });
+
+  /// Method for creating from json data
+  factory AvoidReturningWidgetsParameters.fromJson(Map<String, dynamic> json) {
+    final exclude = <AvoidReturningWidgetsExclude>[];
+
+    final excludeList = json['exclude'] as Iterable? ?? [];
+    for (final item in excludeList) {
+      if (item is Map) {
+        exclude.add(AvoidReturningWidgetsExclude.fromJson(item));
+      }
+    }
+    return AvoidReturningWidgetsParameters(
+      exclude: exclude,
+    );
+  }
+}

lint_test/avoid_returning_widget_test/analysis_options.yaml

@@ -0,0 +1,11 @@
+analyzer:
+  plugins:
+    - ../custom_lint
+
+custom_lint:
+  rules:
+    - avoid_returning_widgets:
+      exclude:
+        - method_name: excludeWidgetMethod
+          class_name: ExcludeWidget
+        - method_name: excludeMethod

…nt_test/avoid_returning_widget_test.dart …et_test/avoid_returning_widget_test.dartlint_test/avoid_returning_widget_test.dart renamed to lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart lint_test/avoid_returning_widget_test.dart renamed to lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart

@@ -64,3 +64,31 @@ class MyWidget extends BaseWidget {
 Widget build() {
   return Offstage();
 }
+
+SizedBox excludeMethod() => const SizedBox();
+
+class ExcludeWidget extends StatelessWidget {
+  const ExcludeWidget({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return const Placeholder();
+  }
+
+  Widget excludeWidgetMethod() => const SizedBox();
+
+  // expect_lint: avoid_returning_widgets
+  Widget excludeWidgetMethod2() => const SizedBox();
+}
+
+class NotExcludeWidget extends StatelessWidget {
+  const NotExcludeWidget({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return const Placeholder();
+  }
+
+  // expect_lint: avoid_returning_widgets
+  Widget excludeWidgetMethod() => const SizedBox();
+}