feat: publish clay as both CJS and ESM #6110
Open
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
bryceosterhaus
force-pushed
the
LPD-61153
branch
from
fcc36cd to
93afc2a
Compare
bryceosterhaus
commented
Jul 17, 2025
| properties: ['data-testid'], | ||
| }, | ||
| ], | ||
| 'babel-plugin-fully-specified', |
There was a problem hiding this comment.
This is to update any import like from './language-helpers', which would resolve to ./language-helpers/index.js or ./language-helpers.js.
In ESM, you have to explicitly specify the file and extension, in CJS you don't have to.
Comment on lines
-7
to
-9
| "engines": { | ||
| "node": ">=0.12.0", | ||
| "npm": ">=3.0.0" |
There was a problem hiding this comment.
No need for this, the numbers are wildly off too
Comment on lines
+7
to
+11
| "main": "lib/cjs/index.js", | ||
| "module": "lib/esm/index.js", | ||
| "exports": { | ||
| "import": "./lib/esm/index.js", | ||
| "require": "./lib/cjs/index.js" |
There was a problem hiding this comment.
These are all standards with package.json now and allows for both ESM and CJS consumption
|
Just to note, these are the size differences(in bytes) |
|
Oh nice! That's great to see that esm is smaller. Also, I noticed that in the deploy proview logs it looks like there's still a problem with at least one export:
|
bryceosterhaus
force-pushed
the
LPD-61153
branch
3 times, most recently
from
f1d38a8 to
586dfaa
Compare
|
@ethib137 got it passing, has some issues with deeply imported items( |
|
New build, 3.141.2-alpha.0, https://app.unpkg.com/@clayui/[email protected] |
|
I tested this in DXP using our build reports, very promising for bundle size by moving to ESM. Note, these are not the gzipped size
|
|
I think this is worth releasing and testing a new official publish |
|
Those are pretty great numbers. Do you think there is any risk that including ESM could cause any issues in Portal? If so, I'd say we should wait to release this until after the cut of master for the Q3 release. |
|
@ethib137 yeah that sounds good to me. I will just keep this here until I am back from PTO and hopefully by then the release is official and cut |
bryceosterhaus
force-pushed
the
LPD-61153
branch
from
586dfaa to
0bcd417
Compare
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
Now that DXP is ESM, we would benefit from also publishing clay as ESM. I am gonna leave this as a draft and publish a prerelease to test in dxp
Check a prerelease here, https://app.unpkg.com/@clayui/[email protected]
I tested button in DXP and saw that with ESM we go from 430 lines of code to 274 for @clayui/button import. So that is promising