One command updates a project to the 3.5.0 names. It ships inside
@devigner-ui/icons, so there is nothing else to install, and it knows every
rename ever made, so it keeps working after 4.0.0 removes the old names.
From the root of your project, after upgrading to 3.5.0:
npx @devigner-ui/icons migrate --dry # list what would change, write nothing
npx @devigner-ui/icons migrate # change it
npx @devigner-ui/icons migrate src # only one directoryIt works for every package, Vue, Svelte and React Native included: it reads source files, not your framework.
Only spellings that can mean nothing but an icon:
| Kind | Before | After |
|---|---|---|
| Component names | IconBag2 |
IconBagStraps |
| Package subpaths | @devigner-ui/icons/Bag2 |
@devigner-ui/icons/BagStraps |
| React Native subpaths | @devigner-ui/icons-react-native/icons/Bag2 |
…/icons/BagStraps |
| SVG file paths | icons-svg/svg/outline/Bag2.svg |
icons-svg/svg/outline/BagStraps.svg |
| Sprite ids | href="/sprite/outline.svg#Bag2" |
…#BagStraps |
It skips node_modules and build output.
An old name inside a plain string could be anything: a lookup key, a translation id, a database value. Those are listed for you to check rather than changed:
updated src/App.tsx (3)
Updated 3 references in 1 file.
Check these by hand: they are strings, not imports.
src/icons.ts:12 "Bag2" may be an icon name, now "BagStraps"If the string is an icon name, change it. If you store icon names somewhere
the codemod cannot see, such as a database or a CMS, map them with
renames.json:
import renames from "@devigner-ui/icons/renames.json";
const current = (name: string) =>
renames.batches.reduce((n, b) => b.renames[n] ?? n, name);
current("Bag2"); // "BagStraps"Start your app in development and check the console: an old name the codemod missed still logs its warning, with the new name in it. No warnings means you are ready for 4.0. The Upcoming 4.0 page has a check you can run in CI.