chore(linting): Re-enable some ts-eslint rules (#11256)

Refactors the eslint config to re-enable some of the recommended rules
which had been disable.

This PR does change types but my hope is that they aren't functional
changes so will not be breaking or have an effect.

.eslintrc.js

@@ -173,35 +173,30 @@ module.exports = {
     },
     // TypeScript specific linting
     {
-      files: ['*.ts', '*.tsx'],
+      files: ['*.ts', '*.mts', '*.tsx'],
       parser: '@typescript-eslint/parser',
       extends: [
         'plugin:@typescript-eslint/recommended',
         'plugin:@typescript-eslint/stylistic',
       ],
       rules: {
-        // TODO: look into enabling these eventually
-        '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/prefer-function-type': 'off',
-
-        // Specific 'recommended' rules we alter
-        '@typescript-eslint/no-var-requires': 'off',
+        // This is disabled for now because of our legacy usage of `require`. It should be enabled in the future.
         '@typescript-eslint/no-require-imports': 'off',
-        '@typescript-eslint/no-empty-object-type': 'off',
+
+        // We allow exceptions to the no-unused-vars rule for variables that start with an underscore
+        'no-unused-vars': 'off',
         '@typescript-eslint/no-unused-vars': [
           'error',
           { varsIgnorePattern: '^_', argsIgnorePattern: '^_' },
         ],
 
-        // TODO: Look into enabling these eventually
+        // TODO(jgmw): Look into enabling these eventually
         '@typescript-eslint/array-type': 'off',
         '@typescript-eslint/consistent-generic-constructors': 'off',
         '@typescript-eslint/consistent-indexed-object-style': 'off',
         '@typescript-eslint/consistent-type-definitions': 'off',
         '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/no-empty-object-type': 'off',
         '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/no-require-imports': 'off',
         '@typescript-eslint/prefer-for-of': 'off',
         '@typescript-eslint/prefer-function-type': 'off',
         '@typescript-eslint/consistent-type-imports': 'error',
@@ -220,14 +215,17 @@ module.exports = {
         jest: true,
       },
     },
+    // Set the correct environment for this eslint config file
     {
-      files: [
-        '.babelrc.js',
-        'babel.config.js',
-        '.eslintrc.js',
-        '*.config.js',
-        'jest.setup.js',
-      ],
+      files: ['.eslintrc.js'],
+      env: {
+        node: true,
+        commonjs: true,
+      },
+    },
+    // Set the correct environment for Jest config files
+    {
+      files: ['jest.config.js', 'jest.setup.js'],
       env: {
         node: true,
         commonjs: true,

packages/api/src/validations/validations.ts

@@ -28,7 +28,7 @@ interface AcceptanceValidatorOptions extends WithOptionalMessage {
   in?: Array<unknown>
 }
 
-interface EmailValidatorOptions extends WithOptionalMessage {}
+type EmailValidatorOptions = WithOptionalMessage
 
 interface ExclusionValidatorOptions extends WithOptionalMessage {
   /**

packages/auth-providers/auth0/web/src/auth0.ts

@@ -8,6 +8,7 @@ import type { CurrentUser } from '@redwoodjs/auth'
 import { createAuthentication } from '@redwoodjs/auth'
 
 // TODO: Map out this user properly.
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface Auth0User {}
 
 export function createAuth(

packages/auth-providers/dbAuth/middleware/build.mts

@@ -1,7 +1,7 @@
-import { build, defaultBuildOptions } from '@redwoodjs/framework-tools'
+import { writeFileSync } from 'node:fs'
 
+import { build, defaultBuildOptions } from '@redwoodjs/framework-tools'
 import { generateCjsTypes } from '@redwoodjs/framework-tools/cjsTypes'
-import { writeFileSync } from 'node:fs'
 
 // CJS build
 await build({

packages/auth-providers/supabase/middleware/build.mts

@@ -1,7 +1,7 @@
-import { build, defaultBuildOptions } from '@redwoodjs/framework-tools'
+import { writeFileSync } from 'node:fs'
 
+import { build, defaultBuildOptions } from '@redwoodjs/framework-tools'
 import { generateCjsTypes } from '@redwoodjs/framework-tools/cjsTypes'
-import { writeFileSync } from 'node:fs'
 
 // CJS build
 await build({

packages/cli-packages/storybook-vite/build.mts

@@ -2,10 +2,10 @@ import fs from 'node:fs/promises'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-import { build, defaultIgnorePatterns } from '@redwoodjs/framework-tools'
-
 import fg from 'fast-glob'
 
+import { build, defaultIgnorePatterns } from '@redwoodjs/framework-tools'
+
 await build()
 
 /**

packages/cli/build.mts

@@ -2,10 +2,10 @@ import fs from 'node:fs/promises'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-import { build, defaultIgnorePatterns } from '@redwoodjs/framework-tools'
-
 import fg from 'fast-glob'
 
+import { build, defaultIgnorePatterns } from '@redwoodjs/framework-tools'
+
 await build()
 
 // The CLI depends on assets like templates files

packages/cli/testUtils.d.ts

@@ -82,6 +82,7 @@ interface CustomMatchers<R = unknown> {
 }
 
 declare module 'vitest' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface Assertion<T = any> extends CustomMatchers<T> {}
 }
 

packages/context/src/context.ts

@@ -1,5 +1,6 @@
 import { getAsyncStoreInstance } from './store'
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface GlobalContext extends Record<string, unknown> {}
 
 export const createContextProxy = (target: GlobalContext) => {

packages/forms/vitest.setup.mts

@@ -1,5 +1,5 @@
-import { afterEach } from 'vitest'
 import { cleanup } from '@testing-library/react'
+import { afterEach } from 'vitest'
 import '@testing-library/jest-dom/vitest'
 
 afterEach(() => {

packages/graphql-server/src/globalContext.ts

@@ -3,6 +3,7 @@ import { getAsyncStoreInstance } from './globalContextStore'
 /**
  * @deprecated This type will be available only from the `@redwoodjs/context` package in a future release.
  */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface GlobalContext extends Record<string, unknown> {}
 
 /**

packages/router/src/index.ts

@@ -42,6 +42,7 @@ export { SkipNavLink, SkipNavContent } from './skipNav.js'
  * }
  */
 // Keep this in index.ts so it can be extended with declaration merging
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface AvailableRoutes {}
 
 // Used by packages/internal/src/generate/templates/web-routerRoutes.d.ts.template

packages/router/src/location.tsx

@@ -5,10 +5,12 @@ import { createNamedContext } from './createNamedContext.js'
 import { gHistory } from './history.js'
 import type { TrailingSlashesTypes } from './util.js'
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface LocationContextType extends URL {}
 
 const LocationContext = createNamedContext<LocationContextType>('Location')
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 interface Location extends URL {}
 
 interface LocationProviderProps {

packages/router/vitest.setup.mts

@@ -1,7 +1,7 @@
 import '@testing-library/jest-dom/vitest'
 
-import { afterEach, vi } from 'vitest'
 import { cleanup } from '@testing-library/react'
+import { afterEach, vi } from 'vitest'
 
 vi.spyOn(globalThis, 'scrollTo').mockImplementation(() => {})
 

packages/server-store/src/serverStore.ts

@@ -3,6 +3,7 @@ import { AsyncLocalStorage } from 'async_hooks'
 import type { ServerAuthState } from '@redwoodjs/auth/dist/AuthProvider/ServerAuthProvider.js' with { 'resolution-mode': 'import' }
 import { CookieJar } from '@redwoodjs/cookie-jar'
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ServerStore extends Map<string, any> {}
 
 let PER_REQ_STORAGE: AsyncLocalStorage<ServerStore>

packages/structure/src/x/vscode.ts

@@ -340,6 +340,6 @@ export function Command_cli(cmd: string, title = 'run...'): Command {
   return { command: 'redwoodjs.cli', arguments: [cmd], title }
 }
 
-type ReplacePropTypes<T extends {}, Replacements extends {}> = {
+type ReplacePropTypes<T extends object, Replacements extends object> = {
   [K in keyof T]: K extends keyof Replacements ? Replacements[K] : T[K]
 }

packages/testing/vitest.setup.mts

@@ -1,7 +1,7 @@
 import '@testing-library/jest-dom/vitest'
 
-import { afterEach, beforeAll } from 'vitest'
 import { cleanup } from '@testing-library/react'
+import { afterEach, beforeAll } from 'vitest'
 
 import { startMSW } from './src/web/mockRequests'
 

packages/web/src/apollo/typeOverride.ts

@@ -13,37 +13,45 @@ import type {
 
 // @MARK: Override relevant types from Apollo here
 declare global {
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface QueryOperationResult<
     TData = any,
     TVariables extends OperationVariables = OperationVariables,
   > extends QueryResult<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface MutationOperationResult<TData, TVariables>
     extends MutationTuple<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface SubscriptionOperationResult<
     TData = any,
     TVariables extends OperationVariables = OperationVariables,
   > extends SubscriptionResult<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface GraphQLQueryHookOptions<
     TData,
     TVariables extends OperationVariables,
   > extends QueryHookOptions<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface GraphQLMutationHookOptions<TData, TVariables>
     extends MutationHookOptions<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface GraphQLSubscriptionHookOptions<
     TData,
     TVariables extends OperationVariables,
   > extends SubscriptionHookOptions<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface SuspenseQueryOperationResult<
     TData = any,
     TVariables extends OperationVariables = OperationVariables,
   > extends UseSuspenseQueryResult<TData, TVariables> {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface GraphQLSuspenseQueryHookOptions<
     TData,
     TVariables extends OperationVariables,

packages/web/src/global.web-auto-imports.ts

@@ -43,6 +43,7 @@ declare global {
   }
 
   // not defining it here, because it gets overridden by Apollo provider anyway
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   interface MutationOperationResult<TData, TVariables> {}
 
   // Overridable useQuery and useMutation hooks

packages/web/vitest.setup.mts

@@ -1,7 +1,7 @@
 import '@testing-library/jest-dom/vitest'
 
-import { afterEach } from 'vitest'
 import { cleanup } from '@testing-library/react'
+import { afterEach } from 'vitest'
 import '@testing-library/jest-dom/vitest'
 
 afterEach(() => {