docs: add more details about resolvers (#292)

Author: JounQin

.changeset/lucky-carpets-shine.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+refactor: remove unnecessary check for `pnpapi` because `unrs-resolver` already handles it

README.md

@@ -29,19 +29,24 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
 - [Configuration (legacy: `.eslintrc*`)](#configuration-legacy-eslintrc)
   - [TypeScript](#typescript)
 - [Configuration (new: `eslint.config.js`)](#configuration-new-eslintconfigjs)
+  - [JS example](#js-example)
+  - [Typescript example](#typescript-example)
 - [Resolvers](#resolvers)
+  - [`import-x/resolver-next`](#import-xresolver-next)
+  - [`import-x/resolver`](#import-xresolver)
 - [Settings](#settings)
   - [`import-x/extensions`](#import-xextensions)
   - [`import-x/ignore`](#import-xignore)
   - [`import-x/core-modules`](#import-xcore-modules)
   - [`import-x/external-module-folders`](#import-xexternal-module-folders)
   - [`import-x/parsers`](#import-xparsers)
-  - [`import-x/resolver`](#import-xresolver)
+  - [`import-x/resolver` and `import-x/resolver-next`](#import-xresolver-and-import-xresolver-next)
   - [`import-x/cache`](#import-xcache)
   - [`import-x/internal-regex`](#import-xinternal-regex)
 - [SublimeLinter-eslint](#sublimelinter-eslint)
-- [Sponsors](#sponsors)
-- [Backers](#backers)
+- [Sponsors and Backers](#sponsors-and-backers)
+  - [Sponsors](#sponsors)
+  - [Backers](#backers)
 - [Changelog](#changelog)
 - [License](#license)
 
@@ -193,23 +198,16 @@ settings:
 From [`v8.21.0`](https://github.com/eslint/eslint/releases/tag/v8.21.0), ESLint announced a new config system.
 In the new system, `.eslintrc*` is no longer used. `eslint.config.js` would be the default config file name.
 
-<details>
-  <summary>JS example</summary>
+### JS example
 
 ```js
 import js from '@eslint/js'
-import eslintPluginImportX from 'eslint-plugin-import-x'
+import * as pluginImportX from 'eslint-plugin-import-x'
 
-export default [
-  js.configs.recommended,
-  eslintPluginImportX.flatConfigs.recommended,
-]
+export default [js.configs.recommended, pluginImportX.flatConfigs.recommended]
 ```
 
-</details>
-
-<details>
-  <summary>Typescript example</summary>
+### Typescript example
 
 You have to install `eslint-import-resolver-typescript`:
 
@@ -219,13 +217,13 @@ npm install eslint-import-resolver-typescript --save-dev
 
 ```js
 import js from '@eslint/js'
-import eslintPluginImportX from 'eslint-plugin-import-x'
+import * as pluginImportX from 'eslint-plugin-import-x'
 import tsParser from '@typescript-eslint/parser'
 
 export default [
   js.configs.recommended,
-  eslintPluginImportX.flatConfigs.recommended,
-  eslintPluginImportX.flatConfigs.typescript,
+  pluginImportX.flatConfigs.recommended,
+  pluginImportX.flatConfigs.typescript,
   {
     files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
     ignores: ['eslint.config.js'],
@@ -243,10 +241,6 @@ export default [
 ]
 ```
 
-</details>
-
----
-
 > [!NOTE]
 > A complete list of available configuration can be found in [config/flat folders](src/config/flat)
 
@@ -273,6 +267,32 @@ You can reference resolvers in several ways (in order of precedence):
 
 - as a conventional `eslint-import-resolver` name, like `eslint-import-resolver-foo`:
 
+### `import-x/resolver-next`
+
+> [!warning]
+>
+> Only available in the new flat config system. If you are using the legacy config system, please use `import-x/resolver` instead.
+
+```js
+// eslint.config.js
+
+import { createTypeScriptResolver } from 'eslint-import-resolver-typescript'
+import { createNodeResolver } from 'eslint-plugin-import-x'
+
+export default [
+  {
+    settings: {
+      'import/resolver-next': [
+        createTypeScriptResolver(/* Your override options go here */),
+        createNodeResolver(/* Your override options go here */),
+      ],
+    },
+  },
+]
+```
+
+### `import-x/resolver`
+
 ```yaml
 # .eslintrc.yml
 settings:
@@ -501,7 +521,7 @@ depending on how far down the rabbit hole goes. Submit an issue if you find stra
 behavior beyond here, but steel your heart against the likely outcome of closing
 with `wontfix`.
 
-### `import-x/resolver`
+### `import-x/resolver` and `import-x/resolver-next`
 
 See [resolvers](#resolvers).
 
@@ -617,15 +637,17 @@ In Package Settings / SublimeLinter / User Settings:
 I believe this defaults to `3`, so you may not need to alter it depending on your
 project folder max depth.
 
-[![Sponsors](https://raw.githubusercontent.com/1stG/static/master/sponsors.svg)](https://github.com/sponsors/JounQin)
+## Sponsors and Backers
+
+[![Sponsors and Backers](https://raw.githubusercontent.com/1stG/static/master/sponsors.svg)](https://github.com/sponsors/JounQin)
 
-## Sponsors
+### Sponsors
 
 | 1stG                                                                                                                   | RxTS                                                                                                                   | UnTS                                                                                                                   |
 | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
 | [![1stG Open Collective sponsors](https://opencollective.com/1stG/organizations.svg)](https://opencollective.com/1stG) | [![RxTS Open Collective sponsors](https://opencollective.com/rxts/organizations.svg)](https://opencollective.com/rxts) | [![UnTS Open Collective sponsors](https://opencollective.com/unts/organizations.svg)](https://opencollective.com/unts) |
 
-## Backers
+### Backers
 
 | 1stG                                                                                                                | RxTS                                                                                                                | UnTS                                                                                                                |
 | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |

package.json

@@ -5,6 +5,7 @@
   "description": "Import with sanity.",
   "repository": "https://github.com/un-ts/eslint-plugin-import-x",
   "author": "JounQin <[email protected]> (https://www.1stG.me)",
+  "funding": "https://opencollective.com/eslint-plugin-import-x",
   "license": "MIT",
   "packageManager": "[email protected]",
   "engines": {
@@ -70,9 +71,9 @@
     "eslint": "^8.57.0 || ^9.0.0"
   },
   "dependencies": {
-    "@pkgr/core": "^0.2.1",
+    "@pkgr/core": "^0.2.2",
     "@types/doctrine": "^0.0.9",
-    "@typescript-eslint/utils": "^8.29.0",
+    "@typescript-eslint/utils": "^8.29.1",
     "debug": "^4.4.0",
     "doctrine": "^3.0.0",
     "eslint-import-resolver-node": "^0.3.9",
@@ -82,7 +83,7 @@
     "semver": "^7.7.1",
     "stable-hash": "^0.0.5",
     "tslib": "^2.8.1",
-    "unrs-resolver": "^1.4.1"
+    "unrs-resolver": "^1.5.0"
   },
   "devDependencies": {
     "@1stg/commitlint-config": "^5.0.4",
@@ -108,8 +109,8 @@
     "@eslint/js": "^9.24.0",
     "@pkgr/rollup": "^6.0.2",
     "@swc-node/jest": "^1.8.13",
-    "@swc/core": "^1.11.16",
-    "@swc/helpers": "^0.5.15",
+    "@swc/core": "^1.11.20",
+    "@swc/helpers": "^0.5.17",
     "@test-scope/some-module": "link:./test/fixtures/symlinked-module",
     "@total-typescript/ts-reset": "^0.6.1",
     "@types/debug": "^4.1.12",
@@ -119,17 +120,17 @@
     "@types/jest": "^29.5.14",
     "@types/json-schema": "^7.0.15",
     "@types/klaw-sync": "^6.0.5",
-    "@types/node": "^22.14.0",
+    "@types/node": "^22.14.1",
     "@types/pnpapi": "^0.0.5",
-    "@typescript-eslint/eslint-plugin": "^8.29.0",
-    "@typescript-eslint/parser": "^8.29.0",
-    "@typescript-eslint/rule-tester": "^8.29.0",
+    "@typescript-eslint/eslint-plugin": "^8.29.1",
+    "@typescript-eslint/parser": "^8.29.1",
+    "@typescript-eslint/rule-tester": "^8.29.1",
     "@unts/patch-package": "^8.1.1",
     "clean-pkg-json": "^1.2.1",
     "eslint": "^9.24.0",
-    "eslint-config-prettier": "^10.1.1",
+    "eslint-config-prettier": "^10.1.2",
     "eslint-doc-generator": "^2.1.2",
-    "eslint-import-resolver-typescript": "^4.3.1",
+    "eslint-import-resolver-typescript": "^4.3.2",
     "eslint-import-resolver-webpack": "^0.13.10",
     "eslint-import-test-order-redirect": "link:./test/fixtures/order-redirect",
     "eslint-plugin-eslint-plugin": "^6.4.0",
@@ -147,7 +148,7 @@
     "hermes-eslint": "^0.28.0",
     "jest": "^30.0.0-alpha.7",
     "klaw-sync": "^7.0.0",
-    "lint-staged": "^15.5.0",
+    "lint-staged": "^15.5.1",
     "npm-run-all2": "^7.0.2",
     "path-serializer": "^0.3.4",
     "prettier": "^3.5.3",
@@ -158,7 +159,7 @@
     "ts-node": "^10.9.2",
     "type-fest": "^4.39.1",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.29.0",
+    "typescript-eslint": "^8.29.1",
     "yarn-berry-deduplicate": "^6.1.1",
     "zod": "^3.24.2"
   },