@tanstack/eslint-plugin-query - npm Package Compare versions

Comparing version 5.51.1 to 5.51.7

dist/esm/rules/exhaustive-deps/exhaustive-deps.rule.js

@@ -45,3 +45,4 @@ import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
           AST_NODE_TYPES.ArrowFunctionExpression,
-          AST_NODE_TYPES.FunctionExpression
+          AST_NODE_TYPES.FunctionExpression,
+          AST_NODE_TYPES.ConditionalExpression
         ])) {
@@ -67,3 +68,3 @@ return;
           sourceCode: context.sourceCode,
-          node: queryFn.value
+          node: getQueryFnRelevantNode(queryFn)
         });
@@ -75,3 +76,3 @@ const relevantRefs = externalRefs.filter(
             scopeManager,
-            node: queryFn.value
+            node: getQueryFnRelevantNode(queryFn)
           })
@@ -120,2 +121,11 @@ );
 });
+function getQueryFnRelevantNode(queryFn) {
+  if (queryFn.value.type !== AST_NODE_TYPES.ConditionalExpression) {
+    return queryFn.value;
+  }
+  if (queryFn.value.consequent.type === AST_NODE_TYPES.Identifier && queryFn.value.consequent.name === "skipToken") {
+    return queryFn.value.alternate;
+  }
+  return queryFn.value.consequent;
+}
 export {
@@ -122,0 +132,0 @@ name,

package.json

 {
   "name": "@tanstack/eslint-plugin-query",
-  "version": "5.51.1",
+  "version": "5.51.7",
   "description": "ESLint plugin for TanStack Query",
@@ -5,0 +5,0 @@ "author": "Eliya Cohen",

src/__tests__/exhaustive-deps.test.ts

@@ -405,2 +405,16 @@ import { RuleTester } from '@typescript-eslint/rule-tester'
     },
+    {
+      name: 'queryFn as a ternary expression with dep and a skipToken',
+      code: normalizeIndent`
+        import { useQuery, skipToken } from "@tanstack/react-query";
+        const fetch = true
+        
+        function Component({ id }) {
+          useQuery({
+              queryKey: [id],
+              queryFn: fetch ? () => Promise.resolve(id) : skipToken
+          })
+        }
+      `,
+    },
   ],
@@ -737,3 +751,23 @@ invalid: [
     },
+    {
+      name: 'should fail if queryFn is a ternary expression with missing dep and a skipToken',
+      code: normalizeIndent`
+        import { useQuery, skipToken } from "@tanstack/react-query";
+        const fetch = true
+        
+        function Component({ id }) {
+          useQuery({
+              queryKey: [],
+              queryFn: fetch ? () => Promise.resolve(id) : skipToken
+          })
+        }
+      `,
+      errors: [
+        {
+          messageId: 'missingDeps',
+          data: { deps: 'id' },
+        },
+      ],
+    },
   ],
 })

src/rules/exhaustive-deps/exhaustive-deps.rule.ts

@@ -7,3 +7,3 @@ import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'
 import { ExhaustiveDepsUtils } from './exhaustive-deps.utils'
-import type { TSESLint } from '@typescript-eslint/utils'
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import type { ExtraRuleDocs } from '../../types'
@@ -63,2 +63,3 @@
             AST_NODE_TYPES.FunctionExpression,
+            AST_NODE_TYPES.ConditionalExpression,
           ])
@@ -93,3 +94,3 @@ ) {
           sourceCode: context.sourceCode,
-          node: queryFn.value,
+          node: getQueryFnRelevantNode(queryFn),
         })
@@ -102,3 +103,3 @@
             scopeManager,
-            node: queryFn.value,
+            node: getQueryFnRelevantNode(queryFn),
           }),
@@ -168,1 +169,16 @@ )
 })
+
+function getQueryFnRelevantNode(queryFn: TSESTree.Property) {
+  if (queryFn.value.type !== AST_NODE_TYPES.ConditionalExpression) {
+    return queryFn.value
+  }
+
+  if (
+    queryFn.value.consequent.type === AST_NODE_TYPES.Identifier &&
+    queryFn.value.consequent.name === 'skipToken'
+  ) {
+    return queryFn.value.alternate
+  }
+
+  return queryFn.value.consequent
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

208902

increased by1.82%

Lines of code

3311

increased by2%

No dependency changes