Change readme

Author: romanlex

README.md

@@ -2,30 +2,53 @@
 
 This resolver adds [`TypeScript`][] or [`JavaScript`][] import support to [`eslint-plugin-import`][] with `tsconfig.json` or `jsconfig.json` aliases (`compilerOptions.paths`)
 
-This is fork of [`eslint-import-resolver-typescript`][] but much faster **(~30-40%)**
+### Performance
 
-For example we can use `strace` package for count of [fstat](`https://nodejs.org/api/fs.html#fsfstatsyncfd-options`) call when linting you codebase
+This is fork of [`eslint-import-resolver-typescript`][] but much faster and more efficient. You can save time on project linting by **(~30-40%)**.
 
-Example you codebase has multiple packages with 100k LOC and more
+![eslint-import-resolver-x vs eslint-import-resolver-typescript](image.png)
+
+We use `strace` package for count of [fstat](`https://nodejs.org/api/fs.html#fsfstatsyncfd-options`) call when linting codebase
+
+For example you codebase has multiple packages with 100 000 LOC ()
+
+```
+The following data depends directly on the number of imports in your case, but the comparison table is filled with data on the same code base
+```
+
+50641
+1
+78
+1
+3
+2
+32137
+81592
+1194240
+2
+11734655
+2
 
 | syscall    | eslint-import-resolver-x | eslint-import-resolver-typescript |
 | ---------- | ------------------------ | --------------------------------- |
-| access     | 85 027                   |
-| chdir      | 1                        |
-| execve     | 78                       |
-| faccessat2 | 1                        |
-| getcwd     | 3                        |
-| mkdir      | 2                        |
-| newfstatat | 31 761                   |
-| openat     | 86 287                   |
-| readlink   | 1 183 633                |
-| statfs     | 2                        |
-| statx      | 1 081 306                |
-| unlink     | 3                        |
-
-We are interested in how many accesses to the file system occurred during the linting process. We can pay attention to `statx` syscall.
-
-`eslint-import-resolver-x` makes calls `statx` 10x+ times less.
+| access     | 52 900                   | 50 641                            |
+| chdir      | 1                        | 1                                 |
+| execve     | 78                       | 78                                |
+| faccessat2 | 1                        | 1                                 |
+| getcwd     | 3                        | 3                                 |
+| mkdir      | 2                        | 2                                 |
+| newfstatat | 31 761                   | 32 137 🔺                         |
+| openat     | 74 965                   | 81 592 🔺                         |
+| readlink   | 1 183 525                | 1 194 240 🔺                      |
+| statfs     | 2                        | 2                                 |
+| statx      | 1 058 381                | 11 734 655 🔺                     |
+| unlink     | 3                        | 2                                 |
+
+We are interested in how many accesses to the file system occurred during the linting process.
+
+For example we can pay attention to `statx` syscall.
+
+`eslint-import-resolver-x` makes **10 MILLION fewer** `statx` calls
 
 **If you notice an increase in linting performance in your CI on large code bases, write your feedback [here](https://github.com/helljs/eslint-import-resolver-x/discussions/1)**
 
@@ -69,7 +92,7 @@ Add the following to your `.eslintrc` config:
       "@typescript-eslint/parser": [".ts", ".tsx"],
     },
     "import/resolver": {
-      "x": {
+      "@helljs/eslint-import-resolver-x": {
         "alwaysTryTypes": true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
 
         // Choose from one of the "project" configs below or omit to use <root>/tsconfig.json by default
@@ -107,7 +130,7 @@ Add the following to your `.eslintrc` config:
       "@babel/eslint-parser": [".js", ".mjs"],
     },
     "import/resolver": {
-      "x": {
+      "@helljs/eslint-import-resolver-x": {
         // use <root>/path/to/folder/jsconfig.json
         "project": "path/to/folder",
 
@@ -127,6 +150,22 @@ Add the following to your `.eslintrc` config:
 }
 ```
 
+You can use this resolver for mixed codebase with javascript & typescript:
+
+```jsonc
+"settings": {
+  "import/parsers": {
+    "@babel/eslint-parser": [".js", ".mjs"],
+    "@typescript-eslint/parser": [".ts", ".tsx"],
+  },
+  "import/resolver": {
+    "@helljs/eslint-import-resolver-x": {
+      "project": ["packages/*/tsconfig.json", "packages/*/jsconfig.json"],
+    },
+  },
+}
+```
+
 ## Options from [`enhanced-resolve`][]
 
 #### `conditionNames` - [See default](src/default.ts#1)