ESM-compatible exports #162
Merged
+3
−3
Conversation
This file contains hidden or 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
Node.js handles ESM-CJS interoperability by using its [cjs-module-lexer](https://github.com/nodejs/cjs-module-lexer) to parse CJS files and turn their exports into named exports. cjs-module-lexer is deliberately limited in its capabilities. Switching export styles makes jsonfile's exports recognizable by cjs-module-lexer so that ESM code such aborts ``` import { readFileSync } from 'jsonfile' ``` can work as expected, without having to change jsonfile itself to ESM. Fixes #153
Contributor
Author
|
To demonstrate / test this locally, create a file, import { readFileSync } from './index.js';
console.log(readFileSync('./package.json'));Then run it with and without this change. |
Collaborator
|
Thanks @joshkel! Will try to release sometime next week (I don't like releasing popular libraries on weekends). |
Collaborator
|
Published as v6.2.0 🎉 |
Contributor
Author
|
Thanks, @RyanZim! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Node.js handles ESM-CJS interoperability by using its cjs-module-lexer to parse CJS files and turn their exports into named exports. cjs-module-lexer is deliberately limited in its capabilities. Switching export styles makes jsonfile's exports recognizable by cjs-module-lexer so that ESM code such aborts
can work as expected, without having to change jsonfile itself to ESM.
Fixes #153