Auto add imports

packages/riverpod_lint/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased build
 
+- All lints/assists now automatically add the relevant imports when
+  updating code.
 - Updated `provider_dependencies` to support `@Dependencies`
 - added `riverpod_syntax_error`, for reporting errors when the generator would throw.
 - added `avoid_keep_alive_dependency_inside_auto_dispose`

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

@@ -8,6 +8,7 @@ import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dar
 import 'package:collection/collection.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 
+import '../imports.dart';
 import '../riverpod_custom_lint.dart';
 import 'convert_to_widget_utils.dart';
 
@@ -72,15 +73,15 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist {
     ExtendsClause node,
   ) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ${targetWidget.widgetName}',
+      message: 'Convert to ${targetWidget.widgetAssistName}',
       priority: targetWidget.priority,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        targetWidget.widgetName,
+        targetWidget.widgetName(builder),
       );
 
       final widgetClass = node.thisOrAncestorOfType<ClassDeclaration>();
@@ -143,10 +144,10 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist {
       switch (targetWidget) {
         case StatefulBaseWidgetType.consumerStatefulWidget:
         case StatefulBaseWidgetType.statefulHookConsumerWidget:
-          baseStateName = 'ConsumerState';
+          baseStateName = builder.importConsumerState();
         case StatefulBaseWidgetType.statefulHookWidget:
         case StatefulBaseWidgetType.statefulWidget:
-          baseStateName = 'State';
+          baseStateName = builder.importState();
       }
 
       // Split the class into two classes right before the build method
@@ -178,15 +179,15 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> {
     required int priorityAdjustment,
   }) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ${targetWidget.widgetName}',
+      message: 'Convert to ${targetWidget.widgetAssistName}',
       priority: targetWidget.priority + priorityAdjustment,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        targetWidget.widgetName,
+        targetWidget.widgetName(builder),
       );
 
       final widgetClass = node.thisOrAncestorOfType<ClassDeclaration>();
@@ -199,10 +200,10 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> {
       switch (targetWidget) {
         case StatefulBaseWidgetType.consumerStatefulWidget:
         case StatefulBaseWidgetType.statefulHookConsumerWidget:
-          baseStateName = 'ConsumerState';
+          baseStateName = builder.importConsumerState();
         case StatefulBaseWidgetType.statefulHookWidget:
         case StatefulBaseWidgetType.statefulWidget:
-          baseStateName = 'State';
+          baseStateName = builder.importState();
       }
 
       final createStateMethod = widgetClass.members

packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart

@@ -7,6 +7,7 @@ import 'package:analyzer/source/source_range.dart';
 import 'package:collection/collection.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 
+import '../imports.dart';
 import '../riverpod_custom_lint.dart';
 import 'convert_to_widget_utils.dart';
 
@@ -74,15 +75,15 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
     ExtendsClause node,
   ) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ${targetWidget.widgetName}',
+      message: 'Convert to ${targetWidget.assistName}',
       priority: targetWidget.priority,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        targetWidget.widgetName,
+        targetWidget.widgetName(builder),
       );
 
       final buildMethod = node
@@ -99,11 +100,13 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
       switch (targetWidget) {
         case StatelessBaseWidgetType.consumerWidget:
         case StatelessBaseWidgetType.hookConsumerWidget:
+          final widgetRef = builder.importWidgetRef();
+
           // If the build method has not a ref, add it
           if (buildParams.parameters.length == 1) {
             builder.addSimpleInsertion(
               buildParams.parameters.last.end,
-              ', WidgetRef ref',
+              ', $widgetRef ref',
             );
           }
         case StatelessBaseWidgetType.hookWidget:
@@ -128,15 +131,15 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
     required int priorityAdjustment,
   }) {
     final changeBuilder = reporter.createChangeBuilder(
-      message: 'Convert to ${targetWidget.widgetName}',
+      message: 'Convert to ${targetWidget.assistName}',
       priority: targetWidget.priority + priorityAdjustment,
     );
 
     changeBuilder.addDartFileEdit((builder) {
       // Change the extended base class
       builder.addSimpleReplacement(
         node.superclass.sourceRange,
-        targetWidget.widgetName,
+        targetWidget.widgetName(builder),
       );
 
       final widgetClass = node.thisOrAncestorOfType<ClassDeclaration>();
@@ -252,9 +255,10 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
       switch (targetWidget) {
         case StatelessBaseWidgetType.consumerWidget:
         case StatelessBaseWidgetType.hookConsumerWidget:
+          final widgetRef = builder.importWidgetRef();
           builder.addSimpleReplacement(
             parameterRange,
-            'BuildContext context, WidgetRef ref',
+            'BuildContext context, $widgetRef ref',
           );
         case StatelessBaseWidgetType.hookWidget:
         case StatelessBaseWidgetType.statelessWidget:
@@ -275,7 +279,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
   }
 }
 
-// Original implemenation in
+// Original implementation in
 // package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateless_widget.dart
 class _FieldFinder extends RecursiveAstVisitor<void> {
   final fieldsAssignedInConstructors = <FieldElement>{};

packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart

@@ -1,13 +1,14 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart';
 import 'package:collection/collection.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 
+import '../imports.dart';
 import '../object_utils.dart';
 
 enum StatelessBaseWidgetType {
   hookConsumerWidget(
-    widgetName: 'HookConsumerWidget',
     priority: 37,
     typeChecker: TypeChecker.fromName(
       'HookConsumerWidget',
@@ -16,7 +17,6 @@ enum StatelessBaseWidgetType {
     requiredPackage: 'hooks_riverpod',
   ),
   hookWidget(
-    widgetName: 'HookWidget',
     priority: 36,
     typeChecker: TypeChecker.fromName(
       'HookWidget',
@@ -25,15 +25,13 @@ enum StatelessBaseWidgetType {
     requiredPackage: 'flutter_hooks',
   ),
   consumerWidget(
-    widgetName: 'ConsumerWidget',
     priority: 35,
     typeChecker: TypeChecker.fromName(
       'ConsumerWidget',
       packageName: 'flutter_riverpod',
     ),
   ),
   statelessWidget(
-    widgetName: 'StatelessWidget',
     priority: 34,
     typeChecker: TypeChecker.fromName(
       'StatelessWidget',
@@ -43,20 +41,39 @@ enum StatelessBaseWidgetType {
   ;
 
   const StatelessBaseWidgetType({
-    required this.widgetName,
     required this.priority,
     required this.typeChecker,
     this.requiredPackage,
   });
-  final String widgetName;
+
   final int priority;
   final TypeChecker typeChecker;
   final String? requiredPackage;
+
+  String widgetName(DartFileEditBuilder builder) {
+    return switch (this) {
+      StatelessBaseWidgetType.hookConsumerWidget =>
+        builder.importHookConsumerWidget(),
+      StatelessBaseWidgetType.hookWidget => builder.importHookWidget(),
+      StatelessBaseWidgetType.consumerWidget => builder.importConsumerWidget(),
+      StatelessBaseWidgetType.statelessWidget =>
+        builder.importStatelessWidget(),
+    };
+  }
+
+  String get assistName {
+    return switch (this) {
+      StatelessBaseWidgetType.hookConsumerWidget => 'HookConsumerWidget',
+      StatelessBaseWidgetType.hookWidget => 'HookWidget',
+      StatelessBaseWidgetType.consumerWidget => 'ConsumerWidget',
+      StatelessBaseWidgetType.statelessWidget => 'StatelessWidget',
+    };
+  }
 }
 
 enum StatefulBaseWidgetType {
   statefulHookConsumerWidget(
-    widgetName: 'StatefulHookConsumerWidget',
+    widgetAssistName: 'StatefulHookConsumerWidget',
     priority: 33,
     typeChecker: TypeChecker.fromName(
       'StatefulHookConsumerWidget',
@@ -65,7 +82,7 @@ enum StatefulBaseWidgetType {
     requiredPackage: 'hooks_riverpod',
   ),
   statefulHookWidget(
-    widgetName: 'StatefulHookWidget',
+    widgetAssistName: 'StatefulHookWidget',
     priority: 32,
     typeChecker: TypeChecker.fromName(
       'StatefulHookWidget',
@@ -74,15 +91,15 @@ enum StatefulBaseWidgetType {
     requiredPackage: 'flutter_hooks',
   ),
   consumerStatefulWidget(
-    widgetName: 'ConsumerStatefulWidget',
+    widgetAssistName: 'ConsumerStatefulWidget',
     priority: 31,
     typeChecker: TypeChecker.fromName(
       'ConsumerStatefulWidget',
       packageName: 'flutter_riverpod',
     ),
   ),
   statefulWidget(
-    widgetName: 'StatefulWidget',
+    widgetAssistName: 'StatefulWidget',
     priority: 30,
     typeChecker: TypeChecker.fromName(
       'StatefulWidget',
@@ -92,15 +109,28 @@ enum StatefulBaseWidgetType {
   ;
 
   const StatefulBaseWidgetType({
-    required this.widgetName,
+    required this.widgetAssistName,
     required this.priority,
     required this.typeChecker,
     this.requiredPackage,
   });
-  final String widgetName;
+
+  final String widgetAssistName;
   final int priority;
   final TypeChecker typeChecker;
   final String? requiredPackage;
+
+  String widgetName(DartFileEditBuilder builder) {
+    return switch (this) {
+      StatefulBaseWidgetType.statefulHookConsumerWidget =>
+        builder.importStatefulHookConsumerWidget(),
+      StatefulBaseWidgetType.statefulHookWidget =>
+        builder.importStatefulHookWidget(),
+      StatefulBaseWidgetType.consumerStatefulWidget =>
+        builder.importConsumerStatefulWidget(),
+      StatefulBaseWidgetType.statefulWidget => builder.importStatefulWidget(),
+    };
+  }
 }
 
 TypeChecker getStatelessBaseType({

packages/riverpod_lint/lib/src/assists/wrap_with_consumer.dart

@@ -2,6 +2,7 @@ import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart';
 
+import '../imports.dart';
 import '../riverpod_custom_lint.dart';
 
 /// Right above "wrap in builder"
@@ -33,9 +34,11 @@ class WrapWithConsumer extends RiverpodAssist {
       );
 
       changeBuilder.addDartFileEdit((builder) {
+        final consumer = builder.importConsumer();
+
         builder.addSimpleInsertion(
           node.offset,
-          'Consumer(builder: (context, ref, child) { return ',
+          '$consumer(builder: (context, ref, child) { return ',
         );
         builder.addSimpleInsertion(node.end, '; },)');
       });

packages/riverpod_lint/lib/src/assists/wrap_with_provider_scope.dart

@@ -2,6 +2,7 @@ import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart';
 
+import '../imports.dart';
 import '../riverpod_custom_lint.dart';
 import 'wrap_with_consumer.dart';
 
@@ -31,10 +32,8 @@ class WrapWithProviderScope extends RiverpodAssist {
       );
 
       changeBuilder.addDartFileEdit((builder) {
-        builder.addSimpleInsertion(
-          node.offset,
-          'ProviderScope(child: ',
-        );
+        final providerScope = builder.importProviderScope();
+        builder.addSimpleInsertion(node.offset, '$providerScope(child: ');
         builder.addSimpleInsertion(node.end, ',)');
       });
     });