eslint-import-resolver-typescript icon indicating copy to clipboard operation
eslint-import-resolver-typescript copied to clipboard

Docs: some enhancement declaring default values for options.

Open Mister-Hope opened this issue 8 months ago • 1 comments

It was not clear for any default value of options except these four: https://github.com/import-js/eslint-import-resolver-typescript?tab=readme-ov-file#options-from-unrs-resolver

It took me some time to reed through codes to find out that alwaysTryTypes is true by default.

It would be great if every default value of options are implicitly declared in README.

BTW, I can not make this PR myself as I am still confusing about the default behavior without project option after spending a few time with codes.

Mister-Hope avatar Apr 12 '25 17:04 Mister-Hope

Indeed, you can check and contribute!

https://github.com/import-js/eslint-import-resolver-typescript/blob/e36a0acebfd2846b58cc55c93db17e4d17b583cb/src/types.ts#L3-L14

alwaysTryTypes defaults to true, project defaults to root tsconfig.json or jsconfig.json if detected.

And bun already has its own doc section at https://github.com/import-js/eslint-import-resolver-typescript?tab=readme-ov-file#bun.

JounQin avatar Apr 12 '25 18:04 JounQin