fix: bundlers not using the browser export
#299
Merged
+1
−1
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
|
@kobim thanks for looking into this! The JS imports/exports field is sadly very murky sometimes so I appreciate the contribution. Just to check, this will only affect builds targeting the browser, right? |
Bundlers use _conditions_ to decide which file to import. The logic, [explained by esbuild](https://esbuild.github.io/api/#how-conditions-work) emphasizes it would read the `exports` field *in-order* and try matching it to any of the conditions. When bundling for `browser`, eslint will end up adding `default` and `import` to the list of _conditions_. When iterating `eta`'s `exports` list, it ended up catching `import` instead of `browser`. With this change, it will first catch `browser`. How to test? --- Create a new file named `index.mjs` with the following content: ```javascript import { Eta } from 'eta'; const eta = new Eta(); ``` Install `esbuild` and `eta`: ```sh npm i --save-dev esbuild eta ``` Try to bundle the file: ```sh npx esbuild index.mjs --bundle --conditions=browser ``` With the current published version (3.4.1) it will emit an error: ``` ✘ [ERROR] Could not resolve "node:path" node_modules/eta/dist/eta.module.mjs:1:22: 1 │ import * as path from 'node:path'; ╵ ~~~~~~~~~~~ The package "node:path" wasn't found on the file system but is built into node. Are you trying to bundle for node? You can use "--platform=node" to do that, which will remove this error. ``` When trying with this branch's build, it passes successfully. resolves #283
|
that's correct - only builds with a |
|
@kobim great. I'll merge this now and release -- thanks again! |
|
Just released in 3.5.0 |
|
Thanks so much! Cleaned up my build logs tremendously :) |
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.
Bundlers use conditions to decide which file to import. The logic, explained by esbuild emphasizes it would read the
exportsfield in-order and try matching it to any of the conditions.When bundling for
browser, eslint will end up addingdefaultandimportto the list of conditions. When iteratingeta'sexportslist, it ended up catchingimportinstead ofbrowser. With this change, it will first catchbrowser.How to test?
Create a new file named
index.mjswith the following content:Install
esbuildandeta:Try to bundle the file:
With the current published version (3.4.1) it will emit an error:
When trying with this branch's build, it passes successfully.
resolves #283