chore: icon alias improvements (#2861)

Co-authored-by: Eric Fennis <[email protected]>

Author: jguddas

docs/scripts/writeIconRelatedIcons.mjs

@@ -21,10 +21,7 @@ const MAX_RELATED_ICONS = 4 * 17; // grid of 4x17 icons, = 68 icons
 const arrayMatches = (a, b) => a.filter((item) => b.includes(item)).length;
 
 const nameParts = (icon) =>
-  [
-    icon.name,
-    ...(icon.aliases?.map((alias) => (typeof alias === 'string' ? alias : alias.name)) ?? []),
-  ]
+  [icon.name, ...(icon.aliases?.map((alias) => alias.name) ?? [])]
     .join('-')
     .split('-')
     .filter((word) => word.length > 2);

docs/scripts/writeReleaseMetadata.mjs

@@ -159,16 +159,14 @@ try {
       const aliases = iconMetaData.aliases ?? [];
 
       if (aliases.length) {
-        aliases
-          .map((alias) => (typeof alias === 'string' ? alias : alias.name))
-          .forEach((alias) => {
-            if (!(alias in newReleaseMetaData)) {
-              return;
-            }
-
-            contents.createdRelease =
-              newReleaseMetaData[alias].createdRelease ?? defaultReleaseMetaData.createdRelease;
-          });
+        aliases.forEach((alias) => {
+          if (!(alias.name in newReleaseMetaData)) {
+            return;
+          }
+
+          contents.createdRelease =
+            newReleaseMetaData[alias.name].createdRelease ?? defaultReleaseMetaData.createdRelease;
+        });
       }
 
       const output = JSON.stringify(contents, null, 2);

docs/scripts/writeVercelOutput.mjs

@@ -11,9 +11,7 @@ const iconMetaData = await getIconMetaData(path.resolve(scriptDir, '../../icons'
 const iconAliasesRedirectRoutes = Object.entries(iconMetaData)
   .filter(([, { aliases }]) => aliases?.length)
   .map(([iconName, { aliases }]) => {
-    aliases = aliases.map((alias) => (typeof alias === 'object' ? alias.name : alias));
-
-    const aliasRouteMatches = aliases.join('|');
+    const aliasRouteMatches = aliases.map((alias) => alias.name).join('|');
 
     return {
       src: `/icons/${aliasRouteMatches}`,

icon.schema.json

@@ -21,32 +21,29 @@
     "aliases": {
       "type": "array",
       "items": {
-        "oneOf": [
-          {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["name"],
+        "properties": {
+          "name": {
             "type": "string"
           },
-          {
-            "type": "object",
-            "properties": {
-              "name": {
-                "type": "string"
-              },
-              "deprecated": {
-                "const": true
-              },
-              "deprecationReason": {
-                "$ref": "#/$defs/aliasDeprecationReasons"
-              },
-              "toBeRemovedInVersion": {
-                "$ref": "#/$defs/versionNumber",
-                "description": "The version this icon will be removed in."
-              }
-            },
-            "dependentRequired": {
-              "deprecated": ["deprecationReason", "toBeRemovedInVersion"]
-            }
+          "deprecated": {
+            "const": true
+          },
+          "deprecationReason": {
+            "$ref": "#/$defs/aliasDeprecationReasons"
+          },
+          "toBeRemovedInVersion": {
+            "$ref": "#/$defs/versionNumber",
+            "description": "The version this icon will be removed in."
           }
-        ]
+        },
+        "dependentRequired": {
+          "deprecated": ["deprecationReason", "toBeRemovedInVersion"],
+          "deprecationReason": ["deprecated"],
+          "toBeRemovedInVersion": ["deprecated"]
+        }
       },
       "uniqueItems": true
     },
@@ -130,7 +127,9 @@
     }
   },
   "dependentRequired": {
-    "deprecated": ["deprecationReason", "toBeRemovedInVersion"]
+    "deprecated": ["deprecationReason", "toBeRemovedInVersion"],
+    "deprecationReason": ["deprecated"],
+    "toBeRemovedInVersion": ["deprecated"]
   },
   "$defs": {
     "iconDeprecationReasons": {

icons/alarm-clock-check.json

@@ -19,6 +19,11 @@
     "time"
   ],
   "aliases": [
-    "alarm-check"
+    {
+      "name": "alarm-check",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }

icons/alarm-clock-minus.json

@@ -15,6 +15,11 @@
     "time"
   ],
   "aliases": [
-    "alarm-minus"
+    {
+      "name": "alarm-minus",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }

icons/alarm-clock-plus.json

@@ -15,6 +15,11 @@
     "time"
   ],
   "aliases": [
-    "alarm-plus"
+    {
+      "name": "alarm-plus",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }

icons/arrow-down-0-1.json

@@ -21,6 +21,11 @@
     "arrows"
   ],
   "aliases": [
-    "arrow-down-01"
+    {
+      "name": "arrow-down-01",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }

icons/arrow-down-1-0.json

@@ -21,6 +21,11 @@
     "arrows"
   ],
   "aliases": [
-    "arrow-down-10"
+    {
+      "name": "arrow-down-10",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }

icons/arrow-down-a-z.json

@@ -21,6 +21,11 @@
     "arrows"
   ],
   "aliases": [
-    "arrow-down-az"
+    {
+      "name": "arrow-down-az",
+      "deprecationReason": "alias.name",
+      "deprecated": true,
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }