handle aliases and hidden

natemoo-re · Nov 24, 2024 · 3231e8b · 3231e8b
1 parent 83230c3
commit 3231e8b
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 933 deletions.
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -50,6 +50,6 @@
     "@types/node": "^22.7.0",
     "astro": "^5.0.0-beta.9",
     "typescript": "^5.6.2",
-    "vite": "^5.4.8"
+    "vite": "^6.0.0-beta.6"
   }
 }
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,4 +1,4 @@
-import type { AstroIntegration, ViteUserConfig } from "astro";
+import type { AstroIntegration } from "astro";
 import { createPlugin } from "./vite-plugin-astro-icon.js";
 
 export default function createIntegration(): AstroIntegration {
@@ -18,7 +18,7 @@ export default function createIntegration(): AstroIntegration {
                 experimental: config.experimental,
               }),
             ],
-          } as ViteUserConfig,
+          },
         });
       },
     },

diff --git a/packages/core/src/utils/icon.ts b/packages/core/src/utils/icon.ts
@@ -1,3 +1,4 @@
+import type { AstroIntegrationLogger } from "astro";
 import type { FileCache } from "./cache.js";
 import { AstroIconError } from "./error.js";
 import { dedupeFetch } from "./fetch.js";
@@ -7,11 +8,13 @@ interface IconCollection {
   info: Record<string, string>;
   lastModified: number;
   icons: Record<string, IconData>;
+  aliases: Record<string, IconData>;
 }
 interface IconData {
   body: string;
   width?: number;
   height?: number;
+  hidden?: boolean;
 }
 
 const ICONIFY_REPO = new URL(
@@ -55,12 +58,13 @@ async function fetchCollection(
 export async function getIconData(
   collection: string,
   name: string,
-  { cache }: { cache: FileCache }
+  { cache, logger }: { cache: FileCache; logger: AstroIntegrationLogger }
 ): Promise<IconData | undefined> {
   const collectionData = await fetchCollection(collection, { cache });
 
-  const { icons } = collectionData;
-  if (icons[name] === undefined) {
+  const { icons, aliases } = collectionData;
+  const icon = icons[name] ?? aliases[name];
+  if (icon === undefined) {
     const err = new AstroIconError(
       `Unable to locate the icon "${collection}:${name}"`
     );
@@ -70,5 +74,11 @@ export async function getIconData(
     throw err;
   }
 
-  return icons[name];
+  if (icon.hidden) {
+    logger.warn(
+      `Deprecation Warning: The icon "${collection}:${name}" has been removed from the icon set.`
+    );
+  }
+
+  return icon;
 }
diff --git a/packages/core/src/vite-plugin-astro-icon.ts b/packages/core/src/vite-plugin-astro-icon.ts
@@ -33,7 +33,7 @@ export function createPlugin({
         const [collection, icon] = name.split("/");
 
         try {
-          const data = await getIconData(collection, icon, { cache });
+          const data = await getIconData(collection, icon, { cache, logger });
           if (!data) return;
 
           const {