-
Notifications
You must be signed in to change notification settings - Fork 10
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
Switch to ESM #338
Merged
Merged
Switch to ESM #338
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
❌ Deploy Preview for cucumber-react-components failed.
|
(Ignore Netlify issues - these were already present and will be fixed by #337.) |
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.
🤔 What's changed?
This package is now an ES module (ESM), meaning the context you consume it in must support ESM. In practise, that's module bundlers like Webpack and Vite which is all fine, so there is no need to have the transitional step of a "hybrid" package like we have done with cucumber-js and our another Node.js-oriented packages.
The significant changes are to config and setup code, and some dependencies which needed bumping to fix issues with types etc. On the other hand, the majority of the diff is adding
.js
suffixes to relative imports in TS files, which looks weird but is correct (I switched on a lint rule so we always do that in future).This is a big change and as such I've dropped this into
html-formatter
locally, built it and used it with cucumber-js and done some exploratory testing, and everything is working as expected.Also whilst this will be exactly the same behaviour for end users of formatters, this should be released as a major since anyone directly using the components may have some config/tooling changes to adopt.
⚡️ What's your motivation?
This will enable us to consume ESM-only dependencies where we have recently been blocked on upgrading or adopting them.
Fixes #7
🏷️ What kind of change is this?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.