ci(*): init ESLint configurations to include 'vitest/expect-expect' rule as error across multiple packages gradually (#9104)

* chore(*): init ESLint configurations to include 'vitest/expect-expect' rule as error across multiple packages gradually

* chore(query-core): remove unused import from ESLint configuration

* chore(angular-query-experimental): update eslint rule

* chore: integrate vitest ESLint plugin and apply recommended rules across multiple packages

* chore(react-query-devtools): add vitest ESLint plugin to configuration

Author: manudeli

eslint.config.js

@@ -45,10 +45,7 @@ export default [
   {
     files: ['**/*.spec.ts*', '**/*.test.ts*', '**/*.test-d.ts*'],
     plugins: { vitest },
-    rules: {
-      ...vitest.configs.recommended.rules,
-      'vitest/expect-expect': 'warn',
-    },
+    rules: vitest.configs.recommended.rules,
     settings: { vitest: { typecheck: true } },
   },
 ]

packages/angular-query-experimental/eslint.config.js

@@ -1,6 +1,7 @@
 // @ts-check
 
 import pluginJsdoc from 'eslint-plugin-jsdoc'
+import vitest from '@vitest/eslint-plugin'
 import rootConfig from './root.eslint.config.js'
 
 export default [
@@ -28,4 +29,13 @@ export default [
       ],
     },
   },
+  {
+    plugins: { vitest },
+    rules: {
+      'vitest/expect-expect': [
+        'error',
+        { assertFunctionNames: ['expect', 'expectSignals'] },
+      ],
+    },
+  },
 ]

packages/angular-query-experimental/src/__tests__/inject-query.test-d.ts

@@ -108,11 +108,14 @@ describe('initialData', () => {
   })
 
   describe('structuralSharing', () => {
-    it('should restrict to same types', () => {
+    it('should be able to use structuralSharing with unknown types', () => {
+      // https://github.com/TanStack/query/issues/6525#issuecomment-1938411343
       injectQuery(() => ({
         queryKey: ['key'],
         queryFn: () => 5,
-        structuralSharing: (_oldData, newData) => {
+        structuralSharing: (oldData, newData) => {
+          expectTypeOf(oldData).toBeUnknown()
+          expectTypeOf(newData).toBeUnknown()
           return newData
         },
       }))

packages/angular-query-experimental/src/__tests__/mutation-options.test-d.ts

@@ -2,12 +2,7 @@ import { mutationOptions } from '../mutation-options'
 
 describe('mutationOptions', () => {
   test('should not allow excess properties', () => {
-    return mutationOptions({
-      mutationFn: () => Promise.resolve(5),
-      mutationKey: ['key'],
-      // @ts-expect-error this is a good error, because onMutates does not exist!
-      onMutates: 1000,
-    })
+    expectTypeOf(mutationOptions).parameter(0).not.toHaveProperty('onMutates')
   })
 
   test('should infer types for callbacks', () => {

packages/angular-query-experimental/src/__tests__/query-options.test-d.ts

@@ -4,16 +4,11 @@ import type { Signal } from '@angular/core'
 
 describe('queryOptions', () => {
   test('should not allow excess properties', () => {
-    return queryOptions({
-      queryKey: ['key'],
-      queryFn: () => Promise.resolve(5),
-      // @ts-expect-error this is a good error, because stallTime does not exist!
-      stallTime: 1000,
-    })
+    expectTypeOf(queryOptions).parameter(0).not.toHaveProperty('stallTime')
   })
 
   test('should infer types for callbacks', () => {
-    return queryOptions({
+    queryOptions({
       queryKey: ['key'],
       queryFn: () => Promise.resolve(5),
       staleTime: 1000,
@@ -24,7 +19,7 @@ describe('queryOptions', () => {
   })
 
   test('should allow undefined response in initialData', () => {
-    return (id: string | null) =>
+    const options = (id: string | null) =>
       queryOptions({
         queryKey: ['todo', id],
         queryFn: () =>
@@ -40,6 +35,10 @@ describe('queryOptions', () => {
                 title: 'Initial Data',
               },
       })
+
+    expectTypeOf(options(null).initialData).returns.toEqualTypeOf<
+      { id: string; title: string } | undefined
+    >()
   })
 })
 

packages/eslint-plugin-query/eslint.config.js

@@ -8,6 +8,7 @@ export default [
   {
     plugins: { vitest },
     rules: {
+      ...vitest.configs.recommended.rules,
       'vitest/expect-expect': [
         'warn',
         {

packages/query-async-storage-persister/eslint.config.js

@@ -1,5 +1,15 @@
 // @ts-check
 
+import vitest from '@vitest/eslint-plugin'
 import rootConfig from './root.eslint.config.js'
 
-export default [...rootConfig]
+export default [
+  ...rootConfig,
+  {
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/expect-expect': 'warn',
+    },
+  },
+]

packages/query-broadcast-client-experimental/eslint.config.js

@@ -1,5 +1,15 @@
 // @ts-check
 
+import vitest from '@vitest/eslint-plugin'
 import rootConfig from './root.eslint.config.js'
 
-export default [...rootConfig]
+export default [
+  ...rootConfig,
+  {
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/expect-expect': 'warn',
+    },
+  },
+]

packages/query-codemods/eslint.config.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+import vitest from '@vitest/eslint-plugin'
 import rootConfig from './root.eslint.config.js'
 
 export default [
@@ -15,4 +16,11 @@ export default [
       'sort-imports': 'off',
     },
   },
+  {
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/expect-expect': 'warn',
+    },
+  },
 ]

packages/query-core/eslint.config.js

@@ -1,5 +1,15 @@
 // @ts-check
 
+import vitest from '@vitest/eslint-plugin'
 import rootConfig from './root.eslint.config.js'
 
-export default [...rootConfig]
+export default [
+  ...rootConfig,
+  {
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/expect-expect': 'warn',
+    },
+  },
+]