Add conversion assists for various widgets, including Hook-based widgets

packages/riverpod_lint/lib/riverpod_lint.dart

@@ -1,7 +1,8 @@
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 
-import 'src/assists/convert_to_consumer_stateful_widget.dart';
-import 'src/assists/convert_to_consumer_widget.dart';
+import 'src/assists/convert_to_stateful_base_widget.dart';
+import 'src/assists/convert_to_stateless_base_widget.dart';
+import 'src/assists/convert_to_widget_utils.dart';
 import 'src/assists/stateful_to_stateless_provider.dart';
 import 'src/assists/stateless_to_stateful_provider.dart';
 import 'src/assists/wrap_with_consumer.dart';
@@ -56,8 +57,16 @@ class _RiverpodPlugin extends PluginBase {
   List<Assist> getAssists() => [
         WrapWithConsumer(),
         WrapWithProviderScope(),
-        ConvertToConsumerWidget(),
-        ConvertToConsumerStatefulWidget(),
+        ...StatelessBaseWidgetType.values.map(
+          (targetWidget) => ConvertToStatelessBaseWidget(
+            targetWidget: targetWidget,
+          ),
+        ),
+        ...StatefulBaseWidgetType.values.map(
+          (targetWidget) => ConvertToStatefulBaseWidget(
+            targetWidget: targetWidget,
+          ),
+        ),
 
 // StateProvider to SyncStatefulProvider
 // convert FutureProvider <> AsyncNotifierProvider

packages/riverpod_lint/lib/src/assists/convert_to_consumer_stateful_widget.dart → packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart

@@ -5,32 +5,22 @@ import 'package:analyzer/src/generated/source.dart' show Source;
 import 'package:collection/collection.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 
-import '../object_utils.dart';
 import '../riverpod_custom_lint.dart';
-import 'convert_to_consumer_widget.dart';
-
-const statefulConvertPriority = convertPriority - 1;
-
-const _statelessBaseType = TypeChecker.any([
-  TypeChecker.fromName('StatelessWidget', packageName: 'flutter'),
-  TypeChecker.fromName('ConsumerWidget', packageName: 'flutter_riverpod'),
-  TypeChecker.fromName('HookConsumerWidget', packageName: 'hooks_riverpod'),
-  TypeChecker.fromName('HookWidget', packageName: 'flutter_hooks'),
-]);
-
-const _statefulBaseType = TypeChecker.any([
-  TypeChecker.fromName('StatefulWidget', packageName: 'flutter'),
-  TypeChecker.fromName(
-    'StatefulHookConsumerWidget',
-    packageName: 'hooks_riverpod',
-  ),
-  TypeChecker.fromName('StatefulHookWidget', packageName: 'flutter_hooks'),
-]);
-
-const _stateType = TypeChecker.fromName('State', packageName: 'flutter');
-
-class ConvertToConsumerStatefulWidget extends RiverpodAssist {
-  ConvertToConsumerStatefulWidget();
+import 'convert_to_widget_utils.dart';
+
+class ConvertToStatefulBaseWidget extends RiverpodAssist {
+  ConvertToStatefulBaseWidget({
+    required this.targetWidget,
+  });
+  final StatefulBaseWidgetType targetWidget;
+  late final statelessBaseType = getStatelessBaseType(
+    exclude: targetWidget == StatefulBaseWidgetType.statefulWidget
+        ? StatelessBaseWidgetType.statelessWidget
+        : null,
+  );
+  late final statefulBaseType = getStatefulBaseType(
+    exclude: targetWidget,
+  );
 
   @override
   void run(
@@ -39,148 +29,146 @@ class ConvertToConsumerStatefulWidget extends RiverpodAssist {
     CustomLintContext context,
     SourceRange target,
   ) {
+    if (targetWidget.needHooksRiverpod &&
+        !context.pubspec.dependencies.keys.contains('hooks_riverpod')) {
+      return;
+    }
+
     context.registry.addExtendsClause((node) {
       // Only offer the assist if hovering the extended type
       if (!node.superclass.sourceRange.intersects(target)) return;
 
       final type = node.superclass.type;
       if (type == null) return;
 
-      if (_statelessBaseType.isExactlyType(type)) {
-        _convertStatelessToConsumerStatefulWidget(reporter, node);
+      if (statelessBaseType.isExactlyType(type)) {
+        _convertStatelessToStatefulWidget(reporter, node);
         return;
       }
 
-      if (_statefulBaseType.isExactlyType(type)) {
-        _convertStatefulToConsumerStatefulWidget(
-          reporter,
-          node,
-          resolver.source,
-        );
+      if (statefulBaseType.isExactlyType(type)) {
+        _convertStatefulToStatefulWidget(reporter, node, resolver.source);
         return;
       }
     });
   }
 
-  void _convertStatefulToConsumerStatefulWidget(
+  void _convertStatelessToStatefulWidget(
     ChangeReporter reporter,
     ExtendsClause node,
-    Source source,
   ) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ConsumerStatefulWidget',
-      priority: statefulConvertPriority,
+      message: 'Convert to ${targetWidget.widgetName}',
+      priority: targetWidget.priority,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        'ConsumerStatefulWidget',
+        targetWidget.widgetName,
       );
 
       final widgetClass = node.thisOrAncestorOfType<ClassDeclaration>();
       if (widgetClass == null) return;
 
-      final stateClass = _findStateClass(widgetClass);
-      if (stateClass == null) return;
-
-      final createStateMethod = widgetClass.members
+      final buildMethod = node
+          .thisOrAncestorOfType<ClassDeclaration>()
+          ?.members
           .whereType<MethodDeclaration>()
-          .firstWhereOrNull((element) => element.name.lexeme == 'createState');
-      if (createStateMethod != null) {
-        final returnTypeString = createStateMethod.returnType?.toSource() ?? '';
-        if (returnTypeString != stateClass.name.lexeme) {
-          // Replace State<MyWidget> with ConsumerState<MyWidget>
-          builder.addSimpleReplacement(
-            createStateMethod.returnType!.sourceRange,
-            'ConsumerState<${widgetClass.name}>',
-          );
-        }
+          .firstWhereOrNull((element) => element.name.lexeme == 'build');
+      if (buildMethod == null) return;
+
+      final createdStateClassName = '_${widgetClass.name.lexeme.public}State';
+      final String baseStateName;
+      switch (targetWidget) {
+        case StatefulBaseWidgetType.consumerStatefulWidget:
+        case StatefulBaseWidgetType.statefulHookConsumerWidget:
+          baseStateName = 'ConsumerState';
+          break;
+        case StatefulBaseWidgetType.statefulHookWidget:
+        case StatefulBaseWidgetType.statefulWidget:
+          baseStateName = 'State';
+          break;
       }
 
-      final stateExtends = stateClass.extendsClause;
-      if (stateExtends != null) {
-        // Replace State<MyWidget> with ConsumerState<MyWidget>
-        builder.addSimpleReplacement(
-          stateExtends.superclass.sourceRange,
-          'ConsumerState<${widgetClass.name}>',
+      // Split the class into two classes right before the build method
+      builder.addSimpleInsertion(buildMethod.offset, '''
+@override
+  $baseStateName<${widgetClass.name.lexeme}> createState() => $createdStateClassName();
+}
+
+class $createdStateClassName extends $baseStateName<${widgetClass.name}> {
+''');
+
+      final buildParams = buildMethod.parameters;
+      // If the build method has a ref, remove it
+      if (buildParams != null && buildParams.parameters.length == 2) {
+        builder.addDeletion(
+          sourceRangeFrom(
+            start: buildParams.parameters.first.end,
+            end: buildParams.rightParenthesis.offset,
+          ),
         );
       }
     });
   }
 
-  ClassDeclaration? _findStateClass(ClassDeclaration widgetClass) {
-    final widgetType = widgetClass.declaredElement?.thisType;
-    if (widgetType == null) return null;
-
-    return widgetClass
-        .thisOrAncestorOfType<CompilationUnit>()
-        ?.declarations
-        .whereType<ClassDeclaration>()
-        .where(
-          // Is the class a state class?
-          (e) =>
-              e.extendsClause?.superclass.type
-                  .let(_stateType.isAssignableFromType) ??
-              false,
-        )
-        .firstWhereOrNull((e) {
-      final stateWidgetType = e
-          .extendsClause?.superclass.typeArguments?.arguments.firstOrNull?.type;
-      if (stateWidgetType == null) return false;
-
-      final checker = TypeChecker.fromStatic(widgetType);
-      return checker.isExactlyType(stateWidgetType);
-    });
-  }
-
-  void _convertStatelessToConsumerStatefulWidget(
+  void _convertStatefulToStatefulWidget(
     ChangeReporter reporter,
     ExtendsClause node,
+    Source source,
   ) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ConsumerStatefulWidget',
-      priority: statefulConvertPriority,
+      message: 'Convert to ${targetWidget.widgetName}',
+      priority: targetWidget.priority,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        'ConsumerStatefulWidget',
+        targetWidget.widgetName,
       );
 
       final widgetClass = node.thisOrAncestorOfType<ClassDeclaration>();
       if (widgetClass == null) return;
 
-      // Now update "build" to take a "ref" parameter
-      final buildMethod = node
-          .thisOrAncestorOfType<ClassDeclaration>()
-          ?.members
-          .whereType<MethodDeclaration>()
-          .firstWhereOrNull((element) => element.name.lexeme == 'build');
-      if (buildMethod == null) return;
-
-      final createdStateClassName = '_${widgetClass.name.lexeme.public}State';
+      final stateClass = findStateClass(widgetClass);
+      if (stateClass == null) return;
 
-      // Split the class into two classes right before the build method
-      builder.addSimpleInsertion(buildMethod.offset, '''
-@override
-  ConsumerState<${widgetClass.name.lexeme}> createState() => $createdStateClassName();
-}
+      final String baseStateName;
+      switch (targetWidget) {
+        case StatefulBaseWidgetType.consumerStatefulWidget:
+        case StatefulBaseWidgetType.statefulHookConsumerWidget:
+          baseStateName = 'ConsumerState';
+          break;
+        case StatefulBaseWidgetType.statefulHookWidget:
+        case StatefulBaseWidgetType.statefulWidget:
+          baseStateName = 'State';
+          break;
+      }
 
-class $createdStateClassName extends ConsumerState<${widgetClass.name}> {
-''');
+      final createStateMethod = widgetClass.members
+          .whereType<MethodDeclaration>()
+          .firstWhereOrNull((element) => element.name.lexeme == 'createState');
+      if (createStateMethod != null) {
+        final returnTypeString = createStateMethod.returnType?.toSource() ?? '';
+        if (returnTypeString != stateClass.name.lexeme) {
+          // Replace State
+          builder.addSimpleReplacement(
+            createStateMethod.returnType!.sourceRange,
+            '$baseStateName<${widgetClass.name}>',
+          );
+        }
+      }
 
-      final buildParams = buildMethod.parameters;
-      // If the build method has a ref, remove it
-      if (buildParams != null && buildParams.parameters.length == 2) {
-        builder.addDeletion(
-          sourceRangeFrom(
-            start: buildParams.parameters.first.end,
-            end: buildParams.rightParenthesis.offset,
-          ),
+      final stateExtends = stateClass.extendsClause;
+      if (stateExtends != null) {
+        // Replace State
+        builder.addSimpleReplacement(
+          stateExtends.superclass.sourceRange,
+          '$baseStateName<${widgetClass.name}>',
         );
       }
     });