Skip to content

ci(angular-query, query-core): update vitest/expect-expect rule as error #9109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
QueryClient,
provideTanStackQuery,
} from '@tanstack/angular-query-experimental'
import { beforeEach, describe, expect, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { injectDevtoolsPanel } from '../inject-devtools-panel'

const mockDevtoolsPanelInstance = {
Expand Down
3 changes: 1 addition & 2 deletions packages/angular-query-devtools-experimental/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
"noPropertyAccessFromIndexSignature": true,
"noFallthroughCasesInSwitch": true,
"useDefineForClassFields": false,
"target": "ES2022",
"types": ["vitest/globals"]
"target": "ES2022"
},
"include": ["src", "*.config.js", "*.config.ts", "package.json"],
"references": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { TestBed } from '@angular/core/testing'
import { afterEach } from 'vitest'
import { afterEach, beforeEach, describe, expectTypeOf, test, vi } from 'vitest'
import { provideExperimentalZonelessChangeDetection } from '@angular/core'
import { QueryClient, injectInfiniteQuery, provideTanStackQuery } from '..'
import { infiniteFetcher } from './test-utils'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { TestBed } from '@angular/core/testing'
import { afterEach } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import {
Injector,
provideExperimentalZonelessChangeDetection,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { TestBed } from '@angular/core/testing'
import { beforeEach, describe, expect } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import {
Injector,
provideExperimentalZonelessChangeDetection,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { beforeEach, describe } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { TestBed } from '@angular/core/testing'
import {
Injector,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf } from 'vitest'
import { describe, expectTypeOf, it } from 'vitest'
import { injectMutationState } from '..'
import type { MutationState, MutationStatus } from '..'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
signal,
} from '@angular/core'
import { TestBed } from '@angular/core/testing'
import { describe, expect, test, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { By } from '@angular/platform-browser'
import {
QueryClient,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf } from 'vitest'
import { describe, expectTypeOf, test } from 'vitest'
import { injectMutation } from '..'
import { successMutator } from './test-utils'
import type { Signal } from '@angular/core'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
signal,
} from '@angular/core'
import { TestBed } from '@angular/core/testing'
import { describe, expect, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { By } from '@angular/platform-browser'
import { QueryClient, injectMutation, provideTanStackQuery } from '..'
import {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf, it } from 'vitest'
import { describe, expectTypeOf, it, test } from 'vitest'
import { injectQuery, queryOptions } from '..'
import { simpleFetcher } from './test-utils'
import type { Signal } from '@angular/core'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ import {
signal,
} from '@angular/core'
import { TestBed } from '@angular/core/testing'
import { afterEach, describe, expect, vi } from 'vitest'
import {
afterEach,
beforeEach,
describe,
expect,
expectTypeOf,
test,
vi,
} from 'vitest'
import { QueryCache, QueryClient, injectQuery, provideTanStackQuery } from '..'
import {
delayedFetcher,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
import { assertType, describe, expectTypeOf, test } from 'vitest'
import { mutationOptions } from '../mutation-options'

describe('mutationOptions', () => {
test('should not allow excess properties', () => {
expectTypeOf(mutationOptions).parameter(0).not.toHaveProperty('onMutates')
assertType<Parameters<typeof mutationOptions>>([
{
mutationFn: () => Promise.resolve(5),
mutationKey: ['key'],
// @ts-expect-error this is a good error, because onMutates does not exist!
onMutates: 1000,
},
])
assertType<Parameters<typeof mutationOptions>>([
{
mutationFn: () => Promise.resolve(5),
mutationKey: ['key'],
// @ts-expect-error this is a good error, because onMutates does not exist!
onMutates: 1000,
},
])
})

test('should infer types for callbacks', () => {
return mutationOptions({
mutationOptions({
mutationFn: () => Promise.resolve(5),
mutationKey: ['key'],
onSuccess: (data) => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { beforeEach, describe, expect, test, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest'
import { QueryClient } from '@tanstack/query-core'
import { TestBed } from '@angular/core/testing'
import {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { assertType, describe, expectTypeOf } from 'vitest'
import { assertType, describe, expectTypeOf, test } from 'vitest'
import { QueryClient, dataTagSymbol, injectQuery, queryOptions } from '..'
import type { Signal } from '@angular/core'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { isSignal, signal } from '@angular/core'
import { describe } from 'vitest'
import { describe, expect, test } from 'vitest'
import { signalProxy } from '../signal-proxy'

describe('signalProxy', () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { isSignal, untracked } from '@angular/core'
import { SIGNAL, signalSetFn } from '@angular/core/primitives/signals'
import { expect } from 'vitest'
import type { InputSignal, Signal } from '@angular/core'
import type { ComponentFixture } from '@angular/core/testing'

Expand Down
3 changes: 1 addition & 2 deletions packages/angular-query-experimental/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
"noPropertyAccessFromIndexSignature": true,
"noFallthroughCasesInSwitch": true,
"useDefineForClassFields": false,
"target": "ES2022",
"types": ["vitest/globals"]
"target": "ES2022"
},
"include": ["src", "*.config.js", "*.config.ts", "package.json"],
"references": [{ "path": "../query-core" }, { "path": "../query-devtools" }]
Expand Down
3 changes: 1 addition & 2 deletions packages/angular-query-persist-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
"noPropertyAccessFromIndexSignature": true,
"noFallthroughCasesInSwitch": true,
"useDefineForClassFields": false,
"target": "ES2022",
"types": ["vitest/globals"]
"target": "ES2022"
},
"include": ["src", "*.config.js", "*.config.ts", "package.json"],
"references": [
Expand Down
12 changes: 1 addition & 11 deletions packages/query-async-storage-persister/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import rootConfig from './root.eslint.config.js'

export default [
...rootConfig,
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
export default [...rootConfig]
12 changes: 1 addition & 11 deletions packages/query-broadcast-client-experimental/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import rootConfig from './root.eslint.config.js'

export default [
...rootConfig,
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
export default [...rootConfig]
7 changes: 0 additions & 7 deletions packages/query-codemods/eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,4 @@ export default [
'sort-imports': 'off',
},
},
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
12 changes: 1 addition & 11 deletions packages/query-core/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import rootConfig from './root.eslint.config.js'

export default [
...rootConfig,
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
export default [...rootConfig]
22 changes: 17 additions & 5 deletions packages/query-core/src/__tests__/notifyManager.test.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import {
afterEach,
assertType,
beforeEach,
describe,
expect,
expectTypeOf,
it,
vi,
} from 'vitest'
import { createNotifyManager } from '../notifyManager'
import { sleep } from './utils'

Expand Down Expand Up @@ -81,10 +90,13 @@ describe('notifyManager', () => {
// now someFn expect to be called with args [a: string, b: number]
const someFn = notifyManagerTest.batchCalls(fn)

someFn('im happy', 4)

// @ts-expect-error
someFn('im not happy', false)
expectTypeOf(someFn).parameters.toEqualTypeOf<Parameters<typeof fn>>()
assertType<Parameters<typeof someFn>>(['im happy', 4])
assertType<Parameters<typeof someFn>>([
'im not happy',
// @ts-expect-error
false,
])
})

it('should use custom batch notify function', async () => {
Expand Down
65 changes: 30 additions & 35 deletions packages/query-core/src/__tests__/queryClient.test-d.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf, it } from 'vitest'
import { assertType, describe, expectTypeOf, it } from 'vitest'
import { QueryClient } from '../queryClient'
import type { MutationFilters, QueryFilters, Updater } from '../utils'
import type { Mutation } from '../mutation'
Expand Down Expand Up @@ -42,10 +42,10 @@ describe('getQueryData', () => {
})

it('should only allow Arrays to be passed', () => {
const queryKey = 'key'
const queryClient = new QueryClient()
// @ts-expect-error TS2345: Argument of type 'string' is not assignable to parameter of type 'QueryKey'
return queryClient.getQueryData(queryKey)
assertType<Parameters<QueryClient['getQueryData']>>([
// @ts-expect-error TS2345: Argument of type 'string' is not assignable to parameter of type 'QueryKey'
{ queryKey: 'key' },
])
})
})

Expand Down Expand Up @@ -171,22 +171,26 @@ describe('fetchInfiniteQuery', () => {
})

it('should not allow passing getNextPageParam without pages', () => {
new QueryClient().fetchInfiniteQuery({
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
initialPageParam: 1,
getNextPageParam: () => 1,
})
assertType<Parameters<QueryClient['fetchInfiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
initialPageParam: 1,
getNextPageParam: () => 1,
},
])
})

it('should not allow passing pages without getNextPageParam', () => {
// @ts-expect-error Property 'getNextPageParam' is missing
return new QueryClient().fetchInfiniteQuery({
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
initialPageParam: 1,
pages: 5,
})
assertType<Parameters<QueryClient['fetchInfiniteQuery']>>([
// @ts-expect-error Property 'getNextPageParam' is missing
{
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
initialPageParam: 1,
pages: 5,
},
])
})
})

Expand Down Expand Up @@ -506,26 +510,17 @@ describe('fully typed usage', () => {

describe('invalidateQueries', () => {
it('shows type error when queryKey is a wrong type in invalidateQueries', () => {
const queryClient = new QueryClient()

queryClient.invalidateQueries()

queryClient.invalidateQueries({
queryKey: ['1'],
})

queryClient.invalidateQueries({
assertType<Parameters<QueryClient['invalidateQueries']>>([])
assertType<Parameters<QueryClient['invalidateQueries']>>([
{ queryKey: ['1'] },
])
assertType<Parameters<QueryClient['invalidateQueries']>>([
// @ts-expect-error
queryKey: '1',
})

queryClient.invalidateQueries({
// @ts-expect-error
queryKey: {},
})
{ queryKey: '1' },
])
})
it('needs queryKey to be an array (#8684)', () => {
new QueryClient().invalidateQueries({
assertType<Parameters<QueryClient['invalidateQueries']>>({
// @ts-expect-error key is not an array
queryKey: { foo: true },
})
Expand Down
12 changes: 1 addition & 11 deletions packages/query-persist-client-core/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import rootConfig from './root.eslint.config.js'

export default [
...rootConfig,
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
export default [...rootConfig]
Loading
Loading