chore: Updated icon validator package (#74)

ZebraDevs · Jan 16, 2025 · eab0d8c · eab0d8c
1 parent 1e6fb9f
commit eab0d8c
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 53 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "webfont": "^11.2.26",
-    "zeta-icon-name-checker": "^0.0.15"
+    "@zebra-fed/zeta-icon-validator": "^0.1.5"
   },
   "keywords": [
     "zeta",
@@ -81,4 +81,4 @@
     "url": "https://github.com/zebratechnologies/zeta-icons/issues"
   },
   "homepage": "https://github.com/zebratechnologies/zeta-icons#readme"
-}
+}
diff --git a/scripts/fetch-icons/generators/generateIconManifest.ts b/scripts/fetch-icons/generators/generateIconManifest.ts
@@ -1,4 +1,10 @@
-import { checkIconName, checkCategoryName, ErrorSeverity } from "zeta-icon-name-checker";
+import {
+  ErrorSeverity,
+  RenameErrorType,
+  validateCategoryName,
+  validateIcon,
+  ZetaIconNameError,
+} from "@zebra-fed/zeta-icon-validator";
 import { extractIconSets, getSearchTerms } from "../../utils/figmaUtils.js";
 import { IconManifest } from "../../../types.js";
 import { getIconFileName, toSnakeCase } from "../../utils/fileUtils.js";
@@ -32,7 +38,7 @@ export function generateIconManifest(
       console.log(`---------------- Current category: ${formattedCategoryName} ----------------`);
     }
 
-    const categoryNameError = checkCategoryName(formattedCategoryName);
+    const categoryNameError = validateCategoryName(formattedCategoryName);
 
     if (categoryNameError.severity == ErrorSeverity.high) {
       console.log(categoryNameError.message);
@@ -47,33 +53,45 @@ export function generateIconManifest(
           console.log(`Current Icon: ${name}`);
         }
 
-        const nameError = checkIconName(name, category.name, usedIconNames);
+        const validationErrors = validateIcon(icon, category.name, usedIconNames);
 
-        if (nameError.severity == ErrorSeverity.high) {
-          console.log(nameError.message);
-        } else {
-          if (nameError.severity == ErrorSeverity.medium) console.log(nameError.message);
-          if (nameError.newName != undefined) {
-            name = nameError.newName;
+        let highestSeverity = ErrorSeverity.none;
+
+        for (const error of validationErrors) {
+          if (error.severity == ErrorSeverity.high) {
+            console.log(`❌ ${name}`, error.message);
+            highestSeverity = ErrorSeverity.high;
+            break;
+          } else if (error instanceof ZetaIconNameError && error.type == RenameErrorType.iconRenamed && error.newName) {
+            console.log(`✅ ${name} Renamed to: ${error.newName}`);
+            name = error.newName;
+          } else if (error.severity == ErrorSeverity.medium) {
+            highestSeverity = ErrorSeverity.medium;
+            console.log(`${name}`, error.message);
           }
+        }
 
-          usedIconNames.push(name);
-          try {
-            const sharpId = icon.children.filter((n) => n.name.toLowerCase().includes("sharp"))[0].id;
-            const roundId = icon.children.filter((n) => n.name.toLowerCase().includes("round"))[0].id;
+        // If the highest severity is high, skip the icon
+        if (highestSeverity == ErrorSeverity.high) {
+          continue;
+        }
 
-            iconMap.set(icon.id, {
-              name: name,
-              searchTerms: getSearchTerms(icon.id, componentSets),
-              roundPath: `${iconOutputDir}/${formattedCategoryName}/${getIconFileName(name, "round")}.svg`,
-              sharpPath: `${iconOutputDir}/${formattedCategoryName}/${getIconFileName(name, "sharp")}.svg`,
-              category: formattedCategoryName,
-              roundId: roundId,
-              sharpId: sharpId,
-            });
-          } catch (e) {
-            throw new Error(`❌ Error finding styles for ${name}`);
-          }
+        usedIconNames.push(name);
+        try {
+          const sharpId = icon.children.filter((n) => n.name.toLowerCase().includes("sharp"))[0].id;
+          const roundId = icon.children.filter((n) => n.name.toLowerCase().includes("round"))[0].id;
+
+          iconMap.set(icon.id, {
+            name: name,
+            searchTerms: getSearchTerms(icon.id, componentSets),
+            roundPath: `${iconOutputDir}/${formattedCategoryName}/${getIconFileName(name, "round")}.svg`,
+            sharpPath: `${iconOutputDir}/${formattedCategoryName}/${getIconFileName(name, "sharp")}.svg`,
+            category: formattedCategoryName,
+            roundId: roundId,
+            sharpId: sharpId,
+          });
+        } catch (e) {
+          throw new Error(` Error finding styles for ${name}`);
         }
       }
     }

diff --git a/scripts/types/figmaTypes.ts b/scripts/types/figmaTypes.ts
@@ -1,3 +1,5 @@
+import { ComponentPropertyDefinitions } from "@zebra-fed/zeta-icon-validator/dist/src/figma-types";
+
 export type ComponentSets = Map<string, Component>;
 
 export interface DocumentResponse {
@@ -11,6 +13,7 @@ export interface FigmaNode {
   id: string;
   type: string;
   children: FigmaNode[];
+  componentPropertyDefinitions: ComponentPropertyDefinitions;
 }
 
 export interface Component {

diff --git a/test/data/categoryNodes.json b/test/data/categoryNodes.json
diff --git a/test/data/documentResponse.json b/test/data/documentResponse.json
diff --git a/test/data/iconsPage.json b/test/data/iconsPage.json