Build esm and cjs versions of nimbus-icons to insure compatibility in non-esm environments (eg jest)
#91
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ByronDWall
requested review from
a team,
stephsprinkle,
jaikamat,
ddouglasz,
valoriecarli,
tylermorrisford and
misama-ct
and removed request for
a team
misama-ct
reviewed
May 5, 2025
packages/nimbus-icons/package.json
Outdated
| @@ -1,9 +1,22 @@ | |||
| { | |||
| "name": "@commercetools/nimbus-icons", | |||
| "version": "0.0.2", | |||
| "version": "0.0.3-rc1", | |||
| "main": "dist/index.js", | |||
| "module": "./dist/index.js", | |||
| "types": "./dist/index.d.ts", | |||
There was a problem hiding this comment.
Is anything speaking against adding "sideEffects": false to the package.json? I tried it on my blank-app branch cause the empty (!) app was huge. And it shoved off roughly a Megabyte:
Suggested change
| "types": "./dist/index.d.ts", | |
| "types": "./dist/index.d.ts", | |
| "sideEffects": false, |
ByronDWall
force-pushed
the
bw/build-cjs-icons
branch
from
0779e9e to
c884e18
Compare
…ignore in nimbus-icons to ignore everything in /material-icons but keep the folder so that its there for vercel hopefully
…ild:icons runs first in build script
misama-ct
requested changes
May 7, 2025
There was a problem hiding this comment.
As mentioned, I got this build-process working without the need to commit the 2k+ icons. Feel free to hijack the branch or incorporate the changes into this one.
packages/nimbus-icons/package.json
Outdated
| @@ -20,7 +33,7 @@ | |||
| }, | |||
| "scripts": { | |||
| "build-icons": "pnpm svgr --filename-case kebab --typescript --jsx-runtime automatic --out-dir src/material-icons node_modules/@material-design-icons/svg/outlined", | |||
| "build": "pnpm run build-icons && tsc", | |||
| "dev": "tsc" | |||
| "build": "pnpm run build-icons && tsc --project tsconfig.esm.json & tsc --project tsconfig.cjs.json", | |||
There was a problem hiding this comment.
I managed to get the build-process to work without committing the icons. The only "significant" change I did was running the two tsc tasks in sequence instead of in parallel/in the background:
Suggested change
| "build": "pnpm run build-icons && tsc --project tsconfig.esm.json & tsc --project tsconfig.cjs.json", | |
| "build": "pnpm run build-icons && tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json", |
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
 Failed |
Vulnerabilities | 1 0 0 0 |
View in Orca |
☢️ The following Vulnerabilities (CVEs) have been detected
| PACKAGE | FILE | CVE ID | INSTALLED VERSION | FIXED VERSION | ||
|---|---|---|---|---|---|---|
|
trim-newlines | ./pnpm-lock.yaml | CVE-2021-33623 | 1.0.0 | 3.0.1, 4.0.1 | View in code |
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.
This pull request includes updates to the
@commercetools/nimbus-iconspackage, focusing on restructuring its build process, modifying the package configuration, and adding new material icon components. The most significant changes include updates to thepackage.jsonfile for better module support, adjustments to the.gitignorefile, and the addition of multiple new material icon components.Build and configuration updates:
packages/nimbus-icons/package.jsonto include separate CommonJS (cjs) and ES Module (esm) builds, addedsideEffectsfor tree-shaking, and definedexportsfor better module resolution. Updated the version to0.0.4.package.jsonto use separate TypeScript configurations (tsconfig.esm.jsonandtsconfig.cjs.json) foresmandcjsbuilds..gitignoreto ignore all files insrc/material-icons/instead of the directory itself.New material icon components:
10k.tsx,10mp.tsx,11mp.tsx, and1k.tsx, each implementing a React component withforwardReffor better integration and accessibility. [1] [2] [3] [4] etc.)