fix: use rspack-resolver fork for pnp support (#243)

close #242

Author: JounQin

.changeset/silly-crabs-smile.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix: use [`rspack-resolver`](https://github.com/unrs/rspack-resolver) fork for pnp support

.env.yarn

@@ -1 +1,2 @@
 ESLINT_USE_FLAT_CONFIG=false
+NODE_OPTIONS="--no-warnings=ESLintRCWarning"

.eslintignore

@@ -6,6 +6,7 @@ test/fixtures/malformed.js
 test/fixtures/with-syntax-error
 test/fixtures/just-json-files/invalid.json
 test/fixtures/typescript-d-ts/
+test/fixtures/yarn-pnp/
 # we want to ignore "test/fixtures" here, but unfortunately doing so would
 # interfere with unit test and fail it for some reason.
 # test/fixtures

jest.config.ts

@@ -16,6 +16,6 @@ export default {
   snapshotSerializers: ['<rootDir>/test/jest.serializer.ts'],
   testMatch: ['<rootDir>/test/**/*.spec.ts'],
   transform: {
-    '^.+\\.(t|j)sx?$': ['@swc-node/jest', {} satisfies SwcOptions],
+    '^.+\\.tsx?$': ['@swc-node/jest', {} satisfies SwcOptions],
   },
 } satisfies Config

package.json

@@ -1,6 +1,7 @@
 {
   "name": "eslint-plugin-import-x",
   "version": "4.7.0",
+  "type": "commonjs",
   "description": "Import with sanity.",
   "repository": "git+https://github.com/un-ts/eslint-plugin-import-x",
   "author": "JounQin <admin@1stg.me> (https://www.1stG.me)",
@@ -37,7 +38,7 @@
     "lint:es": "eslint . --cache",
     "lint:tsc": "tsc -p tsconfig.base.json --noEmit",
     "prepare": "patch-package && simple-git-hooks && yarn-berry-deduplicate || exit 0",
-    "release": "changeset publish",
+    "release": "clean-pkg-json && changeset publish",
     "test": "jest",
     "test-compiled": "yarn build && cross-env TEST_COMPILED=1 jest",
     "update:eslint-docs": "eslint-doc-generator --rule-doc-title-format prefix-name --rule-doc-section-options false --rule-list-split meta.docs.category --ignore-config stage-0 --config-emoji recommended,☑️",
@@ -55,7 +56,7 @@
     "get-tsconfig": "^4.10.0",
     "is-glob": "^4.0.3",
     "minimatch": "^10.0.1",
-    "oxc-resolver": "^5.0.0",
+    "rspack-resolver": "^1.1.0",
     "semver": "^7.7.1",
     "stable-hash": "^0.0.5",
     "tslib": "^2.8.1"
@@ -98,12 +99,13 @@
     "@typescript-eslint/parser": "^8.26.1",
     "@typescript-eslint/rule-tester": "^8.26.1",
     "@unts/patch-package": "^8.1.1",
+    "clean-pkg-json": "^1.2.1",
     "cross-env": "^7.0.3",
     "escope": "^4.0.0",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-doc-generator": "^2.1.1",
-    "eslint-import-resolver-typescript": "^3.8.7",
+    "eslint-import-resolver-typescript": "^3.9.0",
     "eslint-import-resolver-webpack": "^0.13.10",
     "eslint-import-test-order-redirect": "link:./test/fixtures/order-redirect",
     "eslint-plugin-eslint-plugin": "^6.4.0",
@@ -127,6 +129,7 @@
     "redux": "^5.0.1",
     "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.11.1",
+    "tinyexec": "^0.3.2",
     "ts-node": "^10.9.2",
     "type-fest": "^4.37.0",
     "typescript": "^5.8.2",

src/node-resolver.ts

@@ -1,8 +1,8 @@
 import { isBuiltin } from 'node:module'
 import path from 'node:path'
 
-import { ResolverFactory } from 'oxc-resolver'
-import type { NapiResolveOptions as ResolveOptions } from 'oxc-resolver'
+import { ResolverFactory } from 'rspack-resolver'
+import type { NapiResolveOptions as ResolveOptions } from 'rspack-resolver'
 
 import type { NewResolver } from './types'
 
@@ -49,7 +49,10 @@ export function createNodeResolver({
     interfaceVersion: 3,
     name: 'eslint-plugin-import-x built-in node resolver',
     resolve(modulePath, sourceFile) {
-      if (isBuiltin(modulePath)) {
+      if (
+        isBuiltin(modulePath) ||
+        (process.versions.pnp && modulePath === 'pnpapi')
+      ) {
         return { found: true, path: null }
       }
 

src/types.ts

@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import type { MinimatchOptions } from 'minimatch'
-import type { NapiResolveOptions as ResolveOptions } from 'oxc-resolver'
+import type { NapiResolveOptions as ResolveOptions } from 'rspack-resolver'
 import type { KebabCase } from 'type-fest'
 
 import type { ImportType as ImportType_, PluginName } from './utils'

test/__snapshots__/fixtures.spec.ts.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`yarn pnp should just work 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;

test/fixtures.spec.ts

@@ -0,0 +1,14 @@
+import path from 'node:path'
+
+import { exec } from 'tinyexec'
+
+describe('yarn pnp', () => {
+  const yarnPnpDir = path.resolve('test/fixtures/yarn-pnp')
+  const execOptions = { nodeOptions: { cwd: yarnPnpDir } }
+
+  it('should just work', async () => {
+    await exec('yarn', ['install', '--immutable'], execOptions)
+    const result = await exec('yarn', ['lint'], execOptions)
+    expect(result).toMatchSnapshot()
+  }, 10_000)
+})

test/fixtures/yarn-pnp/.editorconfig

@@ -0,0 +1,8 @@
+root=true
+
+[*]
+charset=utf-8
+end_of_line=lf
+indent_size=2
+indent_style=space
+insert_final_newline=true