refactor: rename project from Figmicon to IconSync; update documentation, CLI commands, and configuration files to reflect new branding and improve user guidance

MRBadri · MRBadri · commit 0d4ba6ab4a43 · 2025-09-11T15:27:56.000-07:00
diff --git a/README.md b/README.md
@@ -71,10 +71,10 @@ export default iconConfig({
 ```json
 {
   "scripts": {
-    "icon:fetch": "figmicon fetch",
-    "icon:cache:stats": "figmicon cache:stats",
-    "icon:cache:clear": "figmicon cache:clear",
-    "icon:generate": "figmicon generator"
+    "icon:fetch": "iconsync fetch",
+    "icon:cache:stats": "iconsync cache:stats",
+    "icon:cache:clear": "iconsync cache:clear",
+    "icon:generate": "iconsync generator"
   }
 }
 ```
@@ -141,10 +141,10 @@ The main configuration function that accepts the following options:
 
 ## CLI Commands
 
-- `figmicon fetch`: Fetch icons from Figma
-- `figmicon generator`: Generate React components from fetched icons
-- `figmicon cache:stats`: View cache statistics
-- `figmicon cache:clear`: Clear the cache
+- `iconsync fetch`: Fetch icons from Figma
+- `iconsync generator`: Generate React components from fetched icons
+- `iconsync cache:stats`: View cache statistics
+- `iconsync cache:clear`: Clear the cache
 
 ## License
 
diff --git a/apps/docs/README.md b/apps/docs/README.md
@@ -1,6 +1,6 @@
-# Figmicon Documentation
+# IconSync Documentation
 
-This is the documentation site for Figmicon, built with [Nextra](https://nextra.site/) and [Next.js](https://nextjs.org/).
+This is the documentation site for IconSync, built with [Nextra](https://nextra.site/) and [Next.js](https://nextjs.org/).
 
 ## Development
 
diff --git a/apps/docs/pages/getting-started/installation.mdx b/apps/docs/pages/getting-started/installation.mdx
@@ -45,10 +45,10 @@ Add these scripts to your `package.json`:
 ```json
 {
   "scripts": {
-    "icon:fetch": "figmicon fetch",
-    "icon:cache:stats": "figmicon cache:stats",
-    "icon:cache:clear": "figmicon cache:clear",
-    "icon:generate": "figmicon generator"
+    "icon:fetch": "iconsync fetch",
+    "icon:cache:stats": "iconsync cache:stats",
+    "icon:cache:clear": "iconsync cache:clear",
+    "icon:generate": "iconsync generator"
   }
 }
 ```
diff --git a/apps/docs/pages/getting-started/usage.mdx b/apps/docs/pages/getting-started/usage.mdx
@@ -11,7 +11,7 @@ Fetch icons from your Figma file:
 npm run icon:fetch
 
 # Or directly with the CLI
-npx figmicon fetch
+npx iconsync fetch
 ```
 
 This will download SVG icons from your configured Figma file and store them in a local cache.
@@ -25,7 +25,7 @@ Generate React components from the fetched icons:
 npm run icon:generate
 
 # Or directly with the CLI
-npx figmicon generator
+npx iconsync generator
 ```
 
 This will create React components in the output directory specified in your configuration.
diff --git a/apps/docs/pages/icons.mdx b/apps/docs/pages/icons.mdx
@@ -41,7 +41,7 @@ After setting up your configuration file, you can fetch icons from Figma:
 
 ```bash
 # Using the CLI directly
-npx figmicon fetch
+npx iconsync fetch
 
 # Or using a package.json script
 npm run icon:fetch
@@ -53,7 +53,7 @@ After fetching icons, you can generate React components:
 
 ```bash
 # Using the CLI directly
-npx figmicon generator
+npx iconsync generator
 
 # Or using a package.json script
 npm run icon:generate
diff --git a/apps/docs/theme.config.jsx b/apps/docs/theme.config.jsx
@@ -1,22 +1,22 @@
 export default {
-  logo: <span>Figmicon Docs</span>,
+  logo: <span>Iconsync Docs</span>,
   project: {
-    link: 'https://github.com/mrbadri/figmicon',
+    link: 'https://github.com/mrbadri/iconsync',
   },
-  docsRepositoryBase: 'https://github.com/mrbadri/figmicon/tree/main/apps/docs-nextra',
+  docsRepositoryBase: 'https://github.com/mrbadri/iconsync/tree/main/apps/docs-nextra',
   footer: {
-    text: `© ${new Date().getFullYear()} Figmicon. All rights reserved.`,
+    text: `© ${new Date().getFullYear()} IconSync. All rights reserved.`,
   },
   useNextSeoProps() {
     return {
-      titleTemplate: '%s – Figmicon'
+      titleTemplate: '%s – IconSync'
     }
   },
   head: (
     <>
       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-      <meta property="og:title" content="Figmicon" />
-      <meta property="og:description" content="Figmicon documentation" />
+      <meta property="og:title" content="IconSync" />
+      <meta property="og:description" content="IconSync documentation" />
     </>
   ),
 }
diff --git a/examples/next/package.json b/examples/next/package.json
@@ -8,10 +8,10 @@
     "dev": "next dev -p 3002",
     "lint": "next lint",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf .next",
-    "icon:fetch": "figmicon fetch",
-    "icon:cache:stats": "figmicon cache:stats",
-    "icon:cache:clear": "figmicon cache:clear",
-    "icon:generate": "figmicon generator"
+    "icon:fetch": "iconsync fetch",
+    "icon:cache:stats": "iconsync cache:stats",
+    "icon:cache:clear": "iconsync cache:clear",
+    "icon:generate": "iconsync generator"
   },
   "dependencies": {
     "@iconsync/core": "workspace:*",
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -71,10 +71,10 @@ export default iconConfig({
 ```json
 {
   "scripts": {
-    "icon:fetch": "figmicon fetch",
-    "icon:cache:stats": "figmicon cache:stats",
-    "icon:cache:clear": "figmicon cache:clear",
-    "icon:generate": "figmicon generator"
+    "icon:fetch": "iconsync fetch",
+    "icon:cache:stats": "iconsync cache:stats",
+    "icon:cache:clear": "iconsync cache:clear",
+    "icon:generate": "iconsync generator"
   }
 }
 ```
@@ -141,10 +141,10 @@ The main configuration function that accepts the following options:
 
 ## CLI Commands
 
-- `figmicon fetch`: Fetch icons from Figma
-- `figmicon generator`: Generate React components from fetched icons
-- `figmicon cache:stats`: View cache statistics
-- `figmicon cache:clear`: Clear the cache
+- `iconsync fetch`: Fetch icons from Figma
+- `iconsync generator`: Generate React components from fetched icons
+- `iconsync cache:stats`: View cache statistics
+- `iconsync cache:clear`: Clear the cache
 
 ## License
 
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -13,7 +13,7 @@
     "clean": "rm -rf .turbo node_modules dist"
   },
   "bin": {
-    "figmicon": "dist/cli.js"
+    "iconsync": "dist/cli.js"
   },
   "exports": {
     ".": {
diff --git a/packages/core/src/cli/generator.ts b/packages/core/src/cli/generator.ts
@@ -60,7 +60,7 @@ export const generatorCommand = async (options: GeneratorOptions = {}) => {
       );
       console.log(
         generatorLogger(),
-        "Run 'figmicon fetch' first to download SVG icons"
+        "Run 'iconsync fetch' first to download SVG icons"
       );
       return;
     }
diff --git a/packages/core/src/cli/index.ts b/packages/core/src/cli/index.ts
@@ -6,7 +6,7 @@ import { generatorCommand } from "@/cli/generator";
 const program = new Command();
 
 program
-  .name("figmicon")
+  .name("iconsync")
   .description(
     "Fetch icons from Figma and build React components or sprite.svg"
   )
diff --git a/packages/core/src/features/config/loader.ts b/packages/core/src/features/config/loader.ts
@@ -1,9 +1,9 @@
-import { FigmiconConfigSchema } from "./schema";
+import { IconSyncConfigSchema } from "./schema";
 import { ConfigReturn, ConfigOptions } from "./types";
 
 export type LoadOptions = {
   cwd?: string;
-  /** specific path for config, like "./figmicon.config.ts" */
+  /** specific path for config, like "./iconsync.config.ts" */
   configFile?: string;
 };
 
@@ -14,23 +14,23 @@ export async function loadConfig(
   const { cwd = process.cwd(), configFile } = opts;
 
   const { config, layers } = await loadConfig<ConfigOptions>({
-    name: "icon", // search: figmicon.config.*، .figmiconrc*، package.json
+    name: "icon", // search: iconsync.config.*، .iconsyncrc*، package.json
     cwd,
     configFile, // if you give specific path, it will load that directly
     dotenv: true, // load .env
   });
 
   if (!config) {
     throw new Error(
-      "No configuration found. Create a figmicon.config.(cjs|mjs|js|ts|mts|cts) " +
-        'or .figmiconrc.(json|yaml|yml|js|cjs|mjs) or add { "figmicon": { ... } } to package.json.'
+      "No configuration found. Create a iconsync.config.(cjs|mjs|js|ts|mts|cts) " +
+        'or .iconsyncrc.(json|yaml|yml|js|cjs|mjs) or add { "iconsync": { ... } } to package.json.'
     );
   }
 
   // validation + default values
-  const parsed = FigmiconConfigSchema.safeParse(config);
+  const parsed = IconSyncConfigSchema.safeParse(config);
   if (!parsed.success) {
-    throw new Error("Invalid figmicon config:\n" + parsed.error.toString());
+    throw new Error("Invalid iconsync config:\n" + parsed.error.toString());
   }
 
   // source of the config (for debugging)
diff --git a/packages/core/src/features/config/schema.ts b/packages/core/src/features/config/schema.ts
@@ -9,7 +9,7 @@ const generateFileNameFnSchema = z.custom<GenerateFileName>();
 const nodeTypesSchema = z.custom<NodeType>();
 const generatorSchema = z.custom<generatorConfig>();
 
-export const FigmiconConfigSchema = z.object({
+export const IconSyncConfigSchema = z.object({
   figma: z
     .union([
       z.object({
@@ -57,7 +57,7 @@ export const FigmiconConfigSchema = z.object({
   cache: z
     .object({
       enabled: z.boolean().default(true),
-      dir: z.string().default(".figmicon-cache").optional(),
+      dir: z.string().default(".iconsync-cache").optional(),
     })
     .optional(),
 
diff --git a/packages/core/src/features/config/types.ts b/packages/core/src/features/config/types.ts
@@ -1,9 +1,8 @@
 import z from "zod";
-import { FigmiconConfigSchema } from "./schema";
+import { IconSyncConfigSchema } from "./schema";
 import { Node } from "@figma/rest-api-spec";
 
 export type GenerateFileName = (node: Node, parentNode: Node) => string;
 
-
-export type ConfigOptions = z.input<typeof FigmiconConfigSchema>;
-export type ConfigReturn = z.infer<typeof FigmiconConfigSchema>;
+export type ConfigOptions = z.input<typeof IconSyncConfigSchema>;
+export type ConfigReturn = z.infer<typeof IconSyncConfigSchema>;

Original file line number	Diff line number	Diff line change
@@ -45,10 +45,10 @@ Add these scripts to your `package.json`:
`45`	`45`	```json
`46`	`46`	`{`
`47`	`47`	`"scripts": {`
`48`		`- "icon:fetch": "figmicon fetch",`
`49`		`- "icon:cache:stats": "figmicon cache:stats",`
`50`		`- "icon:cache:clear": "figmicon cache:clear",`
`51`		`- "icon:generate": "figmicon generator"`
	`48`	`+ "icon:fetch": "iconsync fetch",`
	`49`	`+ "icon:cache:stats": "iconsync cache:stats",`
	`50`	`+ "icon:cache:clear": "iconsync cache:clear",`
	`51`	`+ "icon:generate": "iconsync generator"`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`	```
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ export const generatorCommand = async (options: GeneratorOptions = {}) => {`
`60`	`60`	`);`
`61`	`61`	`console.log(`
`62`	`62`	`generatorLogger(),`
`63`		`- "Run 'figmicon fetch' first to download SVG icons"`
	`63`	`+ "Run 'iconsync fetch' first to download SVG icons"`
`64`	`64`	`);`
`65`	`65`	`return;`
`66`	`66`	`}`