proposal: `@oxc/jest` package

DonIsaac commented 1 week ago

The Jest testing framework supports transforming code via transform plugins, such as babel-jest, ts-jest, and @swc/jest. It would be a large quality-of-life improvement to use oxc to transform files instead of any of the above packages. The transformer is progressing quite well, and making it usable in Jest could help with the adoption of oxc in general.

Unfortunately, Jest only ships with experimental support for ESM, so transpilation to CJS is a must-have for this to work properly. I took a crack at this about two weeks ago. Within about 2 hours I got about 80% of the way there, with this missing plugin being the only remaining major blocker.

Goals

Typescript/ESM transpilation into CJS
Should support transpilation to the most recent Node LTS version
Should work out-of-the-box, using fields from package.json, tsconfig.json, .babelrc, etc to configure transpilation correctly

Tasks

[ ] feat: Expose JS bindings for oxc_transform as an NPM package, similar to @oxc/parser
[ ] feat(transform): support @babel/plugin-transform-modules-commonjs plugin
[ ] feat: add @oxc/jest NPM package
[ ] docs: add setup and usage instructions for @oxc/jest to the website.

Considerations

The SWC project has @swc/jest in a separate git repo from their core package. Should we do the same thing?
Below are what I see as the major pitfalls of @swc/jest that prevent widespread adoption:
1. @swc/jest unconditionally hoists package imports, which breaks module mocking. This behavior is undocumented, and attempts to fix it by setting the appropriate config property fail as the package always overrides this user-provided value.
2. .swcrc does not appear to be respected; I've only ever gotten configuration to work by passing a config option explicitly.
3. @swc/jest does not export type definitions for its config, and the various settings are completely undocumented
4. External source maps do not work correctly, only inlined ones do. This messes up debugging and code coverage.

Boshen commented 1 week ago

My only concern is the maintenance cost, the core team will not have the time to maintain this :-(

I'm fine with shipping all the puzzles pieces have a separate repo that glues things together with its own release pipeline.

DonIsaac commented 1 week ago

My only concern is the maintenance cost, the core team will not have the time to maintain this :-(

I'm fine with shipping all the puzzles pieces have a separate repo that glues things together with its own release pipeline.

Once transformation is exposed as an npm package, creating a jest plugin package is relatively trivial. @swc/jest is one file and about 200 lines of code. I'd be happy to maintain it myself. Would you be willing to create a git repo for it within oxc-project and give me the permissions needed to maintain it, or should I create it myself?

Boshen commented 1 week ago

should I create it myself

Yes please, ping me if you don't have all the permissions.

DonIsaac commented 1 week ago

https://github.com/oxc-project/oxc-jest

oxc-project / oxc