Don't trigger provider scoped lints in tests

rrousselGit · Oct 30, 2023 · 005009a · 005009a
1 parent e23f769
commit 005009a
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 2 deletions.
diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md
@@ -1,3 +1,6 @@
+## Unreleased patch
+- Updated `scoped_providers_should_specify_dependencies` to ignore instances of using pumpWidget in tests
+
 ## 2.3.2 - 2023-10-21
 
 - `riverpod_analyzer_utils` upgraded to `0.4.2`

diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart
@@ -17,6 +17,18 @@ extension SimpleIdentifierX on SimpleIdentifier {
     return libraryUri.scheme == 'package' &&
         libraryUri.pathSegments.first == 'flutter';
   }
+
+  bool get isPumpWidget {
+    if (name != 'pumpWidget') return false;
+
+    final library = staticElement?.library;
+    if (library == null) return false;
+    final libraryUri = Uri.tryParse(library.identifier);
+    if (libraryUri == null) return false;
+
+    return libraryUri.scheme == 'package' &&
+        libraryUri.pathSegments.first == 'flutter_test';
+  }
 }
 
 class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule {
@@ -90,6 +102,7 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule {
 
     // If the ProviderScope isn't directly as a child of runApp, it is scoped
     return enclosingExpression is! MethodInvocation ||
-        !enclosingExpression.methodName.isFlutterRunApp;
+        (!enclosingExpression.methodName.isFlutterRunApp &&
+            !enclosingExpression.methodName.isPumpWidget);
   }
 }
diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml
@@ -21,7 +21,8 @@ dev_dependencies:
   riverpod_lint:
     path: ../riverpod_lint
   riverpod_generator: ^2.0.0
-  test: ^1.15.0
+  flutter_test:
+    sdk: flutter
 
 dependency_overrides:
   riverpod_generator:

diff --git a/...s/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart b/...s/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart
@@ -2,6 +2,7 @@
 
 import 'package:flutter/material.dart' as flutter;
 import 'package:flutter/material.dart' hide runApp;
+import 'package:flutter_test/flutter_test.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 
@@ -121,6 +122,21 @@ void definitelyNotAMain() {
   );
 }
 
+void someTestFunction() {
+  testWidgets('override repositoryProvider in test', (tester) async {
+    await tester.pumpWidget(
+      ProviderScope(
+        overrides: [
+          scopedProvider.overrideWith((ref) => 0),
+          unimplementedScopedProvider.overrideWith((ref) => 0),
+          rootProvider.overrideWith((ref) => 0),
+        ],
+        child: Container(),
+      ),
+    );
+  });
+}
+
 Widget fn() {
   return ProviderScope(
     overrides: [