refactor: migrate deprecated doctrine to comment-parser (#314)

Author: JounQin

.changeset/kind-bananas-poke.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+refactor: migrate deprecated `doctrine` to `comment-parser`

.gitignore

@@ -26,3 +26,6 @@ lib
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
+
+# Local test
+test.local.*

CHANGELOG.md

@@ -317,7 +317,7 @@
   export type ResolvedResult = ResultNotFound | ResultFound
   ```
 
-  You will be able to import `NewResolver` from `eslint-plugin-import-x/types`.
+  You will be able to import `NewResolver` from `eslint-plugin-import-x`.
 
   The most notable change is that `eslint-plugin-import-x` no longer passes the third argument (`options`) to the `resolve` function.
 

eslint.config.js

@@ -149,6 +149,7 @@ export default config(
       '.*.js',
       '**/*.d.ts',
       '**/.eslintrc.js',
+      'test.local.*',
       'eslint.config.js',
       'jest.config.ts',
     ],

index.d.cts

@@ -1,3 +1,3 @@
-import eslintPluginImportX from './lib/index.js'
+import * as eslintPluginImportX from './lib/index.js'
 
 export = eslintPluginImportX

package.json

@@ -71,24 +71,22 @@
     "eslint": "^8.57.0 || ^9.0.0"
   },
   "dependencies": {
-    "@pkgr/core": "^0.2.4",
-    "@types/doctrine": "^0.0.9",
-    "@typescript-eslint/utils": "^8.30.1",
+    "@typescript-eslint/utils": "^8.31.0",
+    "comment-parser": "^1.4.1",
     "debug": "^4.4.0",
-    "doctrine": "^3.0.0",
     "eslint-import-resolver-node": "^0.3.9",
     "get-tsconfig": "^4.10.0",
     "is-glob": "^4.0.3",
     "minimatch": "^9.0.3 || ^10.0.1",
     "semver": "^7.7.1",
     "stable-hash": "^0.0.5",
     "tslib": "^2.8.1",
-    "unrs-resolver": "^1.6.0"
+    "unrs-resolver": "^1.7.0"
   },
   "devDependencies": {
     "@1stg/commitlint-config": "^5.0.6",
     "@1stg/lint-staged": "^4.0.9",
-    "@1stg/prettier-config": "^5.1.3",
+    "@1stg/prettier-config": "^5.1.4",
     "@1stg/remark-preset": "^3.1.1",
     "@1stg/simple-git-hooks": "^2.0.1",
     "@1stg/tsconfig": "^3.0.3",
@@ -106,10 +104,10 @@
     "@changesets/cli": "^2.29.2",
     "@commitlint/cli": "^19.8.0",
     "@eslint/import-test-order-redirect-scoped": "link:./test/fixtures/order-redirect-scoped",
-    "@eslint/js": "^9.25.0",
+    "@eslint/js": "^9.25.1",
     "@pkgr/rollup": "^6.0.3",
     "@swc-node/jest": "^1.8.13",
-    "@swc/core": "^1.11.21",
+    "@swc/core": "^1.11.22",
     "@swc/helpers": "^0.5.17",
     "@test-scope/some-module": "link:./test/fixtures/symlinked-module",
     "@total-typescript/ts-reset": "^0.6.1",
@@ -120,28 +118,28 @@
     "@types/jest": "^29.5.14",
     "@types/json-schema": "^7.0.15",
     "@types/klaw-sync": "^6.0.5",
-    "@types/node": "^22.14.1",
+    "@types/node": "^22.15.2",
     "@types/pnpapi": "^0.0.5",
-    "@typescript-eslint/eslint-plugin": "^8.30.1",
-    "@typescript-eslint/parser": "^8.30.1",
-    "@typescript-eslint/rule-tester": "^8.30.1",
+    "@typescript-eslint/eslint-plugin": "^8.31.0",
+    "@typescript-eslint/parser": "^8.31.0",
+    "@typescript-eslint/rule-tester": "^8.31.0",
     "@unts/patch-package": "^8.1.1",
-    "clean-pkg-json": "^1.2.1",
-    "eslint": "^9.25.0",
+    "clean-pkg-json": "^1.3.0",
+    "eslint": "^9.25.1",
     "eslint-config-prettier": "^10.1.2",
     "eslint-doc-generator": "^2.1.2",
-    "eslint-import-resolver-typescript": "^4.3.3",
+    "eslint-import-resolver-typescript": "^4.3.4",
     "eslint-import-resolver-webpack": "^0.13.10",
     "eslint-import-test-order-redirect": "link:./test/fixtures/order-redirect",
     "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-import-x": "link:.",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-json": "^4.0.1",
-    "eslint-plugin-mdx": "^3.4.0",
+    "eslint-plugin-mdx": "^3.4.1",
     "eslint-plugin-n": "^17.17.0",
     "eslint-plugin-prettier": "^5.2.6",
     "eslint-plugin-unicorn": "^58.0.0",
-    "eslint-plugin-yml": "^1.17.0",
+    "eslint-plugin-yml": "^1.18.0",
     "eslint8.56": "npm:eslint@~8.56.0",
     "eslint9": "npm:eslint@^9.24.0",
     "globals": "^16.0.0",
@@ -150,16 +148,16 @@
     "klaw-sync": "^7.0.0",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^7.0.2",
-    "path-serializer": "^0.3.4",
+    "path-serializer": "^0.4.0",
     "prettier": "^3.5.3",
     "redux": "^5.0.1",
     "rimraf": "^6.0.1",
-    "simple-git-hooks": "^2.12.1",
+    "simple-git-hooks": "^2.13.0",
     "tinyexec": "^1.0.1",
     "ts-node": "^10.9.2",
     "type-fest": "^4.40.0",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.1",
+    "typescript-eslint": "^8.31.0",
     "yarn-berry-deduplicate": "^6.1.3",
     "zod": "^3.24.3"
   },

src/index.ts

@@ -19,6 +19,7 @@ import warnings from './config/warnings.js'
 // rules
 import { meta } from './meta.js'
 import { createNodeResolver } from './node-resolver.js'
+import { cjsRequire } from './require.js'
 import consistentTypeSpecifierStyle from './rules/consistent-type-specifier-style.js'
 import default_ from './rules/default.js'
 import dynamicImportChunkname from './rules/dynamic-import-chunkname.js'
@@ -183,6 +184,7 @@ export default {
   configs,
   flatConfigs,
   rules,
+  cjsRequire,
   importXResolverCompat,
   createNodeResolver,
 }
@@ -192,6 +194,7 @@ export {
   configs,
   flatConfigs,
   rules,
+  cjsRequire,
   importXResolverCompat,
   createNodeResolver,
 }

src/meta.ts

@@ -1,14 +1,4 @@
-import { createRequire } from 'node:module'
-
-import { EVAL_FILENAMES } from '@pkgr/core'
-import type { CjsRequire } from '@pkgr/core'
-
-const cjsRequire: CjsRequire =
-  typeof require === 'undefined' ||
-  // workaround for #296
-  EVAL_FILENAMES.has(__filename)
-    ? createRequire(import.meta.url)
-    : /* istanbul ignore next */ require
+import { cjsRequire } from './require.js'
 
 export const { name, version } = cjsRequire<{ name: string; version: string }>(
   '../package.json',

src/require.ts

@@ -0,0 +1,9 @@
+import { createRequire } from 'node:module'
+
+import type { CjsRequire } from './types.js'
+
+const importMetaUrl = import.meta.url
+
+export const cjsRequire: CjsRequire = importMetaUrl
+  ? createRequire(importMetaUrl)
+  : /* istanbul ignore next */ require

src/rules/no-deprecated.ts

@@ -1,5 +1,5 @@
 import type { TSESTree } from '@typescript-eslint/utils'
-import type { Tag } from 'doctrine'
+import type { Spec } from 'comment-parser'
 
 import type { ModuleNamespace } from '../utils/index.js'
 import {
@@ -9,7 +9,7 @@ import {
   getValue,
 } from '../utils/index.js'
 
-function message(deprecation: Tag) {
+function message(deprecation: Spec) {
   if (deprecation.description) {
     return {
       messageId: 'deprecatedDesc',
@@ -25,7 +25,7 @@ function getDeprecation(metadata?: ModuleNamespace | null) {
     return
   }
 
-  return metadata.doc.tags.find(t => t.title === 'deprecated')
+  return metadata.doc.tags.find(t => t.tag === 'deprecated')
 }
 
 export default createRule({
@@ -45,7 +45,7 @@ export default createRule({
   },
   defaultOptions: [],
   create(context) {
-    const deprecated = new Map<string, Tag>()
+    const deprecated = new Map<string, Spec>()
     const namespaces = new Map<string, ExportMap | null>()
 
     return {
@@ -66,7 +66,7 @@ export default createRule({
           }
 
           const moduleDeprecation = imports.doc?.tags.find(
-            t => t.title === 'deprecated',
+            t => t.tag === 'deprecated',
           )
           if (moduleDeprecation) {
             context.report({