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

Author: aryaemami59

packages/toolkit/src/createSlice.ts

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

packages/toolkit/src/listenerMiddleware/index.ts

@@ -146,7 +146,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/effectScenarios.test.ts

@@ -1,3 +1,5 @@
+import { noop } from '@internal/tests/utils/helpers'
+import type { PayloadAction } from '@reduxjs/toolkit'
 import {
   configureStore,
   createAction,
@@ -58,7 +60,6 @@ describe('Saga-style Effects Scenarios', () => {
   }
 
   beforeAll(() => {
-    const noop = () => {}
     vi.spyOn(console, 'error').mockImplementation(noop)
   })
 

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

@@ -1,4 +1,5 @@
 import { createListenerEntry } from '@internal/listenerMiddleware'
+import { noop } from '@internal/tests/utils/helpers'
 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

@@ -1,3 +1,21 @@
+import {
+  listenerCancelled,
+  listenerCompleted,
+} from '@internal/listenerMiddleware/exceptions'
+import type {
+  AbortSignalWithReason,
+  AddListenerOverloads,
+} from '@internal/listenerMiddleware/types'
+import { noop } from '@internal/tests/utils/helpers'
+import type {
+  Action,
+  ListenerEffect,
+  ListenerEffectAPI,
+  PayloadAction,
+  TypedRemoveListener,
+  TypedStartListening,
+  UnknownAction,
+} from '@reduxjs/toolkit'
 import {
   TaskAbortError,
   addListener,
@@ -10,28 +28,6 @@ import {
   removeListener,
 } from '@reduxjs/toolkit'
 import type { Mock } from 'vitest'
-import { vi } from 'vitest'
-
-import type {
-  Action,
-  ListenerEffect,
-  ListenerEffectAPI,
-  PayloadAction,
-  TypedAddListener,
-  TypedRemoveListener,
-  TypedStartListening,
-  UnknownAction,
-} from '@reduxjs/toolkit'
-
-import {
-  listenerCancelled,
-  listenerCompleted,
-} from '@internal/listenerMiddleware/exceptions'
-
-import type {
-  AbortSignalWithReason,
-  AddListenerOverloads,
-} from '@internal/listenerMiddleware/types'
 
 const middlewareApi = {
   getState: expect.any(Function),
@@ -51,8 +47,6 @@ const middlewareApi = {
   throwIfCancelled: expect.any(Function),
 }
 
-const noop = () => {}
-
 // Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
 export interface Deferred<T> extends Promise<T> {
   resolve(value?: T | PromiseLike<T>): void
@@ -176,7 +170,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,
@@ -194,7 +190,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,
@@ -206,7 +204,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,
@@ -232,7 +232,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({
@@ -251,7 +253,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)
 
@@ -318,7 +322,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,
@@ -340,7 +346,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('unsubscribing via callback', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       const unsubscribe = startListening({
         actionCreator: testAction1,
@@ -356,7 +364,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('directly unsubscribing', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -377,7 +387,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('subscribing via action', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       store.dispatch(
         addListener({
@@ -397,7 +409,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({
@@ -416,7 +430,9 @@ describe('createListenerMiddleware', () => {
     })
 
     test('unsubscribing via action', () => {
-      const effect = vi.fn((_: TestAction1) => {})
+      const effect = vi.fn((_: TestAction1) => {
+        /** No-Op */
+      })
 
       startListening({
         actionCreator: testAction1,
@@ -636,7 +652,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({
@@ -928,7 +944,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,
@@ -993,7 +1011,7 @@ describe('createListenerMiddleware', () => {
         },
       })
 
-      const effect = vi.fn(() => {})
+      const effect = vi.fn(noop)
       startListening({ matcher, effect })
 
       store.dispatch(testAction1('a'))
@@ -1002,8 +1020,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

@@ -280,7 +280,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

@@ -228,7 +228,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

@@ -109,11 +109,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 function buildSelectors<