feat: support TypeScript config using importx
#18440
Conversation
github-actions
bot
added
cli
✅ Deploy Preview for docs-eslint canceled.
|
Co-authored-by: aryaemami59 <aryaemami59@users.noreply.github.com>
fasttime
added
the
needs design
|
Marking as a draft to avoid accidental merging, as there is an RFC being discussed. |
|
Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update. |
antfu
changed the title
importx
fasttime
added
accepted
|
Thanks for this PR, @antfu! In order to move forward with this pull request, we will need some unit tests to verify that TypeScript config files are being loaded as expected. My suggestion would be to start looking at these tests and add similar tests to check the behavior with packages that have config files with |
|
Oh, and can you have a look at the lint problems? You can run |
| "./hash": hashStub | ||
| }); | ||
| const newLintResultCache = new NewLintResultCache(cacheFileLocation, "metadata"); | ||
| const versionStub = sandbox.stub(process, "version").value(version); |
There was a problem hiding this comment.
This wasn't correctly restored, causing process.version to always be the mocked value for sub-sequence tests.
There was a problem hiding this comment.
Oh my gosh, thank you so much for figuring this one out, I was banging my head on the wall for quite some time trying to figure this one out.
|
PR is still blocking due to a |
| "eslint.config.cjs", | ||
| "eslint.config.ts", | ||
| "eslint.config.mts", | ||
| "eslint.config.cts" |
There was a problem hiding this comment.
What about eslint.config.tsx? It's a legitimate file extension that some frontend-area projects enforce all files adhere to for consistency.
There was a problem hiding this comment.
I am not sure about it personally. To me, TSX is a DSL specific to some frontend frameworks. And if we going to have .tsx, one could argue to have .jsx - which is not supported by Node.js without transpiling. I am not sure what's the use case of having TSX in the config file, and such a convension does not seem to widely supported by other tools.
| @@ -918,6 +918,112 @@ describe("ESLint", () => { | |||
| assert.strictEqual(results[0].messages[0].ruleId, "no-undef"); | |||
| }); | |||
| }); | |||
|
|
|||
| describe("TypeScript config files", () => { | |||
There was a problem hiding this comment.
[Testing] What do you think about including a test file that includes the not-very-friendly-to-transpilation TypeScript features?
const enumnamespace@experimentalDecorators
There was a problem hiding this comment.
Interesting, I personally would never use them because they are not transpilation friendly 😇 But good points - I will try to do a matrix tests in importx first to see how each solution works with them
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
importxinstead ofjitiSupport loading
eslint.config.tseslint.config.mtseslint.config.ctsfiles powered byimportx. The support is opt-in by users, where they need to installimportxexplicitly (we include it as optional peer deps instead ofdependencies)Based on my previous experiments with
eslint-ts-patch(which supports swapping different loaders likejititsxbundle-require, feel free to try them out).importxis a package trying to ease out the differences between them and the complexity of the pros/cons hidden from ESLint.The only downside is thattsxuses Node's API, which has only been available sincev20.8.0andv18.19.0. But considering this is an opt-in feature, it should be fine, and the ecosystem should catch up soon.importxease out that will auto fallback tojition unsupported node version.Is there anything you'd like reviewers to focus on?