This is a resolver for eslint-plugin-import(-x) plugin, not an ESLint plugin itself, it adds [TypeScript][] support to [eslint-plugin-import][]. (Or maybe you want to try [eslint-plugin-import-x][] for faster speed)
This means you can:
- import/require files with extension .cts/.mts/.ts/.tsx/.d.cts/.d.mts/.d.ts - Use paths defined in tsconfig.json - Prefer resolving @types/* definitions over plain .js/.jsx - Multiple tsconfigs support, just like normal - imports/exports fields support in package.json
After version 2.0.0, .d.ts will take higher priority than normal .js/.jsx files on resolving node_modules packages in favor of @types/* definitions or its own definition.
If you're facing some problems with rules import/default or import/named from [eslint-plugin-import][], do not post any issue here, because they are working exactly as expected on our side. Take import-js/eslint-plugin-import#1525 as reference or post a new issue on [eslint-plugin-import][] instead.
Installation
$3
``sh
npm
npm i -D eslint-plugin-import-x eslint-import-resolver-typescript
pnpm
pnpm i -D eslint-plugin-import-x eslint-import-resolver-typescript
bun add -d eslint-plugin-import eslint-import-resolver-typescript `
Configuration
$3
If you are using
eslint-plugin-import-x@>=4.5.0, you can use import/require to reference eslint-import-resolver-typescript directly in your ESLint flat config:`js // eslint.config.js (CommonJS is also supported) import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
export default [ { settings: { 'import-x/resolver-next': [ createTypeScriptImportResolver({ alwaysTryTypes: true, // Always try to resolve types under
@types directory even if it doesn't contain any source code, like @types/unist
bun: true, // Resolve Bun modules (https://github.com/import-js/eslint-import-resolver-typescript#bun)
// Choose from one of the "project" configs below or omit to use /tsconfig.json or /jsconfig.json by default
// Use /path/to/folder/tsconfig.json or /path/to/folder/jsconfig.json project: 'path/to/folder',
// Multiple tsconfigs/jsconfigs (Useful for monorepos, but discouraged in favor of
references supported)
// Use a glob pattern project: 'packages/*/{ts,js}config.json',
// Use an array project: [ 'packages/module-a/tsconfig.json', 'packages/module-b/jsconfig.json', ],
// Use an array of glob patterns project: [ 'packages/*/tsconfig.json', 'other-packages/*/jsconfig.json', ], }), ], }, }, ]
`
But if you are using
eslint-plugin-import or the older version of eslint-plugin-import-x, you can't use require/import:`js // eslint.config.js (CommonJS is also supported) export default [ { settings: { 'import/resolver': { typescript: { alwaysTryTypes: true, // Always try to resolve types under @types directory even if it doesn't contain any source code, like @types/unist
bun: true, // Resolve Bun modules (https://github.com/import-js/eslint-import-resolver-typescript#bun)
// Choose from one of the "project" configs below or omit to use /tsconfig.json or /jsconfig.json by default
// Use /path/to/folder/tsconfig.json or /path/to/folder/jsconfig.json project: 'path/to/folder',
// Multiple tsconfigs/jsconfigs (Useful for monorepos, but discouraged in favor of
references supported)
// Use a glob pattern project: 'packages/*/{ts,js}config.json',
// Use an array project: [ 'packages/module-a/tsconfig.json', 'packages/module-b/jsconfig.json', ],
// Use an array of glob patterns project: [ 'packages/*/tsconfig.json', 'other-packages/*/jsconfig.json', ], }, }, }, }, ]
`
$3
Add the following to your
.eslintrc config:`jsonc { "plugins": ["import"], "rules": { // Turn on errors for missing imports "import/no-unresolved": "error", }, "settings": { "import/parsers": { "@typescript-eslint/parser": [".ts", ".tsx"], }, "import/resolver": { "typescript": { "alwaysTryTypes": true, // Always try to resolve types under @types directory even if it doesn't contain any source code, like @types/unist
"bun": true, // Resolve Bun modules (https://github.com/import-js/eslint-import-resolver-typescript#bun)
// Choose from one of the "project" configs below or omit to use /tsconfig.json or /jsconfig.json by default
// Use /path/to/folder/tsconfig.json or /path/to/folder/jsconfig.json "project": "path/to/folder",
// Multiple tsconfigs (Useful for monorepos, but discouraged in favor of
references supported)
// Use a glob pattern "project": "packages/*/{ts,js}config.json",
// Use an array "project": [ "packages/module-a/tsconfig.json", "packages/module-b/jsconfig.json", ],
// Use an array of glob patterns "project": [ "packages/*/tsconfig.json", "other-packages/*/jsconfig.json", ], }, }, }, }
`jsonc [ // .mts, .cts, .d.mts, .d.cts, .mjs, .cjs are not included because .cjs and .mjs must be used explicitly ".ts", ".tsx", ".d.ts", ".js", ".jsx", ".json", ".node", ] `
$3
Default:
`jsonc { ".js": [ ".ts", // .tsx can also be compiled as .js ".tsx", ".d.ts", ".js", ], ".ts": [".ts", ".d.ts", ".js"], ".jsx": [".tsx", ".d.ts", ".jsx"], ".tsx": [ ".tsx", ".d.ts", ".jsx", // .tsx can also be compiled as .js ".js", ], ".cjs": [".cts", ".d.cts", ".cjs"], ".cts": [".cts", ".d.cts", ".cjs"], ".mjs": [".mts", ".d.mts", ".mjs"], ".mts": [".mts", ".d.mts", ".mjs"], } `
defaultConditionNames, defaultExtensions, defaultExtensionAlias, and defaultMainFields by directly using require/import.
Contributing
- Make sure your change is covered by a test import. - Make sure that
yarn test passes without a failure. - Make sure that yarn lint passes without conflicts. - Make sure your code changes match our type-coverage settings: yarn type-coverage.
We have GitHub Actions, which will run the above commands on your PRs.
If either fails, we won't be able to merge your PR until it's fixed.
