Fix problems related to the @typescript-eslint/no-empty-function rule

Author: aryaemami59

packages/toolkit/src/createSlice.ts

@@ -1072,4 +1072,6 @@ function handleThunkCaseReducerDefinition<State>(
   })
 }
 
-function noop() {}
+function noop() {
+  /** No-Op */
+}

packages/toolkit/src/listenerMiddleware/index.ts

@@ -145,7 +145,9 @@ const createTakePattern = <S>(
     validateActive(signal)
 
     // Placeholder unsubscribe function until the listener is added
-    let unsubscribe: UnsubscribeListener = () => {}
+    let unsubscribe: UnsubscribeListener = () => {
+      /** No-Op */
+    }
 
     const tuplePromise = new Promise<[Action, S, S]>((resolve, reject) => {
       // Inside the Promise, we synchronously add the listener.

packages/toolkit/src/listenerMiddleware/tests/listenerMiddleware.test-d.ts

@@ -1,4 +1,5 @@
 import { createListenerEntry } from '@internal/listenerMiddleware'
+import { noop } from '@internal/listenerMiddleware/utils'
 import type {
   Action,
   PayloadAction,
@@ -89,7 +90,7 @@ describe('type tests', () => {
     const unsubscribe = store.dispatch(
       addListener({
         actionCreator: testAction1,
-        effect: () => {},
+        effect: noop,
       }),
     )
 
@@ -168,7 +169,9 @@ describe('type tests', () => {
 
         return true
       },
-      effect: (action, listenerApi) => {},
+      effect: (action, listenerApi) => {
+        /** No-Op */
+      },
     })
 
     startListening({

packages/toolkit/src/listenerMiddleware/tests/listenerMiddleware.test.ts

@@ -177,7 +177,9 @@ describe('createListenerMiddleware', () => {
 
   describe('Subscription and unsubscription', () => {
     test('directly subscribing', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -195,7 +197,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('stopListening returns true if an entry has been unsubscribed, false otherwise', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -207,7 +211,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('dispatch(removeListener({...})) returns true if an entry has been unsubscribed, false otherwise', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -233,7 +239,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('can subscribe with a string action type', () => {
-      const effect = vi.fn((_: UnknownAction) => {})
+      const effect = vi.fn((_: UnknownAction) => {
+        /** No-Op */
+      })
 
       store.dispatch(
         addListener({
@@ -252,7 +260,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('can subscribe with a matcher function', () => {
-      const effect = vi.fn((_: UnknownAction) => {})
+      const effect = vi.fn((_: UnknownAction) => {
+        /** No-Op */
+      })
 
       const isAction1Or2 = isAnyOf(testAction1, testAction2)
 
@@ -319,7 +329,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('subscribing with the same listener will not make it trigger twice (like EventTarget.addEventListener())', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -341,7 +353,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('subscribing with the same effect but different predicate is allowed', () => {
-      const effect = vi.fn((_: TestAction1 | TestAction2) => {})
+      const effect = vi.fn((_: TestAction1 | TestAction2) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -362,7 +376,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('unsubscribing via callback', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       const unsubscribe = startListening({
         actionCreator: testAction1,
@@ -378,7 +394,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('directly unsubscribing', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -399,7 +417,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('subscribing via action', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       store.dispatch(
         addListener({
@@ -419,7 +439,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('unsubscribing via callback from dispatch', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       const unsubscribe = store.dispatch(
         addListener({
@@ -438,7 +460,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('unsubscribing via action', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -658,7 +682,7 @@ describe('createListenerMiddleware', () => {
       let listenerCancelled = false
       let listenerStarted = false
       let listenerCompleted = false
-      let cancelListener: () => void = () => {}
+      let cancelListener: () => void = noop
       let error: TaskAbortError | undefined = undefined
 
       startListening({
@@ -950,7 +974,9 @@ describe('createListenerMiddleware', () => {
     test('by default, actions are forwarded to the store', () => {
       reducer.mockClear()
 
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -1015,7 +1041,7 @@ describe('createListenerMiddleware', () => {
         },
       })
 
-      const effect = vi.fn(() => {})
+      const effect = vi.fn(noop)
       startListening({ matcher, effect })
 
       store.dispatch(testAction1('a'))
@@ -1024,8 +1050,8 @@ describe('createListenerMiddleware', () => {
 
     test('Continues running other listeners if a predicate raises an error', () => {
       const matcher = (action: any): action is any => true
-      const firstListener = vi.fn(() => {})
-      const secondListener = vi.fn(() => {})
+      const firstListener = vi.fn(noop)
+      const secondListener = vi.fn(noop)
 
       startListening({
         // @ts-expect-error

packages/toolkit/src/listenerMiddleware/utils.ts

@@ -12,7 +12,9 @@ export const assertFunction: (
   }
 }
 
-export const noop = () => {}
+export const noop = () => {
+  /** No-Op */
+}
 
 export const catchRejection = <T>(
   promise: Promise<T>,

packages/toolkit/src/query/core/buildMiddleware/cacheLifecycle.ts

@@ -325,7 +325,9 @@ export const buildCacheLifecycleHandler: InternalHandlerBuilder = ({
     ])
     // prevent uncaught promise rejections from happening.
     // if the original promise is used in any way, that will create a new promise that will throw again
-    cacheDataLoaded.catch(() => {})
+    cacheDataLoaded.catch(() => {
+      /** No-Op */
+    })
     lifecycleMap[queryCacheKey] = lifecycle
     const selector = (api.endpoints[endpointName] as any).select(
       endpointDefinition.type === DefinitionType.query

packages/toolkit/src/query/core/buildMiddleware/queryLifecycle.ts

@@ -456,7 +456,9 @@ export const buildQueryLifecycleHandler: InternalHandlerBuilder = ({
           })
         // prevent uncaught promise rejections from happening.
         // if the original promise is used in any way, that will create a new promise that will throw again
-        queryFulfilled.catch(() => {})
+        queryFulfilled.catch(() => {
+          /** No-Op */
+        })
         lifecycleMap[requestId] = lifecycle
         const selector = (api.endpoints[endpointName] as any).select(
           endpointDefinition.type === DefinitionType.query

packages/toolkit/src/query/core/buildSelectors.ts

@@ -152,11 +152,15 @@ const initialSubState: QuerySubState<any> = {
 // abuse immer to freeze default states
 const defaultQuerySubState = /* @__PURE__ */ createNextState(
   initialSubState,
-  () => {},
+  () => {
+    /** No-Op */
+  },
 )
 const defaultMutationSubState = /* @__PURE__ */ createNextState(
   initialSubState as MutationSubState<any>,
-  () => {},
+  () => {
+    /** No-Op */
+  },
 )
 
 export type AllSelectors = ReturnType<typeof buildSelectors>

packages/toolkit/src/query/core/buildSlice.ts

@@ -1,66 +1,52 @@
-import type { Action, PayloadAction, UnknownAction } from '@reduxjs/toolkit'
+import type { PayloadAction } from '@reduxjs/toolkit'
+import type { Patch } from 'immer'
+import { applyPatches, isDraft, original } from 'immer'
+import type { ApiContext } from '../apiTypes'
+import type { InternalSerializeQueryArgs } from '../defaultSerializeQueryArgs'
+import type {
+  AssertTagTypes,
+  EndpointDefinitions,
+  FullTagDescription,
+  QueryArgFrom,
+  QueryDefinition,
+  ResultTypeFrom,
+} from '../endpointDefinitions'
 import {
-  combineReducers,
-  createAction,
-  createSlice,
-  isAnyOf,
-  isFulfilled,
-  isRejectedWithValue,
-  createNextState,
-  prepareAutoBatched,
-  SHOULD_AUTOBATCH,
-  nanoid,
-} from './rtkImports'
+  copyWithStructuralSharing,
+  isDocumentVisible,
+  isOnline,
+} from '../utils'
 import type {
-  QuerySubstateIdentifier,
-  QuerySubState,
-  MutationSubstateIdentifier,
-  MutationSubState,
+  ConfigState,
+  InvalidationState,
   MutationState,
+  MutationSubState,
+  MutationSubstateIdentifier,
+  QueryCacheKey,
+  QueryKeys,
   QueryState,
-  InvalidationState,
+  QuerySubState,
+  QuerySubstateIdentifier,
   Subscribers,
-  QueryCacheKey,
   SubscriptionState,
-  ConfigState,
-  QueryKeys,
-  InfiniteQuerySubState,
-  InfiniteQueryDirection,
 } from './apiState'
 import { QueryStatus } from './apiState'
-import type {
-  AllQueryKeys,
-  QueryArgFromAnyQueryDefinition,
-  DataFromAnyQueryDefinition,
-  InfiniteQueryThunk,
-  MutationThunk,
-  QueryThunk,
-  QueryThunkArg,
-  RejectedAction,
-} from './buildThunks'
+import { isUpsertQuery } from './buildInitiate'
+import type { MutationThunk, QueryThunk, QueryThunkArg } from './buildThunks'
 import { calculateProvidedByThunk } from './buildThunks'
 import {
-  isInfiniteQueryDefinition,
-  type AssertTagTypes,
-  type DefinitionType,
-  type EndpointDefinitions,
-  type FullTagDescription,
-  type QueryArgFrom,
-  type QueryDefinition,
-  type ResultTypeFrom,
-} from '../endpointDefinitions'
-import type { Patch } from 'immer'
-import { isDraft } from 'immer'
-import { applyPatches, original } from 'immer'
+  SHOULD_AUTOBATCH,
+  combineReducers,
+  createAction,
+  createNextState,
+  createSlice,
+  isAnyOf,
+  isFulfilled,
+  isRejectedWithValue,
+  nanoid,
+  prepareAutoBatched,
+} from './rtkImports'
 import { onFocus, onFocusLost, onOffline, onOnline } from './setupListeners'
-import {
-  isDocumentVisible,
-  isOnline,
-  copyWithStructuralSharing,
-} from '../utils'
-import type { ApiContext } from '../apiTypes'
-import { isUpsertQuery } from './buildInitiate'
-import type { InternalSerializeQueryArgs } from '../defaultSerializeQueryArgs'
 
 /**
  * A typesafe single entry to be upserted into the cache
@@ -608,7 +594,9 @@ export function buildSlice({
       ) {
         // Dummy
       },
-      internal_getRTKQSubscriptions() {},
+      internal_getRTKQSubscriptions() {
+        /** No-Op */
+      },
     },
   })
 

packages/toolkit/src/query/tests/apiProvider.test.tsx

@@ -1,3 +1,4 @@
+import { noop } from '@internal/listenerMiddleware/utils'
 import { configureStore } from '@reduxjs/toolkit'
 import {
   ApiProvider,
@@ -77,7 +78,7 @@ describe('ApiProvider', () => {
   })
   test('ApiProvider throws if nested inside a Redux context', () => {
     // Intentionally swallow the "unhandled error" message
-    vi.spyOn(console, 'error').mockImplementation(() => {})
+    vi.spyOn(console, 'error').mockImplementation(noop)
     expect(() =>
       render(
         <Provider store={configureStore({ reducer: () => null })}>