refactor: migrate avoid_returning_widgets rule

lib/main.dart

@@ -4,6 +4,8 @@ import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.
 import 'package:solid_lints/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart';
 import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule.dart';
 import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart';
+import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart';
+import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart';
 import 'package:solid_lints/src/lints/double_literal_format/double_literal_format_rule.dart';
 import 'package:solid_lints/src/lints/double_literal_format/fixes/double_literal_format_fix.dart';
 import 'package:solid_lints/src/lints/proper_super_calls/proper_super_calls_rule.dart';
@@ -33,6 +35,10 @@ class SolidLintsPlugin extends Plugin {
       AvoidDebugPrintInReleaseRule(),
       doubleLiteralFormatRule,
       ProperSuperCallsRule(),
+      AvoidReturningWidgetsRule(
+        analysisOptionsLoader: analysisLoader,
+        parametersParser: AvoidReturningWidgetsParameters.fromJson,
+      ),
       // TODO: Add more lint rules and use analysisLoader
       // for rules that need parameters
       // For example: `CyclomaticComplexityRule(analysisLoader)`

lib/src/common/parameters/excluded_identifiers_list_parameter.dart

@@ -82,7 +82,7 @@ class ExcludedIdentifiersListParameter {
       final classDeclaration = node.thisOrAncestorOfType<ClassDeclaration>();
 
       return classDeclaration != null &&
-          classDeclaration.name.toString() == className;
+          classDeclaration.namePart.typeName.lexeme == className;
     }
   }
 }

lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart

@@ -1,11 +1,9 @@
-import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/dart/element/type.dart';
-import 'package:analyzer/error/listener.dart';
-import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:analyzer/analysis_rule/rule_context.dart';
+import 'package:analyzer/analysis_rule/rule_visitor_registry.dart';
+import 'package:analyzer/error/error.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/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
-import 'package:solid_lints/src/utils/types_utils.dart';
 
 /// A rule which warns about returning widgets from functions and methods.
 ///
@@ -54,64 +52,38 @@ class AvoidReturningWidgetsRule
   /// This lint rule represents
   /// the error whether we return a widget.
   static const lintName = 'avoid_returning_widgets';
-  static const _override = 'override';
 
-  AvoidReturningWidgetsRule._(super.config);
+  static const _code = LintCode(
+    lintName,
+    'Returning a widget from a function is considered an anti-pattern. '
+    'Unless you are overriding an existing method, '
+    'consider extracting your widget to a separate class.',
+  );
 
-  /// Creates a new instance of [AvoidReturningWidgetsRule]
-  /// based on the lint configuration.
-  factory AvoidReturningWidgetsRule.createRule(CustomLintConfigs configs) {
-    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, '
-          'consider extracting your widget to a separate class.',
-    );
+  @override
+  DiagnosticCode get diagnosticCode => _code;
 
-    return AvoidReturningWidgetsRule._(rule);
-  }
+  /// Creates a new instance of [AvoidReturningWidgetsRule]
+  AvoidReturningWidgetsRule({
+    required super.analysisOptionsLoader,
+    required super.parametersParser,
+  }) : super.withParameters(
+          name: _code.lowerCaseName,
+          description: _code.problemMessage,
+        );
 
   @override
-  void run(
-    CustomLintResolver resolver,
-    DiagnosticReporter reporter,
-    CustomLintContext context,
+  void registerNodeProcessors(
+    RuleVisitorRegistry registry,
+    RuleContext context,
   ) {
-    context.registry.addDeclaration((node) {
-      // Check if declaration is function or method,
-      // simultaneously checks if return type is [DartType]
-      final DartType? returnType = switch (node) {
-        FunctionDeclaration(returnType: TypeAnnotation(:final type?)) ||
-        MethodDeclaration(returnType: TypeAnnotation(:final type?)) =>
-          type,
-        _ => null,
-      };
-
-      if (returnType == null) {
-        return;
-      }
-
-      final isWidgetReturned = hasWidgetType(returnType);
+    super.registerNodeProcessors(registry, context);
 
-      final isIgnored = config.parameters.exclude.shouldIgnore(node);
+    final parameters = getParametersForContext(context) ??
+        AvoidReturningWidgetsParameters.empty();
 
-      final isOverriden = switch (node) {
-        FunctionDeclaration(:final functionExpression) =>
-          functionExpression.parent is MethodDeclaration &&
-              (functionExpression.parent! as MethodDeclaration)
-                  .metadata
-                  .any((m) => m.name.name == _override),
-        MethodDeclaration(:final metadata) =>
-          metadata.any((m) => m.name.name == _override),
-        _ => false,
-      };
+    final visitor = AvoidReturningWidgetsVisitor(this, parameters);
 
-      if (isWidgetReturned && !isOverriden && !isIgnored) {
-        reporter.atNode(node, code);
-      }
-    });
+    registry.addCompilationUnit(this, visitor);
   }
 }

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

@@ -11,6 +11,13 @@ class AvoidReturningWidgetsParameters {
     required this.exclude,
   });
 
+  /// Empty [AvoidReturningWidgetsParameters] model, excludes nothing.
+  factory AvoidReturningWidgetsParameters.empty() {
+    return AvoidReturningWidgetsParameters(
+      exclude: ExcludedIdentifiersListParameter(exclude: []),
+    );
+  }
+
   /// Method for creating from json data
   factory AvoidReturningWidgetsParameters.fromJson(Map<String, dynamic> json) {
     return AvoidReturningWidgetsParameters(

lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart

@@ -0,0 +1,84 @@
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/type.dart';
+import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart';
+import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart';
+import 'package:solid_lints/src/utils/types_utils.dart';
+
+/// A visitor that reports on functions that return widgets.
+class AvoidReturningWidgetsVisitor extends RecursiveAstVisitor<void> {
+  final AvoidReturningWidgetsRule _rule;
+  final AvoidReturningWidgetsParameters _parameters;
+
+  /// Creates a new instance of [AvoidReturningWidgetsVisitor]
+  AvoidReturningWidgetsVisitor(this._rule, this._parameters);
+
+  @override
+  void visitFunctionDeclaration(FunctionDeclaration node) {
+    super.visitFunctionDeclaration(node);
+
+    _visitDeclaration(node);
+  }
+
+  @override
+  void visitMethodDeclaration(MethodDeclaration node) {
+    super.visitMethodDeclaration(node);
+
+    _visitDeclaration(node);
+  }
+
+  @override
+  void visitFunctionDeclarationStatement(FunctionDeclarationStatement node) {
+    super.visitFunctionDeclarationStatement(node);
+
+    _visitDeclaration(node.functionDeclaration);
+  }
+
+  void _visitDeclaration(Declaration node) {
+    if (node is! FunctionDeclaration && node is! MethodDeclaration) {
+      return;
+    }
+
+    final returnType = switch (node) {
+      Declaration(
+        declaredFragment: ExecutableFragment(
+          element: ExecutableElement(type: FunctionType(:final returnType))
+        )
+      ) =>
+        returnType,
+      MethodDeclaration(returnType: TypeAnnotation(:final type)) => type,
+      FunctionDeclaration(returnType: TypeAnnotation(:final type)) => type,
+      _ => null,
+    };
+    if (returnType == null) return;
+
+    final isWidgetReturned = hasWidgetType(returnType);
+    if (!isWidgetReturned) return;
+
+    final isIgnored = _parameters.exclude.shouldIgnore(node);
+    if (isIgnored) return;
+
+    if (_isOverridden(node)) return;
+
+    _rule.reportAtNode(node);
+  }
+
+  bool _isOverridden(Declaration node) {
+    return switch (node) {
+      Declaration(
+        declaredFragment: Fragment(
+          element: Element(
+            name: final String name,
+            enclosingElement: final InterfaceElement enclosingElement
+          )
+        ),
+      ) =>
+        enclosingElement.getInheritedMember(
+              Name.forLibrary(enclosingElement.library, name),
+            ) !=
+            null,
+      _ => false,
+    };
+  }
+}

pubspec.yaml

@@ -20,6 +20,7 @@ dependencies:
   glob: ^2.1.3
   path: ^1.9.1
   yaml: ^3.1.3
+  # These packages are required for pana analysis to run correctly
   test: ^1.25.14
 
 dev_dependencies: