fix: types field should point to .d.cts (#569)

JounQin · web-flow · commit c10187771545 · 2025-04-22T12:17:27.000+08:00
diff --git a/.changeset/ninety-cougars-invent.md b/.changeset/ninety-cougars-invent.md
@@ -0,0 +1,6 @@
+---
+"eslint-mdx": patch
+"eslint-plugin-mdx": patch
+---
+
+fix: `types` field should point to `.d.cts`
diff --git a/.lintstagedrc.js b/.lintstagedrc.js
diff --git a/.nano-staged.js b/.nano-staged.js
@@ -0,0 +1 @@
+export { default } from '@1stg/nano-staged/tsc'
diff --git a/.renovaterc b/.renovaterc
@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "github>1stG/configs"
+  ]
+}
diff --git a/.yarn/releases/yarn-4.8.1.cjs b/.yarn/releases/yarn-4.8.1.cjs
diff --git a/.yarn/releases/yarn-4.9.1.cjs b/.yarn/releases/yarn-4.9.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -7,4 +7,4 @@ plugins:
     path: .yarn/plugins/plugin-prepare-lifecycle.cjs
     spec: 'https://github.com/un-es/yarn-plugin-prepare-lifecycle/releases/download/v0.0.1/index.js'
 
-yarnPath: .yarn/releases/yarn-4.8.1.cjs
+yarnPath: .yarn/releases/yarn-4.9.1.cjs
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
   "workspaces": [
     "packages/*"
   ],
-  "packageManager": "yarn@4.8.1",
+  "packageManager": "yarn@4.9.1",
   "scripts": {
     "build": "concurrently -r 'yarn:build:*'",
     "build:r": "r -f cjs",
@@ -28,25 +28,26 @@
     "version": "changeset version && yarn --no-immutable"
   },
   "devDependencies": {
-    "@1stg/common-config": "^11.1.2",
+    "@1stg/common-config": "^13.0.1",
     "@changesets/changelog-github": "^0.5.1",
-    "@changesets/cli": "^2.28.1",
+    "@changesets/cli": "^2.29.2",
     "@commitlint/cli": "^19.8.0",
-    "@oxc-node/core": "^0.0.22",
-    "@pkgr/rollup": "^6.0.1",
-    "@swc/core": "^1.11.16",
+    "@oxc-node/core": "^0.0.23",
+    "@pkgr/rollup": "^6.0.3",
+    "@swc/core": "^1.11.21",
     "@swc/jest": "^0.2.37",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.14.0",
-    "@types/react": "^19.1.0",
+    "@types/node": "^22.14.1",
+    "@types/react": "^19.1.2",
     "@types/unist": "^3.0.3",
     "@unts/patch-package": "^8.1.1",
     "concurrently": "^9.1.2",
-    "eslint": "^9.24.0",
+    "eslint": "^9.25.1",
+    "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-react": "^7.37.5",
     "globals": "^16.0.0",
     "jest": "^30.0.0-alpha.7",
-    "lint-staged": "^15.5.0",
+    "nano-staged": "^0.8.0",
     "path-serializer": "^0.3.4",
     "prettier": "^3.5.3",
     "react": "^19.1.0",
@@ -55,10 +56,9 @@
     "ts-node": "^10.9.2",
     "type-coverage": "^2.29.7",
     "typescript": "^5.8.3",
-    "yarn-berry-deduplicate": "^6.1.1"
+    "yarn-berry-deduplicate": "^6.1.3"
   },
   "resolutions": {
-    "es5-ext": "npm:@unes/es5-ext@^0.10.64-1",
     "eslint-mdx": "link:packages/eslint-mdx",
     "eslint-plugin-mdx": "link:packages/eslint-plugin-mdx",
     "prettier": "^3.5.3",
@@ -104,11 +104,6 @@
       "@1stg/preset"
     ]
   },
-  "renovate": {
-    "extends": [
-      "github>1stG/configs"
-    ]
-  },
   "typeCoverage": {
     "atLeast": 100,
     "cache": true,
diff --git a/packages/eslint-mdx/package.json b/packages/eslint-mdx/package.json
@@ -15,6 +15,7 @@
     "node": ">=18.0.0"
   },
   "main": "lib/index.cjs",
+  "types": "index.d.cts",
   "module": "lib/index.js",
   "exports": {
     ".": {
@@ -33,7 +34,6 @@
     },
     "./package.json": "./package.json"
   },
-  "types": "lib/index.d.ts",
   "files": [
     "index.d.cts",
     "lib"
@@ -62,7 +62,7 @@
     "remark-mdx": "^3.1.0",
     "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
-    "synckit": "^0.11.2",
+    "synckit": "^0.11.4",
     "tslib": "^2.8.1",
     "unified": "^11.0.5",
     "unified-engine": "^11.2.2",
diff --git a/packages/eslint-mdx/shim.d.ts b/packages/eslint-mdx/shim.d.ts
@@ -4,42 +4,26 @@ declare module 'espree/lib/token-translator' {
   export default TokenTranslator
 
   export interface Location {
-    /**
-     * The start position.
-     */
+    /** The start position. */
     start: acorn.Position
-    /**
-     * The end position.
-     */
+    /** The end position. */
     end: acorn.Position
   }
 
   export type Range = [number, number]
 
   export interface EsprimaToken {
-    /**
-     * The type of this token.
-     */
+    /** The type of this token. */
     type: string
-    /**
-     * The string content of the token.
-     */
+    /** The string content of the token. */
     value: string
-    /**
-     * Location in source text.
-     */
+    /** Location in source text. */
     loc: Location | undefined
-    /**
-     * start column.
-     */
+    /** Start column. */
     start: number | undefined
-    /**
-     * end column.
-     */
+    /** End column. */
     end: number | undefined
-    /**
-     * [start, end] range
-     */
+    /** [start, end] range */
     range: Range | undefined
   }
 
diff --git a/packages/eslint-mdx/src/helpers.ts b/packages/eslint-mdx/src/helpers.ts
@@ -17,9 +17,9 @@ export const arrayify = <T, R = T extends Array<infer S> ? S : T>(
   }, [])
 
 /**
- * Given a filepath, get the nearest path that is a regular file.
- * The filepath provided by eslint may be a virtual filepath rather than a file
- * on disk. This attempts to transform a virtual path into an on-disk path
+ * Given a filepath, get the nearest path that is a regular file. The filepath
+ * provided by eslint may be a virtual filepath rather than a file on disk. This
+ * attempts to transform a virtual path into an on-disk path
  */
 export const getPhysicalFilename = (
   filename: string,
@@ -122,5 +122,6 @@ export const nextCharOffsetFactory = (text: string) => {
 }
 
 /* istanbul ignore next */
-export const cjsRequire: CjsRequire =
-  typeof require === 'undefined' ? createRequire(import.meta.url) : require
+export const cjsRequire: CjsRequire = import.meta.url
+  ? createRequire(import.meta.url)
+  : require
diff --git a/packages/eslint-mdx/src/tokens.ts b/packages/eslint-mdx/src/tokens.ts
@@ -132,7 +132,8 @@ export const restoreTokens = (
       }
 
       /**
-       * not available yet
+       * Not available yet
+       *
        * @see https://github.com/mdx-js/mdx/issues/2034
        */
 
diff --git a/packages/eslint-mdx/src/types.ts b/packages/eslint-mdx/src/types.ts
@@ -74,7 +74,7 @@ export interface PackageJson {
 }
 
 /**
- * temporary workaround for missing `Ignore` from `unified-engine`
+ * Temporary workaround for missing `Ignore` from `unified-engine`
  *
  * See also {@link https://github.com/unifiedjs/unified-engine/pull/79}
  *
@@ -91,16 +91,10 @@ export type IgnoreClass = typeof Ignore
 export type Callback = (error?: Error, result?: boolean) => void
 
 export interface Options {
-  /**
-   *   Base.
-   */
+  /** Base. */
   cwd: string
-  /**
-   *   Whether to detect ignore files.
-   */
+  /** Whether to detect ignore files. */
   detectIgnore: boolean | undefined
-  /**
-   *   Basename of ignore files.
-   */
+  /** Basename of ignore files. */
   ignoreName?: string
 }
diff --git a/packages/eslint-mdx/src/worker.ts b/packages/eslint-mdx/src/worker.ts
@@ -231,9 +231,9 @@ runAsWorker(
     sharedTokens.length = 0
 
     /**
-     * unified plugins are using ESM version of acorn,
-     * so we have to use the same version as well,
-     * otherwise the TokenType will be different class
+     * Unified plugins are using ESM version of acorn, so we have to use the
+     * same version as well, otherwise the TokenType will be different class
+     *
      * @see also https://github.com/acornjs/acorn-jsx/issues/133
      */
     if (!acornParser) {
@@ -754,7 +754,8 @@ runAsWorker(
         }
 
         /**
-         * Copied from @see https://github.com/eslint/espree/blob/1584ddb00f0b4e3ada764ac86ae20e1480003de3/lib/espree.js#L227-L241
+         * Copied from @see
+         * https://github.com/eslint/espree/blob/1584ddb00f0b4e3ada764ac86ae20e1480003de3/lib/espree.js#L227-L241
          */
         const templateElement = node
 
diff --git a/packages/eslint-plugin-mdx/package.json b/packages/eslint-plugin-mdx/package.json
@@ -15,6 +15,7 @@
     "node": ">=18.0.0"
   },
   "main": "lib/index.cjs",
+  "types": "index.d.cts",
   "module": "lib/index.js",
   "exports": {
     ".": {
@@ -33,7 +34,6 @@
     },
     "./package.json": "./package.json"
   },
-  "types": "lib/index.d.ts",
   "files": [
     "index.d.cts",
     "lib"
@@ -56,7 +56,7 @@
     "remark-mdx": "^3.1.0",
     "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
-    "synckit": "^0.11.2",
+    "synckit": "^0.11.4",
     "tslib": "^2.8.1",
     "unified": "^11.0.5",
     "vfile": "^6.0.3"
diff --git a/packages/eslint-plugin-mdx/src/configs/recommended.ts b/packages/eslint-plugin-mdx/src/configs/recommended.ts
@@ -29,9 +29,7 @@ const addPrettierRules = () => {
     /* istanbul ignore next */
     const version = meta?.version || ''
 
-    /**
-     * @see https://github.com/prettier/eslint-plugin-prettier/releases/tag/v5.1.2
-     */
+    /** @see https://github.com/prettier/eslint-plugin-prettier/releases/tag/v5.1.2 */
     const [major, minor, patch] = version.split('.')
 
     /* istanbul ignore if -- We can't cover all versions in one test */
diff --git a/packages/eslint-plugin-mdx/src/helpers.ts b/packages/eslint-plugin-mdx/src/helpers.ts
@@ -23,5 +23,6 @@ export const getGlobals = <
   )
 
 /* istanbul ignore next */
-export const cjsRequire: CjsRequire =
-  typeof require === 'undefined' ? createRequire(import.meta.url) : require
+export const cjsRequire: CjsRequire = import.meta.url
+  ? createRequire(import.meta.url)
+  : require
diff --git a/packages/eslint-plugin-mdx/src/processors/markdown.ts b/packages/eslint-plugin-mdx/src/processors/markdown.ts
diff --git a/packages/eslint-plugin-mdx/src/processors/options.ts b/packages/eslint-plugin-mdx/src/processors/options.ts
diff --git a/patches/@1stg+eslint-config+9.0.5.patch b/patches/@1stg+eslint-config+9.0.5.patch
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { default } from '@1stg/nano-staged/tsc'`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "extends": [
 +    "github>1stG/configs"
 +  ]
 +}