Fix the remaining lint issues

aryaemami59 · aryaemami59 · commit f0635677c19c · 2025-02-14T16:13:04.000-06:00
diff --git a/docs/virtual/matchers/index.ts b/docs/virtual/matchers/index.ts
@@ -1,8 +1,5 @@
-import {
-  createAsyncThunk,
-  createReducer,
-  PayloadAction,
-} from '@reduxjs/toolkit'
+import type { PayloadAction } from '@reduxjs/toolkit'
+import { createAsyncThunk, createReducer } from '@reduxjs/toolkit'
 
 export interface Data {
   isInteresting: boolean
diff --git a/docs/virtual/petstore-api.generated/petstore-api.generated.ts b/docs/virtual/petstore-api.generated/petstore-api.generated.ts
@@ -123,6 +123,7 @@ export const api = createApi({
     }),
   }),
 })
+type AnyNonNullishValue = NonNullable<unknown>
 export type UpdatePetApiResponse = /** status 200 Successful operation */ Pet
 export type UpdatePetApiArg = {
   /** Update an existent pet in the store */
@@ -174,10 +175,9 @@ export type UploadFileApiArg = {
   additionalMetadata?: string
   body: string
 }
-export type GetInventoryApiResponse = /** status 200 successful operation */ {
-  [key: string]: number
-}
-export type GetInventoryApiArg = {}
+export type GetInventoryApiResponse =
+  /** status 200 successful operation */ Record<string, number>
+export type GetInventoryApiArg = AnyNonNullishValue
 export type PlaceOrderApiResponse = /** status 200 successful operation */ Order
 export type PlaceOrderApiArg = {
   order: Order
@@ -211,7 +211,7 @@ export type LoginUserApiArg = {
   password?: string
 }
 export type LogoutUserApiResponse = unknown
-export type LogoutUserApiArg = {}
+export type LogoutUserApiArg = AnyNonNullishValue
 export type GetUserByNameApiResponse =
   /** status 200 successful operation */ User
 export type GetUserByNameApiArg = {
diff --git a/packages/rtk-query-codegen-openapi/src/bin/cli.ts b/packages/rtk-query-codegen-openapi/src/bin/cli.ts
@@ -13,7 +13,9 @@ try {
     require('esbuild-runner/register')
   }
   ts = true
-} catch {}
+} catch {
+  /** No-Op */
+}
 
 try {
   if (!ts) {
@@ -29,9 +31,10 @@ try {
 
     ts = true
   }
-} catch {}
+} catch {
+  /** No-Op */
+}
 
-// tslint:disable-next-line
 const meta = require('../../package.json')
 
 program.version(meta.version).usage('</path/to/config.js>').parse(process.argv)
diff --git a/packages/rtk-query-codegen-openapi/src/generate.ts b/packages/rtk-query-codegen-openapi/src/generate.ts
@@ -2,13 +2,13 @@ import camelCase from 'lodash.camelcase'
 import path from 'node:path'
 import ApiGenerator, {
   getOperationName as _getOperationName,
-  getReferenceName,
-  isReference,
-  supportDeepObjects,
   createPropertyAssignment,
   createQuestionToken,
+  getReferenceName,
+  isReference,
   isValidIdentifier,
   keywordType,
+  supportDeepObjects,
 } from 'oazapfts/generate'
 import type { OpenAPIV3 } from 'openapi-types'
 import ts from 'typescript'
@@ -649,7 +649,7 @@ function generatePathExpression(
   isFlatArg: boolean,
   encodePathParams: boolean,
 ) {
-  const expressions: Array<[string, string]> = []
+  const expressions: [string, string][] = []
 
   const head = path.replace(
     /\{(.*?)}(.*?)(?=\{|$)/g,
diff --git a/packages/rtk-query-codegen-openapi/src/generators/react-hooks.ts b/packages/rtk-query-codegen-openapi/src/generators/react-hooks.ts
@@ -1,12 +1,12 @@
-import ts from 'typescript'
 import { getOperationName } from 'oazapfts/generate'
-import { capitalize, isQuery } from '../utils'
+import ts from 'typescript'
+import { getOverrides } from '../generate'
 import type {
-  OperationDefinition,
-  EndpointOverrides,
   ConfigFile,
+  EndpointOverrides,
+  OperationDefinition,
 } from '../types'
-import { getOverrides } from '../generate'
+import { capitalize, isQuery } from '../utils'
 import { factory } from '../utils/factory'
 
 type HooksConfigOptions = NonNullable<ConfigFile['hooks']>
diff --git a/packages/rtk-query-codegen-openapi/src/types.ts b/packages/rtk-query-codegen-openapi/src/types.ts
@@ -18,7 +18,18 @@ type Optional<T, K extends keyof T> = { [k in K]?: NonNullable<T[k]> } & Omit<
   T,
   K
 >
-type Id<T> = { [K in keyof T]: T[K] } & {}
+
+/**
+ * An alias for type `{}`. Represents any value that is not
+ * `null` or `undefined`. It is mostly used for semantic purposes
+ * to help distinguish between an empty object type and `{}` as
+ * they are not the same.
+ *
+ * @internal
+ */
+export type AnyNonNullishValue = NonNullable<unknown>
+
+type Id<T> = { [K in keyof T]: T[K] } & AnyNonNullishValue
 type AtLeastOneKey<T> = {
   [K in keyof T]-?: Pick<T, K> & Partial<T>
 }[keyof T]
@@ -168,8 +179,6 @@ export type ConfigFile =
   | Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>>
   | Id<
       Omit<CommonOptions, 'outputFile'> & {
-        outputFiles: {
-          [outputFile: string]: Omit<OutputFileOptions, 'outputFile'>
-        }
+        outputFiles: Record<string, Omit<OutputFileOptions, 'outputFile'>>
       }
     >
diff --git a/packages/rtk-query-codegen-openapi/test/fixtures/customBaseQuery.ts b/packages/rtk-query-codegen-openapi/test/fixtures/customBaseQuery.ts
@@ -1,5 +1,9 @@
-export const namedBaseQuery = () => {}
+export const namedBaseQuery = () => {
+  /** No-Op */
+}
 
-export function anotherNamedBaseQuery() {}
+export function anotherNamedBaseQuery() {
+  /** No-Op */
+}
 
 export default namedBaseQuery
diff --git a/packages/rtk-query-codegen-openapi/test/fixtures/customBaseQueryWithoutDefault.ts b/packages/rtk-query-codegen-openapi/test/fixtures/customBaseQueryWithoutDefault.ts
@@ -1 +1,3 @@
-function customBaseQuery() {}
+function customBaseQuery() {
+  /** No-Op */
+}
diff --git a/packages/rtk-query-codegen-openapi/test/fixtures/generated.ts b/packages/rtk-query-codegen-openapi/test/fixtures/generated.ts
@@ -1,5 +1,6 @@
-import { createApi } from '@reduxjs/toolkit/query/react'
 import { fetchBaseQuery } from '@reduxjs/toolkit/query'
+import { createApi } from '@reduxjs/toolkit/query/react'
+import type { AnyNonNullishValue } from '../../src/types.js'
 export const api = createApi({
   baseQuery: fetchBaseQuery({ baseUrl: '/api/v3' }),
   tagTypes: [],
@@ -132,7 +133,7 @@ export const api = createApi({
 export type GetHealthcheckApiResponse = /** status 200 OK */ {
   message: string
 }
-export type GetHealthcheckApiArg = {}
+export type GetHealthcheckApiArg = AnyNonNullishValue
 export type UpdatePetApiResponse = /** status 200 Successful operation */ Pet
 export type UpdatePetApiArg = {
   /** Update an existent pet in the store */
@@ -184,10 +185,9 @@ export type UploadFileApiArg = {
   additionalMetadata?: string
   body: string
 }
-export type GetInventoryApiResponse = /** status 200 successful operation */ {
-  [key: string]: number
-}
-export type GetInventoryApiArg = {}
+export type GetInventoryApiResponse =
+  /** status 200 successful operation */ Record<string, number>
+export type GetInventoryApiArg = AnyNonNullishValue
 export type PlaceOrderApiResponse = /** status 200 successful operation */ Order
 export type PlaceOrderApiArg = {
   order: Order
@@ -221,7 +221,7 @@ export type LoginUserApiArg = {
   password?: string
 }
 export type LogoutUserApiResponse = unknown
-export type LogoutUserApiArg = {}
+export type LogoutUserApiArg = AnyNonNullishValue
 export type GetUserByNameApiResponse =
   /** status 200 successful operation */ User
 export type GetUserByNameApiArg = {
diff --git a/packages/rtk-query-codegen-openapi/test/fixtures/petstore.yaml.mock.ts b/packages/rtk-query-codegen-openapi/test/fixtures/petstore.yaml.mock.ts
@@ -3,12 +3,12 @@ openapi: 3.0.2
 info:
   title: Swagger Petstore - OpenAPI 3.0
   description: "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.\
-    \  You can find out more about\nSwagger at [http://swagger.io](http://swagger.io).\
-    \ In the third iteration of the pet store, we've switched to the design first\
-    \ approach!\nYou can now help us improve the API whether it's by making changes\
-    \ to the definition itself or to the code.\nThat way, with time, we can improve\
-    \ the API in general, and expose some of the new features in OAS3.\n\nSome useful\
-    \ links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n\
+    You can find out more about\nSwagger at [http://swagger.io](http://swagger.io).\
+    In the third iteration of the pet store, we've switched to the design first\
+    approach!\nYou can now help us improve the API whether it's by making changes\
+    to the definition itself or to the code.\nThat way, with time, we can improve\
+    the API in general, and expose some of the new features in OAS3.\n\nSome useful\
+    links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n\
     - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)"
   termsOfService: http://swagger.io/terms/
   contact:
@@ -157,7 +157,7 @@ paths:
         - pet
       summary: Finds Pets by tags
       description: "Multiple tags can be provided with comma separated strings. Use\
-        \ tag1, tag2, tag3 for testing."
+        tag1, tag2, tag3 for testing."
       operationId: findPetsByTags
       parameters:
         - name: tags
diff --git a/packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts b/packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts
@@ -32,7 +32,7 @@ test('should include default response type in request when includeDefault is set
     schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
     includeDefault: true,
   })
-  // eslint-disable-next-line no-template-curly-in-string
+
   expect(api).toMatch(
     /export type CreateUserApiResponse =[\s\S/*]+status default successful operation[\s/*]+User;/,
   )
@@ -197,7 +197,7 @@ describe('option encodePathParams', () => {
       ...config,
       filterEndpoints: ['getOrderById'],
     })
-    // eslint-disable-next-line no-template-curly-in-string
+
     expect(api).toContain(
       '`/store/order/${encodeURIComponent(String(queryArg.orderId))}`',
     )
@@ -226,7 +226,7 @@ describe('option encodePathParams', () => {
       flattenArg: true,
       filterEndpoints: ['getOrderById'],
     })
-    // eslint-disable-next-line no-template-curly-in-string
+
     expect(api).toContain(
       '`/store/order/${encodeURIComponent(String(queryArg))}`',
     )
@@ -238,7 +238,7 @@ describe('option encodePathParams', () => {
       encodePathParams: false,
       filterEndpoints: ['findPetsByStatus', 'getOrderById'],
     })
-    // eslint-disable-next-line no-template-curly-in-string
+
     expect(api).toContain('`/store/order/${queryArg.orderId}`')
   })
 })
@@ -266,7 +266,7 @@ describe('option encodeQueryParams', () => {
       ...config,
       filterEndpoints: ['getOrderById'],
     })
-    // eslint-disable-next-line no-template-curly-in-string
+
     expect(api).toContain('`/store/order/${queryArg.orderId}`')
   })
 
@@ -301,7 +301,7 @@ describe('option flattenArg', () => {
       ...config,
       filterEndpoints: ['getOrderById'],
     })
-    // eslint-disable-next-line no-template-curly-in-string
+
     expect(api).toContain('`/store/order/${queryArg}`')
     expect(api).toMatch(
       /export type GetOrderByIdApiArg =[\s/*]+ID of order that needs to be fetched[\s/*]+number;/,
@@ -471,7 +471,7 @@ test('should use brackets in a querystring urls arg, when the arg contains full
     apiFile: './fixtures/emptyApi.ts',
     schemaFile: resolve(__dirname, 'fixtures/params.json'),
   })
-  // eslint-disable-next-line no-template-curly-in-string
+
   expect(api).toContain('`/api/v1/list/${queryArg["item.id"]}`')
   expect(api).toMatchSnapshot()
 })
@@ -482,7 +482,7 @@ test('duplicate parameter names must be prefixed with a path or query prefix', a
     apiFile: './fixtures/emptyApi.ts',
     schemaFile: resolve(__dirname, 'fixtures/params.json'),
   })
-  // eslint-disable-next-line no-template-curly-in-string
+
   expect(api).toContain('pathSomeName: string')
   expect(api).toContain('querySomeName: string')
   expect(api).toMatchSnapshot()
diff --git a/packages/rtk-query-codegen-openapi/test/mocks/server.ts b/packages/rtk-query-codegen-openapi/test/mocks/server.ts
@@ -1,5 +1,5 @@
 import { headersToObject } from 'headers-polyfill'
-import { http, HttpResponse } from 'msw'
+import { HttpResponse, http } from 'msw'
 import { setupServer } from 'msw/node'
 import petstoreJSON from '../fixtures/petstore.json'
 import petstoreYAML from '../fixtures/petstore.yaml.mock'
diff --git a/packages/rtk-query-graphql-request-base-query/src/GraphqlBaseQueryTypes.ts b/packages/rtk-query-graphql-request-base-query/src/GraphqlBaseQueryTypes.ts
@@ -1,9 +1,9 @@
 import type { BaseQueryApi } from '@reduxjs/toolkit/query'
 import type {
+  ClientError,
   GraphQLClient,
-  RequestOptions,
   RequestDocument,
-  ClientError,
+  RequestOptions,
 } from 'graphql-request'
 
 export type Document = RequestDocument
diff --git a/packages/rtk-query-graphql-request-base-query/src/index.ts b/packages/rtk-query-graphql-request-base-query/src/index.ts
@@ -1,7 +1,8 @@
 import { isPlainObject } from '@reduxjs/toolkit'
 import type { BaseQueryFn } from '@reduxjs/toolkit/query'
 import type { DocumentNode } from 'graphql'
-import { GraphQLClient, ClientError, RequestOptions } from 'graphql-request'
+import type { RequestOptions } from 'graphql-request'
+import { ClientError, GraphQLClient } from 'graphql-request'
 import type {
   ErrorResponse,
   GraphqlRequestBaseQueryArgs,
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -1,10 +1,10 @@
 // site configuration options.
-import { resolve } from 'path'
-import { linkDocblocks, transpileCodeblocks } from 'remark-typescript-tools'
+import type { Options as UmamiOptions } from '@dipakparmar/docusaurus-plugin-umami'
 import type { Options, ThemeConfig } from '@docusaurus/preset-classic'
 import type { Config } from '@docusaurus/types'
-import type { Options as UmamiOptions } from '@dipakparmar/docusaurus-plugin-umami'
-import type { Options as RSDoctorOptions } from '@docusaurus/plugin-rsdoctor'
+import { resolve } from 'path'
+import { linkDocblocks, transpileCodeblocks } from 'remark-typescript-tools'
+import monokaiTheme from './src/js/monokaiTheme.js'
 
 const config: Config = {
   future: {
@@ -72,15 +72,15 @@ const config: Config = {
   themeConfig: {
     metadata: [{ name: 'twitter:card', content: 'summary' }],
     prism: {
-      theme: require('./src/js/monokaiTheme.js'),
+      theme: monokaiTheme,
     },
     image: 'img/redux-logo-landscape.png',
     colorMode: {
       respectPrefersColorScheme: true,
     },
     announcementBar: {
       id: 'redux-dev-course',
-      content: `      
+      content: `
       <a href="https://redux.dev">
         <img
           src="/img/course-callout-wide.svg"
diff --git a/website/src/theme/DocPage/Layout/Main/BraveWarning.js b/website/src/theme/DocPage/Layout/Main/BraveWarning.js
@@ -1,4 +1,4 @@
-import React, { useState, useEffect } from 'react'
+import React, { useEffect, useState } from 'react'
 
 function BraveWarning() {
   const [isBrave, setIsBrave] = useState(false)
