LG-5764 add default export for new package format #3487
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
🦋 Changeset detectedLatest commit: 72eb163 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
nima-taheri-mongodb
changed the title
nima-taheri-mongodb
requested review from
adamrasheed,
Copilot and
tsck
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a top-level "default" export to the @lg-charts/legend package to resolve Jest module resolution issues in downstream projects (specifically MMS unit tests) that occurred after publishing non-minified bundles.
Changes:
- Added a fallback
"default"export pointing to the UMD bundle - Documented the change with a patch-level changeset
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| charts/legend/package.json | Added top-level "default" export mapping to UMD bundle for Jest compatibility |
| .changeset/shaky-regions-vanish.md | Added changeset documenting the patch fix |
charts/legend/package.json
Outdated
| ".": { | ||
| "types": "./dist/types/index.d.ts", | ||
| "types@<=5.0": "./dist/types/ts4.9/index.d.ts", | ||
| "default": "./dist/umd/index.js", |
There was a problem hiding this comment.
The default export is positioned before the 'import' and 'require' conditions in the exports map. According to Node.js module resolution rules, conditions are evaluated in order, and 'default' should be placed last as a fallback. Moving it after all other conditions ensures proper resolution across different environments.
Collaborator
Author
There was a problem hiding this comment.
Is it that bad? fields in a json object are supposed to be unordered.
it wouldn't hurt to move it to last however, done ✅
Contributor
|
Size Change: 0 B Total Size: 1.83 MB ℹ️ View Unchanged
|
Contributor
|
Coverage after merging LG-5764_improve_non_minified_package_description into main will be
Coverage Report for Changed Files
|
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.
🎫 Ticket
LG-5764
📝 Description
Context: After publishing the non-minified bundle (see #3325), I found that MMS unit tests began failing.
Problem: Jest does not properly resolve modules when "exports" uses nested mappings, leading to issues in downstream projects.
Solution: Introducing a top-level
"default": "./dist/umd/index.js"export supplies a fallback path that Jest can consistently resolve.🧪 Documentation and Testing