Skip to content

Commit ab6cf7a

Browse files
committed
chore: update README
1 parent d681380 commit ab6cf7a

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# eslint-import-resolver-oxc
22

3-
[![npm version][npm-version-src]][npm-version-href][![License][license-src]][license-href]
3+
[![npm version][npm-version-src]][npm-version-href] [![License][license-src]][license-href]
44

5-
A resolver based on [oxc-resolver](https://github.com/oxc-project/oxc-resolver) for [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x)
5+
A resolver based on [`oxc-resolver`](https://github.com/oxc-project/oxc-resolver) for [`eslint-plugin-import-x`](https://github.com/un-ts/eslint-plugin-import-x)
66

7-
## Install
7+
## Installation
88

99
```bash
1010
npm install eslint-import-resolver-oxc --save-dev
@@ -30,11 +30,22 @@ This lib defaults to ESM, if you use CJS(not recommended), please wait for the s
3030

3131
see [oxc-resolver](https://github.com/oxc-project/oxc-resolver?tab=readme-ov-file#options)
3232

33+
## Motivation
34+
35+
Eslint is a bit slow in large projects. While I [track the performance of the rules](https://eslint.org/docs/latest/extend/custom-rules#profile-rule-performance), I found that `eslint-plugin-import-x` took a lot of time. I thought change a resolver might bring some improvements.
36+
37+
## Thanks
38+
39+
I can't finish the project without the help of [`oxc-resolver`](https://github.com/oxc-project/oxc-resolver).
40+
41+
Thanks [Boshen](https://github.com/Boshen) for his work on [`oxc-resolver`](https://github.com/oxc-project/oxc-resolver).
42+
3343
## License
3444

3545
[MIT](./LICENSE) License © 2024-PRESENT [Vida Xie](https://github.com/9romise)
3646

37-
[npm-version-src]: https://img.shields.io/npm/v/eslint-import-resolver-oxc
47+
[npm-version-src]: https://img.shields.io/npm/v/eslint-import-resolver-oxc?color=a6eae4
3848
[npm-version-href]: https://npmjs.com/package/eslint-import-resolver-oxc
39-
[license-src]: https://img.shields.io/npm/l/eslint-import-resolver-oxc
49+
[license-src]: https://img.shields.io/npm/l/eslint-import-resolver-oxc?color=a6eae4
4050
[license-href]: https://opensource.org/licenses/MIT
51+
[oxc-resolver-link]: [`oxc-resolver`](https://github.com/oxc-project/oxc-resolver)

0 commit comments

Comments
 (0)