-
-
Notifications
You must be signed in to change notification settings - Fork 694
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: drop commonjs support #1503
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep this LGTM.
Here's what I'd like to see as an eventuality:
./src/
houses a set of TypeScript files../mod.ts
imports all the TypeScript files - this is what Deno users will use../lib/
is like./src/
but with TS types compiled out../index.js
is like./mod.ts
but imports from./lib/
not./src/
- this is what Node users will use../chai.js
is an ESM bundle that's a single file that can be dropped into a<script>
tag in the browser.
@43081j please check your emails/notifications for an invite to the chai team where you can collect your maintainer badge 😄 |
i agree. one thing we should consider too is what to use for a test runner going forward. right now, karma works still because we create a bundle. however, if we try use the source JS (which is perfectly valid now in node), the bare specifiers in imports will cause it to fall over since we don't have an import map specified. so either we'd need some karma plugin which understands import maps, or we use a test runner like web-test-runner which transforms the imports for you behind the scenes (other similar test runners do the same). i've opened #1504 for that |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [chai](http://chaijs.com) ([source](https://github.com/chaijs/chai)) | [`4.4.1` -> `5.1.1`](https://renovatebot.com/diffs/npm/chai/4.4.1/5.1.1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.4.1/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.4.1/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>chaijs/chai (chai)</summary> ### [`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1) [Compare Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1) #### What's Changed - Set up ESLint for JSDoc comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1605 - build(deps-dev): bump ip from 1.1.8 to 1.1.9 by [@​dependabot](https://github.com/dependabot) in [chaijs/chai#1608 - Correct Mocha import instructions by [@​MattiSG](https://github.com/MattiSG) in [chaijs/chai#1611 - fix: support some virtual contexts in `toThrow` by [@​43081j](https://github.com/43081j) in [chaijs/chai#1609 #### New Contributors - [@​MattiSG](https://github.com/MattiSG) made their first contribution in [chaijs/chai#1611 **Full Changelog**: chaijs/chai@v5.1.0...v5.1.1 ### [`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0) #### What's Changed - Remove useless guards and add parentheses to constuctors by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1593 - Cleanup jsdoc comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1596 - Convert comments in "legal comments" format to jsdoc or normal comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1598 - Implement `iterable` assertion by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1592 - Assert interface fix by [@​developer-bandi](https://github.com/developer-bandi) in [chaijs/chai#1601 - Set support in same members by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1583 - Fix publish script by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1602 #### New Contributors - [@​developer-bandi](https://github.com/developer-bandi) made their first contribution in [chaijs/chai#1601 **Full Changelog**: chaijs/chai@v5.0.3...v5.1.0 ### [`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3) Fix bad v5.0.2 publish. **Full Changelog**: chaijs/chai@v5.0.2...v5.0.3 ### [`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2) #### What's Changed - build(deps): bump nanoid and mocha by [@​dependabot](https://github.com/dependabot) in [chaijs/chai#1558 - remove `bump-cli` by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1559 - Update developer dependencies by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1560 - fix: removes `??` for node compat (5.x) by [@​43081j](https://github.com/43081j) in [chaijs/chai#1576 - Update `loupe` to latest version by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1579 - Re-enable some webkit tests by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1580 - Remove a bunch of if statements in test/should.js by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1581 - Remove a bunch of unused files by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1582 - Fix 1564 by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1566 **Full Changelog**: chaijs/chai@v5.0.1...v5.0.2 ### [`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0) [Compare Source](https://github.com/chaijs/chai/compare/v4.4.1...v5.0.0) #### BREAKING CHANGES - Chai now only supports EcmaScript Modules (ESM). This means your tests will need to either have `import {...} from 'chai'` or `import('chai')`. `require('chai')` will cause failures in nodejs. If you're using ESM and seeing failures, it may be due to a bundler or transpiler which is incorrectly converting import statements into require calls. - Dropped support for Internet Explorer. - Dropped support for NodeJS < 18. - Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome 100, Edge 100. Support for browsers prior to these versions is "best effort" (bug reports on older browsers will be assessed individually and may be marked as wontfix). #### What's Changed - feat: use chaijs/loupe for inspection by [@​pcorpet](https://github.com/pcorpet) in [chaijs/chai#1401 - docs: fix URL in README by [@​Izzur](https://github.com/Izzur) in [chaijs/chai#1413 - Remove `get-func-name` dependency by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1416 - Convert Makefile script to npm scripts by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1424 - Clean up README badges by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1422 - fix: package.json - deprecation warning on exports field by [@​stevenjoezhang](https://github.com/stevenjoezhang) in [chaijs/chai#1400 - fix: deep-eql bump package to support symbols by [@​snewcomer](https://github.com/snewcomer) in [chaijs/chai#1458 - ES module conversion PoC by [@​43081j](https://github.com/43081j) in [chaijs/chai#1498 - chore: drop commonjs support by [@​43081j](https://github.com/43081j) in [chaijs/chai#1503 - Update pathval by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1527 - Update check-error by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1528 - update `deep-eql` to latest version by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1542 - Inline `type-detect` as a simple function by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1544 - Update loupe by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1545 - Typo 'Test an object' not 'Test and object' by [@​mavaddat](https://github.com/mavaddat) in [chaijs/chai#1460 - Update `assertion-error` to it's latest major version! by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1543 - Replacing Karma with Web Test Runner by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1546 #### New Contributors - [@​Izzur](https://github.com/Izzur) made their first contribution in [chaijs/chai#1413 - [@​stevenjoezhang](https://github.com/stevenjoezhang) made their first contribution in [chaijs/chai#1400 - [@​43081j](https://github.com/43081j) made their first contribution in [chaijs/chai#1498 **Full Changelog**: chaijs/chai@4.3.1...v5.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/runtime-env/import-meta-env). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuOSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@keithamus this is what we talked about before - removing the commonjs bundle.
i wasn't too sure about removing the
exports
so a second opinion would be great.my thinking was that we have no conditional exports anymore, just the one entrypoint (
chai.js
). someone could try import the source files and they'd probably work ok in node (since it'd handle cjs dependencies). but really everyone should use the main entrypoint.