ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) #6718

manudeli · 2024-01-16T15:06:18Z

This rule will make contributors use correct spelling and I left comment what misspelled words this rule catch

vercel · 2024-01-16T15:06:23Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
query	⬜️ Ignored (Inspect)	Visit Preview		Jan 27, 2024 4:20pm

nx-cloud · 2024-01-16T15:07:26Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 36aa021. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

nx affected --targets=test:eslint,test:lib,test:types,test:build,build --exclude=examples/**

Sent with 💌 from NxCloud.

codesandbox-ci · 2024-01-16T15:10:13Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 36aa021:

Sandbox	Source
@tanstack/query-example-angular-basic	Configuration
@tanstack/query-example-react-basic-typescript	Configuration
@tanstack/query-example-solid-basic-typescript	Configuration
@tanstack/query-example-svelte-basic	Configuration
@tanstack/query-example-vue-basic	Configuration

manudeli

These comment was caught by cspell eslint. This rule will remove opportunity to use these misspelling

manudeli · 2024-01-16T15:11:03Z

packages/eslint-plugin-query/src/rules/no-rest-desctructuring/no-rest-destructuring.test.ts

@@ -7,7 +7,7 @@ const ruleTester = new ESLintUtils.RuleTester({
  settings: {},
 })

-ruleTester.run('no-rest-desctructuring', rule, {
+ruleTester.run('no-rest-destructuring', rule, {


desctructuring -> destructuring

manudeli · 2024-01-16T15:11:19Z

packages/query-core/src/tests/hydration.test.tsx

@@ -15,7 +15,7 @@ async function fetchData<TData>(value: TData, ms?: number): Promise<TData> {
 }

 describe('dehydration and rehydration', () => {
-  test('should work with serializeable values', async () => {
+  test('should work with serializable values', async () => {


serializeable -> serializable

manudeli · 2024-01-16T15:11:39Z

packages/query-core/src/tests/queryClient.test.tsx

@@ -433,7 +433,7 @@ describe('queryClient', () => {
      ).resolves.toEqual('bar')
    })

-    test('should return the cached query data if the query is found and cached query data is falsey', async () => {
+    test('should return the cached query data if the query is found and cached query data is falsy', async () => {


falsey -> falsy

manudeli · 2024-01-16T15:12:05Z

packages/query-persist-client-core/src/__tests__/createPersister.test.ts

@@ -245,7 +245,7 @@ describe('createPersister', () => {
    expect(query.fetch).toHaveBeenCalledTimes(1)
  })

-  test('should store item after successfull fetch', async () => {
+  test('should store item after successful fetch', async () => {


successfull -> successful

manudeli · 2024-01-16T15:12:17Z

packages/query-persist-client-core/src/persist.ts

@@ -142,7 +142,7 @@ export function persistQueryClientSubscribe(
      }
    })

-  const unusbscribeMutationCache = props.queryClient
+  const unsubscribeMutationCache = props.queryClient


unusbscribeMutationCache -> unsubscribeMutationCache

manudeli · 2024-01-16T15:12:31Z

packages/react-query/src/__tests__/useQuery.test.tsx

@@ -2722,7 +2722,7 @@ describe('useQuery', () => {
    await waitFor(() => rendered.getByText('data: 1, isFetching: false'))
  })

-  it('should calculate focus behaviour for `refetchOnWindowFocus` depending on function', async () => {
+  it('should calculate focus behavior for `refetchOnWindowFocus` depending on function', async () => {


behaviour -> behavior

manudeli · 2024-01-16T15:12:42Z

packages/solid-query/src/createBaseQuery.ts

@@ -46,14 +46,14 @@ function reconcileFn<TData, TError>(
  return { ...result, data: newData } as typeof result
 }

-type HydrateableQueryState<TData, TError> = QueryObserverResult<TData, TError> &
+type HydratableQueryState<TData, TError> = QueryObserverResult<TData, TError> &


HydrateableQueryState -> HydratableQueryState

manudeli · 2024-01-16T15:12:58Z

packages/solid-query/src/createBaseQuery.ts

@@ -170,7 +170,7 @@ export function createBaseQuery<
            reconcileOptions === undefined ? false : reconcileOptions,
          )
        })
-        // If the query has data we dont suspend but instead mutate the resource
+        // If the query has data we don't suspend but instead mutate the resource


dont -> don't

manudeli · 2024-01-16T15:13:17Z

packages/vue-query/src/__tests__/useQuery.test.ts

@@ -325,24 +325,24 @@ describe('useQuery', () => {
      getCurrentInstanceSpy.mockImplementation(() => ({ suspense: {} }))

      let afterTimeout = false
-      const isEnabeld = ref(false)
+      const isEnabled = ref(false)


isEnabeld -> isEnabled

codecov-commenter · 2024-01-18T23:57:43Z

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (8fff654) 41.78% compared to head (36aa021) 41.78%.

Files	Patch %	Lines
packages/query-devtools/src/Devtools.tsx	0.00%	9 Missing ⚠️
packages/solid-query/src/createBaseQuery.ts	57.14%	3 Missing ⚠️
...verloads/__testfixtures__/default-import.input.tsx	0.00%	2 Missing ⚠️
...erloads/__testfixtures__/default-import.output.tsx	0.00%	2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6718   +/-   ##
=======================================
  Coverage   41.78%   41.78%           
=======================================
  Files         178      178           
  Lines        7017     7017           
  Branches     1421     1421           
=======================================
  Hits         2932     2932           
  Misses       3722     3722           
  Partials      363      363

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

TkDodo · 2024-01-19T21:19:04Z

.eslintrc.cjs

+      'error',
+      {
+        cspell: {
+          words: [


instead of keeping this list that long, could we not just replace some of these that are only used in tests or local variables with known words?

I'll try it soon.

I made it simpler than before in c8770ba

manudeli · 2024-01-20T04:38:57Z

packages/solid-query/src/__tests__/suspense.test.tsx

@@ -705,7 +707,7 @@ describe("useQuery's in Suspense mode", () => {
    expect(queryFn).toHaveBeenCalledTimes(1)
  })

-  it('should error catched in error boundary without infinite loop', async () => {
+  it('should error caught in error boundary without infinite loop', async () => {


catched -> caught

manudeli · 2024-01-20T04:39:59Z

packages/solid-query/src/createBaseQuery.ts

@@ -263,8 +263,8 @@ export function createBaseQuery<
    on(
      [isRestoring, observer],
      ([restoring]) => {
-        const unsub = unsubscribe
-        queueMicrotask(() => unsub?.())
+        const _unsubscribe = unsubscribe


same internal variable name as _*

manudeli · 2024-01-20T04:41:06Z

packages/react-query/src/__tests__/useQuery.test.tsx

@@ -2859,7 +2859,7 @@ describe('useQuery', () => {
      const { status, error } = useQuery({
        queryKey: key,
        queryFn: () => {
-          return Promise.reject(new Error('Error test jaylen'))


I don't know jaylen, but I thought it as unnecessary string

manudeli · 2024-01-20T04:42:57Z

packages/query-core/src/tests/queryClient.test.tsx

@@ -196,7 +196,7 @@ describe('queryClient', () => {
      expect(() => {
        queryClient.setQueryData([key, user], (prevUser?: typeof user) => ({
          ...prevUser!,
-          name: 'Edvin',
+          name: 'James',


I thought James is general user name than Edvin

manudeli · 2024-01-20T04:43:28Z

packages/eslint-plugin-query/src/__tests__/exhaustive-deps.test.ts

@@ -364,13 +364,13 @@ ruleTester.run('exhaustive-deps', rule, {
        const CONST_VAL = 1
        function useHook() {
          const queryClient = useQueryClient()
-          const kueryKlient = useQueryClient()


kuery -> query

manudeli · 2024-01-21T03:09:44Z

@TkDodo check this again please

.eslintrc.cjs

manudeli added 4 commits January 12, 2024 03:33

ci: add @cspell/eslint-plugin to prevent misspelling

a148160

Merge branch 'main' into ci/eslint/add-cspell

c231035

Merge branch 'main' into ci/eslint/add-cspell

43d390f

ci(eslint/cspell): convert rule as error

8f91ba1

manudeli changed the title ~~ci: add @cspell/eslint-plugin to prevent misspelling (error)~~ ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) Jan 16, 2024

Merge branch 'main' into ci/eslint/cspell-as-error

ffd77c5

manudeli commented Jan 16, 2024

View reviewed changes

manudeli marked this pull request as ready for review January 16, 2024 15:14

manudeli mentioned this pull request Jan 16, 2024

ci(eslint): add @cspell/eslint-plugin to prevent misspelling (warning) #6687

Closed

Merge branch 'main' into ci/eslint/cspell-as-error

9c623e6

TkDodo reviewed Jan 19, 2024

View reviewed changes

fix(cspell): reduce unnecessary words to check

c8770ba

manudeli force-pushed the ci/eslint/cspell-as-error branch from c2917ce to c8770ba Compare January 20, 2024 04:32

manudeli commented Jan 20, 2024

View reviewed changes

manudeli requested a review from TkDodo January 20, 2024 04:44

manudeli added 3 commits January 21, 2024 00:11

Merge branch 'main' into ci/eslint/cspell-as-error

eafc9d1

Merge branch 'main' into ci/eslint/cspell-as-error

c8f7921

Merge branch 'main' into ci/eslint/cspell-as-error

b3a932f

manudeli added 4 commits January 22, 2024 20:56

Merge branch 'main' into ci/eslint/cspell-as-error

05f6842

Merge branch 'main' into ci/eslint/cspell-as-error

a5306ca

Merge branch 'main' into ci/eslint/cspell-as-error

ed3377f

Merge branch 'main' into ci/eslint/cspell-as-error

85cf6d4

TkDodo reviewed Jan 27, 2024

View reviewed changes

.eslintrc.cjs Outdated Show resolved Hide resolved

manudeli added 2 commits January 28, 2024 01:09

Merge branch 'main' into ci/eslint/cspell-as-error

ef73f00

fix(eslint): remove ouuid as @cspell/spellchecker's words

36aa021

TkDodo merged commit b32ad24 into TanStack:main Jan 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) #6718

ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) #6718

manudeli commented Jan 16, 2024 •

edited

Loading

vercel bot commented Jan 16, 2024 •

edited

Loading

nx-cloud bot commented Jan 16, 2024 •

edited

Loading

codesandbox-ci bot commented Jan 16, 2024 •

edited

Loading

manudeli left a comment •

edited

Loading

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

manudeli Jan 16, 2024

codecov-commenter commented Jan 18, 2024 •

edited

Loading

TkDodo Jan 19, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli Jan 20, 2024

manudeli commented Jan 21, 2024

ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) #6718

ci(eslint): add @cspell/eslint-plugin to prevent misspelling (error) #6718

Conversation

manudeli commented Jan 16, 2024 • edited Loading

vercel bot commented Jan 16, 2024 • edited Loading

nx-cloud bot commented Jan 16, 2024 • edited Loading

☁️ Nx Cloud Report

codesandbox-ci bot commented Jan 16, 2024 • edited Loading

manudeli left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Jan 18, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

manudeli commented Jan 21, 2024

manudeli commented Jan 16, 2024 •

edited

Loading

vercel bot commented Jan 16, 2024 •

edited

Loading

nx-cloud bot commented Jan 16, 2024 •

edited

Loading

codesandbox-ci bot commented Jan 16, 2024 •

edited

Loading

manudeli left a comment •

edited

Loading

codecov-commenter commented Jan 18, 2024 •

edited

Loading