| name | upgrade-simple-icons |
| description | Upgrade simple-icons to the latest version and preserve any removed icons by sourcing them from the previous version into common/icons/customIcons.ts and updating icon mappings. Use whenever bumping or upgrading simple-icons in this repo. |
Upgrade simple-icons
Workflow
- Record the current simple-icons version from
package.jsonandpnpm-lock.yaml. - Install the latest package:
pnpm add simple-icons@latest. - Reconcile icon imports:
- Review
common/icons/languageMapping.tsfor imports fromsimple-icons. - Run
pnpm lintorpnpm verifyto surface missing icon exports.
- Review
- If any previously used icon is missing after the upgrade:
- Download the previous simple-icons version (recorded in step 1) to a temporary location or install it briefly.
- Extract the icon data (
title,slug,hex,path). In simple-icons, this is available from thesi*export oricons/<slug>.jsonin the package. - Add a
custom<IconName>entry tocommon/icons/customIcons.tswith the extracted data. - Update
common/icons/languageMapping.tsto import and reference the custom icon. - Run
pnpm lint:fixto fix import ordering issues if any. - Remove any temporary dependency or scratch folder after the data is captured.
- Update relevant documentation if icon mappings or customization behavior changes.
- Run
pnpm verifybefore committing, and add a changeset for the upgrade.