|
1 | 1 | # eslint-import-resolver-typescript |
2 | 2 |
|
3 | | -[](https://github.com/alexgorbatchev/eslint-import-resolver-typescript/actions/workflows/ci.yml) |
4 | | -[](https://github.com/plantain-00/type-coverage) |
| 3 | +[](https://github.com/import-js/eslint-import-resolver-typescript/actions/workflows/ci.yml) |
| 4 | +[](https://github.com/plantain-00/type-coverage) |
5 | 5 | [](https://www.npmjs.com/package/eslint-import-resolver-typescript) |
6 | | -[](https://github.com/alexgorbatchev/eslint-import-resolver-typescript/releases) |
| 6 | +[](https://github.com/import-js/eslint-import-resolver-typescript/releases) |
7 | 7 |
|
8 | | -[](https://david-dm.org/alexgorbatchev/eslint-import-resolver-typescript?type=peer) |
9 | | -[](https://david-dm.org/alexgorbatchev/eslint-import-resolver-typescript) |
10 | | -[](https://david-dm.org/alexgorbatchev/eslint-import-resolver-typescript?type=dev) |
| 8 | +[](https://david-dm.org/import-js/eslint-import-resolver-typescript?type=peer) |
| 9 | +[](https://david-dm.org/import-js/eslint-import-resolver-typescript) |
| 10 | +[](https://david-dm.org/import-js/eslint-import-resolver-typescript?type=dev) |
11 | 11 |
|
12 | 12 | [](https://conventionalcommits.org) |
13 | 13 | [](https://standardjs.com) |
14 | 14 | [](https://github.com/prettier/prettier) |
15 | | -[](https://codechecks.io) |
| 15 | +[](https://github.com/atlassian/changesets) |
16 | 16 |
|
17 | 17 | This plugin adds TypeScript support to [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import). |
18 | 18 |
|
19 | 19 | This means you can: |
20 | 20 |
|
21 | | -- `import`/`require` files with extension `.ts`/`.tsx`! |
| 21 | +- `import`/`require` files with extension `.cts`/`.mts`/`.ts`/`.tsx`! |
22 | 22 | - Use [`paths`](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping) defined in `tsconfig.json`. |
23 | 23 | - Prefer resolve `@types/*` definitions over plain `.js`. |
24 | 24 | - Multiple tsconfigs support just like normal. |
| 25 | +- `exports` fields support in `package.json` |
25 | 26 |
|
26 | 27 | ## TOC <!-- omit in toc --> |
27 | 28 |
|
28 | 29 | - [Notice](#notice) |
29 | 30 | - [Installation](#installation) |
30 | 31 | - [Configuration](#configuration) |
31 | 32 | - [Contributing](#contributing) |
| 33 | +- [Changelog](#changelog) |
| 34 | +- [License](#license) |
32 | 35 |
|
33 | 36 | ## Notice |
34 | 37 |
|
35 | 38 | After version 2.0.0, `.d.ts` will take higher priority then normal `.js` files on resolving `node_modules` packages in favor of `@types/*` definitions. |
36 | 39 |
|
37 | | -If you're facing some problems on rules `import/default` or `import/named` from [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import), do not post any issue here, because they are just working exactly as [expected](https://github.com/alexgorbatchev/eslint-import-resolver-typescript/issues/31#issuecomment-539751607) on our sides, take <https://github.com/benmosher/eslint-plugin-import/issues/1525> as reference or post a new issue to [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) instead. |
| 40 | +If you're facing some problems on rules `import/default` or `import/named` from [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import), do not post any issue here, because they are just working exactly as [expected](https://github.com/import-js/eslint-import-resolver-typescript/issues/31#issuecomment-539751607) on our sides, take <https://github.com/benmosher/eslint-plugin-import/issues/1525> as reference or post a new issue to [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) instead. |
38 | 41 |
|
39 | 42 | ## Installation |
40 | 43 |
|
41 | 44 | ```sh |
42 | 45 | # npm |
43 | | -npm i -D eslint-plugin-import @typescript-eslint/parser eslint-import-resolver-typescript |
| 46 | +npm i -D eslint-plugin-import eslint-import-resolver-typescript |
| 47 | + |
| 48 | +# pnpm |
| 49 | +pnpm i -D eslint-plugin-import eslint-import-resolver-typescript |
44 | 50 |
|
45 | 51 | # yarn |
46 | | -yarn add -D eslint-plugin-import @typescript-eslint/parser eslint-import-resolver-typescript |
| 52 | +yarn add -D eslint-plugin-import eslint-import-resolver-typescript |
47 | 53 | ``` |
48 | 54 |
|
49 | 55 | ## Configuration |
@@ -99,6 +105,16 @@ Add the following to your `.eslintrc` config: |
99 | 105 | - Make sure that `yarn lint` passes without conflicts. |
100 | 106 | - Make sure your code changes match our [type-coverage](https://github.com/plantain-00/type-coverage) settings: `yarn type-coverage`. |
101 | 107 |
|
102 | | -We have [GitHub Actions](https://github.com/alexgorbatchev/eslint-import-resolver-typescript/actions) which will run the above commands on your PRs. |
| 108 | +We have [GitHub Actions](https://github.com/import-js/eslint-import-resolver-typescript/actions) which will run the above commands on your PRs. |
103 | 109 |
|
104 | 110 | If either fails, we won't be able to merge your PR until it's fixed. |
| 111 | + |
| 112 | +## Changelog |
| 113 | + |
| 114 | +Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md). |
| 115 | + |
| 116 | +## License |
| 117 | + |
| 118 | +[ISC][] |
| 119 | + |
| 120 | +[isc]: https://opensource.org/licenses/ISC |
0 commit comments