upgrade-simple-icons
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.
When & Why to Use This Skill
The upgrade-simple-icons skill automates the complex process of updating the simple-icons library while ensuring zero regressions in your UI. It intelligently identifies icons removed in newer versions, extracts them from previous releases, and migrates them to a local custom icons repository, maintaining consistent icon availability across your entire application.
Use Cases
- 1. Seamless Dependency Maintenance: Automate the routine task of upgrading the simple-icons package to access the latest brand logos without the risk of breaking existing UI components.
- 2. Legacy Icon Preservation: Automatically detect and salvage icons that have been deprecated or removed from the official library, moving them to a local customIcons.ts file to ensure long-term stability.
- 3. Automated Mapping Reconciliation: Streamline the update of languageMapping.ts and other configuration files to match new library exports, reducing manual coding effort and potential human error.
- 4. CI/CD Workflow Integration: Use the skill to perform pre-commit verification and changeset generation, ensuring that every icon upgrade is fully tested and documented.
| 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.