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.
The 'upgrade-simple-icons' skill is designed to help developers seamlessly upgrade the 'simple-icons' package in a project while ensuring no icons are lost in the process. It streamlines the process of upgrading the simple-icons package by reconciling missing icons and preserving custom icons that were previously used but removed in the latest version. This solution is particularly useful in projects where maintaining icon consistency across versions is critical, especially when the upgrade involves major updates or removals from the 'simple-icons' library.
The skill provides a step-by-step workflow for upgrading simple-icons, which includes identifying missing icons, extracting their data from previous versions, and adding them to a custom icons file. It ensures that icon imports remain intact by updating the necessary files and performing necessary linting. Additionally, the skill includes steps to verify the integrity of the upgrade and document any changes made to icon mappings. The skill is ideal for developers who work with simple-icons and need a robust solution to handle version upgrades without losing previously used icons or requiring major manual fixes.
To upgrade simple-icons, first record the current version from 'package.json' and 'pnpm-lock.yaml'. Then install the latest version using the command 'pnpm add simple-icons@latest'. Follow the workflow to reconcile missing icons by extracting them from the previous version and updating the necessary files.
If any icons are missing, you can temporarily install the previous version of simple-icons, extract the missing icon data (title, slug, hex, and path), and add it to 'common/icons/customIcons.ts'. Make sure to update the language mapping to include the custom icon and run 'pnpm lint:fix' to ensure proper import ordering.
This skill requires that you are using 'pnpm' for package management. It is also dependent on the 'simple-icons' library and works with any version upgrades where icons might have been removed or modified.
Yes, this skill can be used to upgrade any version of simple-icons. It specifically helps to recover missing icons if they are removed in the latest version. However, you must have access to the previous version to extract the necessary icon data.
Yes, it is recommended to update relevant documentation if any icon mappings or custom icon behaviors have changed as part of the upgrade process.
Quick Setup:
.claude/skills/Repository
wei/socialify