Optimize configuration for ESM exports (entry points for cjs / esm / typescript) #212
+73
−34
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
…d also typings) BREAKING CHANGE: Imports from esm subpaths must be replaced by the non-esm path (e.g. date-fns-tz/esm/format -> date-fns-tz/format) since the runtime will pick the correct entry point depending on type property (commonjs vs. esm).
|
@marnusw Happy new Year. Any chance you could merge this back any time soon? There is still the open task about the failing test. |
|
@marnusw Another interested party here. There's also an option to make this a non-breaking change ( to keep the "import from /esm if you want ESM code" philosophy). cc @michaelwittwer We can just add the explicit typings to the |
|
@michaelwittwer I am finally taking a look at this, and it looks good. I'll see what else can be included in v1, and then I'll release v2 with this breaking change. It might still be a day or so though. |
|
Released in |
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.
Optimise configuration for ESM exports (entry points for
cjs: require /esm: import and alsotypescript: types)BREAKING CHANGE: Imports from esm subpaths must be replaced by the non-esm path, since the runtime will pick the correct entry point depending on
package.json#typeproperty (commonjsvs.module).Before:
import {} from 'date-fns-tz/esm/format'-> after:import {} form 'date-fns-tz/format'This superseeds the existing PR (#211 ) with additional configuration for
typesfield.Motivation: I was not able to use
date-fns-tzwithesmandjestwithout this patch being applied.