ES module conversion PoC #1498
Merged
ES module conversion PoC #1498
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The changes made in chaijs#1334 incorrectly used an arrow function and as this isn't supported on IE 11 it causes a SyntaxError to be thrown when loading chai.
Bumps [codecov](https://github.com/codecov/codecov-node) from 3.1.0 to 3.7.1. - [Release notes](https://github.com/codecov/codecov-node/releases) - [Changelog](https://github.com/codecov/codecov-node/blob/master/CHANGELOG.md) - [Commits](codecov/codecov-node@v3.1.0...v3.7.1) --- updated-dependencies: - dependency-name: codecov dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* 4.x.x: Fix link to commit logs on GitHub As there is no `master` branch, the link returned a 404. * Update History.md Co-authored-by: Andre Meyering <info@andremeyering.de> Co-authored-by: Keith Cirkel <keithamus@users.noreply.github.com>
Bumps [socket.io-parser](https://github.com/socketio/socket.io-parser) from 4.0.4 to 4.0.5. - [Release notes](https://github.com/socketio/socket.io-parser/releases) - [Changelog](https://github.com/socketio/socket.io-parser/blob/main/CHANGELOG.md) - [Commits](socketio/socket.io-parser@4.0.4...4.0.5) --- updated-dependencies: - dependency-name: socket.io-parser dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
previously it was incorrectly labeled as `objDisplay(obj: object): void` in `@types/chai`.
This moves all of the sources to be ES modules rather than CommonJS. In order to produce the entrypoints, we use esbuild as a bundler (and as a transpiler in a way). Due to the fact that some dependencies are written in CommonJS, we actually use esbuild to create _two_ bundles: a CommonJS bundle, and an ES module bundle. Otherwise, someone importing the raw source would inevitably end up trying to import a CommonJS module somewhere down the tree, which would not work in browsers natively.
|
@keithamus did you ever get chance to take a peek at this? would be good to get some thoughts giving chai a real es module would be so useful |
|
Thanks for the reminder! I’ll give this a closer look tomorrow ❤️ |
This was referenced Sep 18, 2024
This was referenced Oct 25, 2024
This was referenced Nov 1, 2024
This was referenced Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm sure there's plenty of other things to take into account, tests to add (such that we test both CJS/ESM equally) and maybe some problems in this I missed - however, here's a PoC of converting the codebase to ESM.
As the commit says, it uses esbuild under the hood to create two bundled entrypoints:
chai.js- ESMchai.cjs- CommonJSTwo because there are still dependencies written in CommonJS, which invalidates the ESM-only tree (meaning you wouldn't be able to use it natively in a browser). Bundling them means we can leave it up to esbuild to figure the dependencies out and ship pure ESM.
If you ever want this or feel like picking it up, let me know, i can probably find a little time to pair on it some way.
The diff's a little funky because I first caught up from 4.x.x into my 5.x.x-based branch, while the current 5.x.x branch is actually out of date (and I fixed the conflicts there).
Also, it'd probably break the
usefunction externally (haven't tried it). has no use anymore internally but who knows what third party packages are depending on it. tried to imitate it with some mock exports object but haven't really tested it.i have tested it with a few chai plugins to see if
useworks, and all seems fine.