Skip to content

Commit 9686426

Browse files
TkDodoTkDodo
authored
chore: add prettier to pipeline checks and include .ts files (TanStack#2205)
1 parent 7d9c9f8 commit 9686426

File tree

9 files changed

+120
-58
lines changed

9 files changed

+120
-58
lines changed

‎package.json‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
],
2323
"scripts": {
2424
"test": "is-ci \"test:ci\" \"test:dev\"",
25-
"test:dev": "npm run test:types && npm run test:eslint && jest --watch",
26-
"test:ci": "npm run test:types && npm run test:eslint && jest",
25+
"test:dev": "npm run test:types && npm run test:format && npm run test:eslint && jest --watch",
26+
"test:ci": "npm run test:types && npm run test:format && npm run test:eslint && jest",
2727
"test:coverage": "yarn test:ci; open coverage/lcov-report/index.html",
28+
"test:format": "yarn prettier --check",
2829
"test:types": "tsc",
2930
"test:eslint": "eslint --ext .ts,.tsx ./src",
3031
"build": "yarn build:commonjs && yarn build:es && yarn build:umd && yarn build:types",
@@ -38,8 +39,9 @@
3839
"watch:umd": "rimraf ./dist && cross-env NODE_ENV=production rollup -w -c && rollup-plugin-visualizer stats-react.json",
3940
"watch:types": "rimraf ./types && tsc --watch --project ./tsconfig.types.json && replace 'import type' 'import' ./types -r --silent && replace 'export type' 'export' ./types -r --silent",
4041
"now-build": "yarn && cd www && yarn && yarn build",
42+
"prettier": "prettier \"{.,src,src/**,example/src,example/src/**,types}/*.{md,js,jsx,ts,tsx,json}\"",
4143
"start": "yarn watch",
42-
"format": "prettier {.,src,src/**,example/src,example/src/**,types}/*.{md,js,jsx,tsx,json} --write",
44+
"format": "yarn prettier --write",
4345
"stats": "open ./stats.html"
4446
},
4547
"files": [
@@ -108,7 +110,7 @@
108110
"eslint-plugin-standard": "^4.0.1",
109111
"is-ci-cli": "^2.1.1",
110112
"jest": "^26.0.1",
111-
"prettier": "^2.0.5",
113+
"prettier": "2.2.1",
112114
"react": "^16.13.0",
113115
"react-dom": "^16.13.1",
114116
"react-error-boundary": "^2.2.2",

‎src/core/focusManager.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class FocusManager extends Subscribable {
1717
if (this.removeEventListener) {
1818
this.removeEventListener()
1919
}
20-
this.removeEventListener = setup((focused) => {
20+
this.removeEventListener = setup(focused => {
2121
if (typeof focused === 'boolean') {
2222
this.setFocused(focused)
2323
} else {

‎src/core/mutationCache.ts‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,7 @@ export class MutationCache extends Subscribable<MutationCacheListener> {
7676
return this.mutations
7777
}
7878

79-
find<
80-
TData = unknown,
81-
TError = unknown,
82-
TVariables = any,
83-
TContext = unknown
84-
>(
79+
find<TData = unknown, TError = unknown, TVariables = any, TContext = unknown>(
8580
filters: MutationFilters
8681
): Mutation<TData, TError, TVariables, TContext> | undefined {
8782
if (typeof filters.exact === 'undefined') {

‎src/core/queryClient.ts‎

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -252,19 +252,39 @@ export class QueryClient {
252252
return promise
253253
}
254254

255-
fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
255+
fetchQuery<
256+
TQueryFnData = unknown,
257+
TError = unknown,
258+
TData = TQueryFnData,
259+
TQueryKey extends QueryKey = QueryKey
260+
>(
256261
options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
257262
): Promise<TData>
258-
fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
263+
fetchQuery<
264+
TQueryFnData = unknown,
265+
TError = unknown,
266+
TData = TQueryFnData,
267+
TQueryKey extends QueryKey = QueryKey
268+
>(
259269
queryKey: TQueryKey,
260270
options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
261271
): Promise<TData>
262-
fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
272+
fetchQuery<
273+
TQueryFnData = unknown,
274+
TError = unknown,
275+
TData = TQueryFnData,
276+
TQueryKey extends QueryKey = QueryKey
277+
>(
263278
queryKey: TQueryKey,
264279
queryFn: QueryFunction<TQueryFnData, TQueryKey>,
265280
options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
266281
): Promise<TData>
267-
fetchQuery<TQueryFnData, TError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
282+
fetchQuery<
283+
TQueryFnData,
284+
TError,
285+
TData = TQueryFnData,
286+
TQueryKey extends QueryKey = QueryKey
287+
>(
268288
arg1: TQueryKey | FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
269289
arg2?:
270290
| QueryFunction<TQueryFnData, TQueryKey>
@@ -286,21 +306,43 @@ export class QueryClient {
286306
: Promise.resolve(query.state.data as TData)
287307
}
288308

289-
prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
309+
prefetchQuery<
310+
TQueryFnData = unknown,
311+
TError = unknown,
312+
TData = TQueryFnData,
313+
TQueryKey extends QueryKey = QueryKey
314+
>(
290315
options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
291316
): Promise<void>
292-
prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
317+
prefetchQuery<
318+
TQueryFnData = unknown,
319+
TError = unknown,
320+
TData = TQueryFnData,
321+
TQueryKey extends QueryKey = QueryKey
322+
>(
293323
queryKey: TQueryKey,
294324
options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
295325
): Promise<void>
296-
prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
326+
prefetchQuery<
327+
TQueryFnData = unknown,
328+
TError = unknown,
329+
TData = TQueryFnData,
330+
TQueryKey extends QueryKey = QueryKey
331+
>(
297332
queryKey: TQueryKey,
298333
queryFn: QueryFunction<TQueryFnData, TQueryKey>,
299334
options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
300335
): Promise<void>
301-
prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
336+
prefetchQuery<
337+
TQueryFnData = unknown,
338+
TError = unknown,
339+
TData = TQueryFnData,
340+
TQueryKey extends QueryKey = QueryKey
341+
>(
302342
arg1: TQueryKey | FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
303-
arg2?: QueryFunction<TQueryFnData, TQueryKey> | FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
343+
arg2?:
344+
| QueryFunction<TQueryFnData, TQueryKey>
345+
| FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
304346
arg3?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
305347
): Promise<void> {
306348
return this.fetchQuery(arg1 as any, arg2 as any, arg3)
@@ -335,8 +377,15 @@ export class QueryClient {
335377
queryFn: QueryFunction<TQueryFnData, TQueryKey>,
336378
options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
337379
): Promise<InfiniteData<TData>>
338-
fetchInfiniteQuery<TQueryFnData, TError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
339-
arg1: TQueryKey | FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
380+
fetchInfiniteQuery<
381+
TQueryFnData,
382+
TError,
383+
TData = TQueryFnData,
384+
TQueryKey extends QueryKey = QueryKey
385+
>(
386+
arg1:
387+
| TQueryKey
388+
| FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
340389
arg2?:
341390
| QueryFunction<TQueryFnData, TQueryKey>
342391
| FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
@@ -356,15 +405,15 @@ export class QueryClient {
356405
TError = unknown,
357406
TData = TQueryFnData,
358407
TQueryKey extends QueryKey = QueryKey
359-
>(
408+
>(
360409
options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
361410
): Promise<void>
362411
prefetchInfiniteQuery<
363412
TQueryFnData = unknown,
364413
TError = unknown,
365414
TData = TQueryFnData,
366415
TQueryKey extends QueryKey = QueryKey
367-
>(
416+
>(
368417
queryKey: TQueryKey,
369418
options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
370419
): Promise<void>
@@ -373,13 +422,20 @@ export class QueryClient {
373422
TError = unknown,
374423
TData = TQueryFnData,
375424
TQueryKey extends QueryKey = QueryKey
376-
>(
425+
>(
377426
queryKey: TQueryKey,
378427
queryFn: QueryFunction<TQueryFnData, TQueryKey>,
379428
options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
380429
): Promise<void>
381-
prefetchInfiniteQuery<TQueryFnData, TError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(
382-
arg1: TQueryKey | FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
430+
prefetchInfiniteQuery<
431+
TQueryFnData,
432+
TError,
433+
TData = TQueryFnData,
434+
TQueryKey extends QueryKey = QueryKey
435+
>(
436+
arg1:
437+
| TQueryKey
438+
| FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
383439
arg2?:
384440
| QueryFunction<TQueryFnData, TQueryKey>
385441
| FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,

‎src/core/tests/queryClient.test.tsx‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -191,14 +191,13 @@ describe('queryClient', () => {
191191
type StrictQueryKey = ['strict', string]
192192
const key: StrictQueryKey = ['strict', queryKey()]
193193

194-
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () => (
194+
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
195195
Promise.resolve('data')
196-
)
197196

198197
await expect(
199198
queryClient.fetchQuery<StrictData, any, StrictData, StrictQueryKey>(
200199
key,
201-
fetchFn,
200+
fetchFn
202201
)
203202
).resolves.toEqual('data')
204203
})
@@ -309,15 +308,16 @@ describe('queryClient', () => {
309308
pageParams: [undefined],
310309
}
311310

312-
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () => (
311+
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
313312
Promise.resolve(data.pages[0])
314-
)
315313

316314
await expect(
317-
queryClient.fetchInfiniteQuery<StrictData, any, StrictData, StrictQueryKey>(
318-
key,
319-
fetchFn,
320-
)
315+
queryClient.fetchInfiniteQuery<
316+
StrictData,
317+
any,
318+
StrictData,
319+
StrictQueryKey
320+
>(key, fetchFn)
321321
).resolves.toEqual(data)
322322
})
323323

@@ -345,11 +345,15 @@ describe('queryClient', () => {
345345
type StrictQueryKey = ['strict', string]
346346
const key: StrictQueryKey = ['strict', queryKey()]
347347

348-
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () => (
348+
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
349349
Promise.resolve('data')
350-
)
351350

352-
await queryClient.prefetchInfiniteQuery<StrictData, any, StrictData, StrictQueryKey>(key, fetchFn)
351+
await queryClient.prefetchInfiniteQuery<
352+
StrictData,
353+
any,
354+
StrictData,
355+
StrictQueryKey
356+
>(key, fetchFn)
353357

354358
const result = queryClient.getQueryData(key)
355359

@@ -381,13 +385,17 @@ describe('queryClient', () => {
381385
type StrictQueryKey = ['strict', string]
382386
const key: StrictQueryKey = ['strict', queryKey()]
383387

384-
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () => (
388+
const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
385389
Promise.resolve('data')
386-
)
387390

388-
await queryClient.prefetchQuery<StrictData, any, StrictData, StrictQueryKey>(key, fetchFn);
391+
await queryClient.prefetchQuery<
392+
StrictData,
393+
any,
394+
StrictData,
395+
StrictQueryKey
396+
>(key, fetchFn)
389397

390-
const result = queryClient.getQueryData(key);
398+
const result = queryClient.getQueryData(key)
391399

392400
expect(result).toEqual('data')
393401
})

‎src/core/types.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,7 @@ export interface InfiniteQueryObserverOptions<
198198
TData = TQueryFnData,
199199
TQueryData = TQueryFnData,
200200
TQueryKey extends QueryKey = QueryKey
201-
>
202-
extends QueryObserverOptions<
201+
> extends QueryObserverOptions<
203202
TQueryFnData,
204203
TError,
205204
InfiniteData<TData>,
@@ -225,8 +224,7 @@ export interface FetchInfiniteQueryOptions<
225224
TError = unknown,
226225
TData = TQueryFnData,
227226
TQueryKey extends QueryKey = QueryKey
228-
>
229-
extends FetchQueryOptions<
227+
> extends FetchQueryOptions<
230228
TQueryFnData,
231229
TError,
232230
InfiniteData<TData>,

‎src/persistQueryClient-experimental/index.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
import { QueryClient } from '../core'
22
import { getLogger } from '../core/logger'
3-
import { dehydrate, DehydratedState, DehydrateOptions, HydrateOptions, hydrate } from '../hydration'
3+
import {
4+
dehydrate,
5+
DehydratedState,
6+
DehydrateOptions,
7+
HydrateOptions,
8+
hydrate,
9+
} from '../hydration'
410
import { Promisable } from 'type-fest'
511

612
export interface Persistor {

‎src/react/types.ts‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ export interface UseBaseQueryOptions<
1717
TData = TQueryFnData,
1818
TQueryData = TQueryFnData,
1919
TQueryKey extends QueryKey = QueryKey
20-
>
21-
extends QueryObserverOptions<
20+
> extends QueryObserverOptions<
2221
TQueryFnData,
2322
TError,
2423
TData,
@@ -31,8 +30,7 @@ export interface UseQueryOptions<
3130
TError = unknown,
3231
TData = TQueryFnData,
3332
TQueryKey extends QueryKey = QueryKey
34-
>
35-
extends UseBaseQueryOptions<
33+
> extends UseBaseQueryOptions<
3634
TQueryFnData,
3735
TError,
3836
TData,
@@ -46,8 +44,7 @@ export interface UseInfiniteQueryOptions<
4644
TData = TQueryFnData,
4745
TQueryData = TQueryFnData,
4846
TQueryKey extends QueryKey = QueryKey
49-
>
50-
extends InfiniteQueryObserverOptions<
47+
> extends InfiniteQueryObserverOptions<
5148
TQueryFnData,
5249
TError,
5350
TData,

‎yarn.lock‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6460,10 +6460,10 @@ prettier-linter-helpers@^1.0.0:
64606460
dependencies:
64616461
fast-diff "^1.1.2"
64626462

6463-
prettier@^2.0.5:
6464-
version "2.0.5"
6465-
resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.0.5.tgz#d6d56282455243f2f92cc1716692c08aa31522d4"
6466-
integrity sha512-7PtVymN48hGcO4fGjybyBSIWDsLU4H4XlvOHfq91pz9kkGlonzwTfYkaIEwiRg/dAJF9YlbsduBAgtYLi+8cFg==
6463+
prettier@2.2.1:
6464+
version "2.2.1"
6465+
resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.1.tgz#795a1a78dd52f073da0cd42b21f9c91381923ff5"
6466+
integrity sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==
64676467

64686468
pretty-bytes@^5.3.0:
64696469
version "5.3.0"

0 commit comments

Comments
 (0)