chore(hooks_memoized_consideration): do not consider useFuture and …

…`useStream`
nikaera · Feb 27, 2024 · a638b5c · a638b5c
1 parent 5e7f26b
commit a638b5c
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -203,10 +203,9 @@ class UnuseHookConsumerWidget extends ConsumerWidget { // ⭕
 
 ### hooks_memoized_consideration
 
-Considering performance and functionality, there may be places where it is worth considering the use of `useMemoized`.
+Considering functionality, there may be places where it is worth considering the use of `useMemoized`.
 
 * https://api.flutter.dev/flutter/widgets/GlobalKey-class.html
-* https://github.com/Region40/flutter_hooks/blob/f9103ae7bfb8df94b1105e4f988764b29d1e2ad3/packages/flutter_hooks/lib/src/async.dart#L8-L24
 
 **Bad**
 

diff --git a/packages/flutter_hooks_lint/CHANGELOG.md b/packages/flutter_hooks_lint/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.0.5
+
+- Do not consider `useFuture` and `useStream` in `hooks_memoized_consideration`
+
 ## 1.0.4
 
 - Fixed a bug in `hooks_memoized_consideration`

diff --git a/packages/flutter_hooks_lint/lib/src/rules/hooks_memoized_consideration_rule.dart b/packages/flutter_hooks_lint/lib/src/rules/hooks_memoized_consideration_rule.dart
@@ -4,7 +4,6 @@ import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:flutter_hooks_lint/src/helpers/hooks_helper.dart';
-import 'package:flutter_hooks_lint/src/visitors/hooks_method_visitor.dart';
 
 class HooksMemoizedConsiderationRule extends DartLintRule {
   const HooksMemoizedConsiderationRule() : super(code: _code);
@@ -20,23 +19,6 @@ class HooksMemoizedConsiderationRule extends DartLintRule {
     ErrorReporter reporter,
     CustomLintContext context,
   ) {
-    context.registry.addClassDeclaration((classNode) {
-      classNode.visitChildren(
-        HooksMethodVisitor(
-          onVisitMethodInvocation: (node) {
-            final ancestor =
-                node.parent?.thisOrAncestorOfType<MethodInvocation>();
-            if (ancestor?.methodName.name == 'useMemoized') {
-              return;
-            }
-            if (['useFuture', 'useStream'].contains(node.methodName.name)) {
-              reporter.reportErrorForNode(code, node);
-            }
-          },
-        ),
-      );
-    });
-
     context.registry.addVariableDeclaration((node) {
       if (node.childEntities.last.toString().startsWith('useMemoized')) {
         return;
@@ -80,31 +62,6 @@ class _LintFix extends DartFix {
     AnalysisError analysisError,
     List<AnalysisError> others,
   ) {
-    context.registry.addClassDeclaration((classNode) {
-      classNode.visitChildren(
-        HooksMethodVisitor(
-          onVisitMethodInvocation: (node) {
-            if (!analysisError.sourceRange.intersects(node.sourceRange)) {
-              return;
-            }
-            if (['useFuture', 'useStream'].contains(node.methodName.name)) {
-              final changeBuilder = reporter.createChangeBuilder(
-                message: 'Wrap with useMemoized',
-                priority: 30,
-              );
-
-              changeBuilder.addDartFileEdit((builder) {
-                builder.addSimpleReplacement(
-                  SourceRange(node.offset, node.length),
-                  'useMemoized(() => ${node.toSource()})',
-                );
-              });
-            }
-          },
-        ),
-      );
-    });
-
     context.registry.addVariableDeclaration((node) {
       if (!analysisError.sourceRange.intersects(node.sourceRange)) {
         return;

diff --git a/packages/flutter_hooks_lint/pubspec.yaml b/packages/flutter_hooks_lint/pubspec.yaml
@@ -1,6 +1,6 @@
 name: flutter_hooks_lint
 description: A lint package providing guidelines for using flutter_hooks in your Flutter widget!
-version: 1.0.4
+version: 1.0.5
 homepage: https://github.com/nikaera/flutter_hooks_lint
 repository: https://github.com/nikaera/flutter_hooks_lint
 documentation: https://github.com/nikaera/flutter_hooks_lint

diff --git a/...oks_lint_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration.dart b/...oks_lint_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration.dart
@@ -19,14 +19,12 @@ class ConsiderationMemoizedWidget extends HookWidget {
   }
 }
 
-class HookConsiderationMemoizedWidget extends HookWidget {
+class FutureGlobalKeyMemoizedWidget extends HookWidget {
   @override
   Widget build(BuildContext context) {
     final state = useState(0);
     final snapshot =
-        useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!"));
-    final _ = useMemoized(
-        () => useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!")));
+        useFuture(Future.delayed(Duration(seconds: 5), () => GlobalKey()));
     useEffect(() {
       if (snapshot.hasData && snapshot.data != null) {
         state.value = 5;
@@ -39,7 +37,7 @@ class HookConsiderationMemoizedWidget extends HookWidget {
 
 final _globalKeyProvider = Provider((ref) => GlobalKey());
 
-class ConsumerConsiderationMemoizedWidget extends ConsumerWidget {
+class GlobalKeyMemoizedWidget extends ConsumerWidget {
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     final globalKey = ref.watch(_globalKeyProvider);

diff --git a/...oks_lint_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration.diff b/...oks_lint_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration.diff
@@ -22,27 +22,3 @@ Diff for file `test/hooks_memoized_consideration/hooks_memoized_consideration.da
     final __ = useMemoized(() => GlobalObjectKey("object_memo"));
 ```
 ---
-Message: `Wrap with useMemoized`
-Priority: 30
-Diff for file `test/hooks_memoized_consideration/hooks_memoized_consideration.dart:27`:
-```
-    final state = useState(0);
-    final snapshot =
--         useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!"));
-+         useMemoized(() => useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!")));
-    final _ = useMemoized(
-        () => useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!")));
-```
----
-Message: `Wrap with useMemoized`
-Priority: 30
-Diff for file `test/hooks_memoized_consideration/hooks_memoized_consideration.dart:27`:
-```
-    final state = useState(0);
-    final snapshot =
--         useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!"));
-+         useMemoized(() => useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!")));
-    final _ = useMemoized(
-        () => useFuture(Future.delayed(Duration(seconds: 5), () => "Hi!")));
-```
----
diff --git a/...int_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration_test.dart b/...int_flutter_test/test/hooks_memoized_consideration/hooks_memoized_consideration_test.dart
@@ -12,7 +12,7 @@ void main() {
       (result) async {
     final lint = HooksMemoizedConsiderationRule();
     final errors = await lint.testRun(result);
-    expect(errors, hasLength(3));
+    expect(errors, hasLength(2));
 
     final fixes = lint.getFixes().map((e) => e as DartFix);
     final results = await Future.wait(errors