replace import specifier with module
#767
Merged
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
fixes amazon-ion#764 Prior to this commit ion-js declared a 'import' conditional export, which meant that node would load `./dist/es6/es6/Ion.js` when loaded via import. However, ion-js's es6 output is not compatible with node because it doesn't use the correct file extension or package.json `type` to indicate it is a esm file, and it's imports do not use file extensions. Node uses the `import` condition whenever a module is loaded with `import`. Long term it would be good to convert to esm or use `import` but that would require writing and emitting valid ESM, I had some issues with that that I described in the original issue. As a quick fix I replaced the `import` condition with a `module` condition, which bundlers like esbuild and webpack will prefer. esbuild uses es6 ``` echo "import 'ion-js'" | npx esbuild --bundle --analyze --outfile=/dev/null ../../../../../dev/null 175.2kb 100.0% ├ dist/es6/es6/IonParserTextRaw.js 41.5kb 23.7% ``` node can import and require ion-js ``` node -e "require('ion-js')" node -e "import('ion-js')" ``` https://nodejs.org/docs/latest-v16.x/api/packages.html#subpath-exports https://nodejs.org/docs/latest-v16.x/api/packages.html#conditional-exports https://nodejs.org/docs/latest-v16.x/api/esm.html#mandatory-file-extensions https://esbuild.github.io/api/#how-conditions-work
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.
fixes #764
Prior to this commit ion-js declared a 'import' conditional export, which meant that node would load
./dist/es6/es6/Ion.jswhen loaded via import.However, ion-js's es6 output is not compatible with node because it doesn't use the correct file extension or package.json
typeto indicate it is a esm file, and it's imports do not use file extensions. Node uses theimportcondition whenever a module is loaded withimport.Long term it would be good to convert to esm or use
importbut that would require writing and emitting valid ESM, I had some issues with that that I described in the original issue.As a quick fix I replaced the
importcondition with amodulecondition, which bundlers like esbuild and webpack will prefer.esbuild uses es6
node can import and require ion-js
https://nodejs.org/docs/latest-v16.x/api/packages.html#subpath-exports https://nodejs.org/docs/latest-v16.x/api/packages.html#conditional-exports https://nodejs.org/docs/latest-v16.x/api/esm.html#mandatory-file-extensions https://esbuild.github.io/api/#how-conditions-work
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.