refactor: drop @typescript-eslint/utils on production (#362)

Author: JounQin

.changeset/legal-squids-cover.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+refactor: drop @typescript-eslint/utils on production

package.json

@@ -64,16 +64,20 @@
     "watch": "yarn test --watch"
   },
   "peerDependencies": {
+    "@typescript-eslint/utils": "^8.0.0",
     "eslint": "^8.57.0 || ^9.0.0",
     "eslint-import-resolver-node": "*"
   },
   "peerDependenciesMeta": {
+    "@typescript-eslint/utils": {
+      "optional": true
+    },
     "eslint-import-resolver-node": {
       "optional": true
     }
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^8.33.0",
+    "@typescript-eslint/types": "^8.33.0",
     "comment-parser": "^1.4.1",
     "debug": "^4.4.1",
     "eslint-import-context": "^0.1.6",
@@ -123,6 +127,7 @@
     "@typescript-eslint/eslint-plugin": "^8.33.0",
     "@typescript-eslint/parser": "^8.33.0",
     "@typescript-eslint/rule-tester": "^8.33.0",
+    "@typescript-eslint/utils": "^8.33.0",
     "@unts/patch-package": "^8.1.1",
     "clean-pkg-json": "^1.3.0",
     "eslint": "^9.27.0",

src/rules/dynamic-import-chunkname.ts

@@ -1,7 +1,6 @@
 import vm from 'node:vm'
 
-import type { TSESTree } from '@typescript-eslint/utils'
-import type { RuleFixer } from '@typescript-eslint/utils/ts-eslint'
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 
 import { createRule } from '../utils/index.js'
 
@@ -146,7 +145,7 @@ export default createRule<[Options?], MessageId>({
       }
 
       const removeCommentsAndLeadingSpaces = (
-        fixer: RuleFixer,
+        fixer: TSESLint.RuleFixer,
         comment: TSESTree.Comment,
       ) => {
         const leftToken = sourceCode.getTokenBefore(comment)

src/rules/export.ts

@@ -1,4 +1,4 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils'
+import { AST_NODE_TYPES } from '@typescript-eslint/types'
 import type { TSESTree } from '@typescript-eslint/utils'
 
 import {

src/rules/extensions.ts

@@ -1,7 +1,6 @@
 import path from 'node:path'
 
-import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema'
-import type { RuleFixer } from '@typescript-eslint/utils/ts-eslint'
+import type { JSONSchema, TSESLint } from '@typescript-eslint/utils'
 import { minimatch } from 'minimatch'
 import type { MinimatchOptions } from 'minimatch'
 
@@ -22,12 +21,12 @@ const modifierValues = ['always', 'ignorePackages', 'never'] as const
 const modifierSchema = {
   type: 'string',
   enum: [...modifierValues],
-} satisfies JSONSchema4
+} satisfies JSONSchema.JSONSchema4
 
 const modifierByFileExtensionSchema = {
   type: 'object',
   patternProperties: { '.*': modifierSchema },
-} satisfies JSONSchema4
+} satisfies JSONSchema.JSONSchema4
 
 const properties = {
   type: 'object',
@@ -59,7 +58,7 @@ const properties = {
       type: 'boolean',
     },
   },
-} satisfies JSONSchema4
+} satisfies JSONSchema.JSONSchema4
 
 export type Modifier = (typeof modifierValues)[number]
 
@@ -370,7 +369,7 @@ export default createRule<Options, MessageId>({
               hash,
             })
             const fixOrSuggest = {
-              fix(fixer: RuleFixer) {
+              fix(fixer: TSESLint.RuleFixer) {
                 return fixer.replaceText(
                   source,
                   replaceImportPath(source.raw, fixedImportPath),
@@ -415,7 +414,7 @@ export default createRule<Options, MessageId>({
             hash,
           })
           const fixOrSuggest = {
-            fix(fixer: RuleFixer) {
+            fix(fixer: TSESLint.RuleFixer) {
               return fixer.replaceText(
                 source,
                 replaceImportPath(source.raw, fixedImportPath),
@@ -445,7 +444,7 @@ export default createRule<Options, MessageId>({
                     commonSuggestion,
                     isIndex && {
                       ...commonSuggestion,
-                      fix(fixer: RuleFixer) {
+                      fix(fixer: TSESLint.RuleFixer) {
                         return fixer.replaceText(
                           source,
                           replaceImportPath(

src/rules/no-unused-modules.ts

@@ -5,7 +5,7 @@
 
 import path from 'node:path'
 
-import { TSESTree } from '@typescript-eslint/utils'
+import { TSESTree } from '@typescript-eslint/types'
 import type { TSESLint } from '@typescript-eslint/utils'
 // eslint-disable-next-line import-x/default -- incorrect types , commonjs actually
 import eslintUnsupportedApi from 'eslint/use-at-your-own-risk'

src/utils/apply-default.ts

@@ -0,0 +1,42 @@
+import { deepMerge, isObjectNotArray } from './deep-merge.js'
+
+/**
+ * Pure function - doesn't mutate either parameter! Uses the default options and
+ * overrides with the options provided by the user
+ *
+ * @param defaultOptions The defaults
+ * @param userOptions The user opts
+ * @returns The options with defaults
+ */
+export function applyDefault<
+  User extends readonly unknown[],
+  Default extends User,
+>(
+  defaultOptions: Readonly<Default>,
+  userOptions: Readonly<User> | null,
+): Default {
+  // clone defaults
+  const options = structuredClone(defaultOptions) as AsMutable<Default>
+
+  if (userOptions == null) {
+    return options
+  }
+
+  // For avoiding the type error
+  //   `This expression is not callable. Type 'unknown' has no call signatures.ts(2349)`
+  for (const [i, opt] of (options as unknown[]).entries()) {
+    if (userOptions[i] !== undefined) {
+      const userOpt = userOptions[i]
+      options[i] =
+        isObjectNotArray(userOpt) && isObjectNotArray(opt)
+          ? deepMerge(opt, userOpt)
+          : userOpt
+    }
+  }
+
+  return options
+}
+
+type AsMutable<T extends readonly unknown[]> = {
+  -readonly [Key in keyof T]: T[Key]
+}

src/utils/create-rule.ts

@@ -1,12 +1,70 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
+import type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'
 
+import { applyDefault } from './apply-default.js'
 import { docsUrl } from './docs-url.js'
 
+/**
+ * Creates reusable function to create rules with default options and docs URLs.
+ *
+ * @param urlCreator Creates a documentation URL for a given rule name.
+ * @returns Function to create a rule with the docs URL format.
+ */
+export function RuleCreator<PluginDocs = unknown>(
+  urlCreator: (ruleName: string) => string,
+) {
+  // This function will get much easier to call when this is merged https://github.com/Microsoft/TypeScript/pull/26349
+  // TODO - when the above PR lands; add type checking for the context.report `data` property
+  return function createNamedRule<
+    Options extends readonly unknown[],
+    MessageIds extends string,
+  >({
+    meta,
+    name,
+    ...rule
+  }: Readonly<
+    ESLintUtils.RuleWithMetaAndName<Options, MessageIds, PluginDocs>
+  >): TSESLint.RuleModule<MessageIds, Options, PluginDocs> {
+    return createRule_<Options, MessageIds, PluginDocs>({
+      meta: {
+        ...meta,
+        docs: {
+          ...meta.docs,
+          url: urlCreator(name),
+        },
+      },
+      ...rule,
+    })
+  }
+}
+
+function createRule_<
+  Options extends readonly unknown[],
+  MessageIds extends string,
+  PluginDocs = unknown,
+>({
+  create,
+  defaultOptions,
+  meta,
+}: Readonly<
+  ESLintUtils.RuleWithMeta<Options, MessageIds, PluginDocs>
+>): TSESLint.RuleModule<MessageIds, Options, PluginDocs> {
+  return {
+    create(
+      context: Readonly<TSESLint.RuleContext<MessageIds, Options>>,
+    ): TSESLint.RuleListener {
+      const optionsWithDefault = applyDefault(defaultOptions, context.options)
+      return create(context, optionsWithDefault)
+    },
+    defaultOptions,
+    meta,
+  }
+}
+
 export interface ImportXPluginDocs {
   /** The category the rule falls under */
   category?: string
 
   recommended?: true
 }
 
-export const createRule = ESLintUtils.RuleCreator<ImportXPluginDocs>(docsUrl)
+export const createRule = RuleCreator<ImportXPluginDocs>(docsUrl)

src/utils/deep-merge.ts

@@ -0,0 +1,50 @@
+export type ObjectLike<T = unknown> = Record<string, T>
+
+/**
+ * Check if the variable contains an object strictly rejecting arrays
+ *
+ * @returns `true` if obj is an object
+ */
+export function isObjectNotArray(obj: unknown): obj is ObjectLike {
+  return typeof obj === 'object' && obj != null && !Array.isArray(obj)
+}
+
+/**
+ * Pure function - doesn't mutate either parameter! Merges two objects together
+ * deeply, overwriting the properties in first with the properties in second
+ *
+ * @param first The first object
+ * @param second The second object
+ * @returns A new object
+ */
+export function deepMerge(
+  first: ObjectLike = {},
+  second: ObjectLike = {},
+): Record<string, unknown> {
+  // get the unique set of keys across both objects
+  const keys = new Set([...Object.keys(first), ...Object.keys(second)])
+
+  return Object.fromEntries(
+    [...keys].map(key => {
+      const firstHasKey = key in first
+      const secondHasKey = key in second
+      const firstValue = first[key]
+      const secondValue = second[key]
+
+      let value
+      if (firstHasKey && secondHasKey) {
+        value =
+          // object type
+          isObjectNotArray(firstValue) && isObjectNotArray(secondValue)
+            ? deepMerge(firstValue, secondValue)
+            : // value type
+              secondValue
+      } else if (firstHasKey) {
+        value = firstValue
+      } else {
+        value = secondValue
+      }
+      return [key, value]
+    }),
+  )
+}

src/utils/get-value.ts

@@ -1,4 +1,4 @@
-import { TSESTree } from '@typescript-eslint/utils'
+import { TSESTree } from '@typescript-eslint/types'
 
 export const getValue = (
   node: TSESTree.Identifier | TSESTree.StringLiteral,