feat(icons): add deprecationReason and alias deprecation feature (#1960)

* feat(icons): add deprecationReason and alias deprecation feature * chore(tools): run prettier. again. * fix(scripts): overall alias as object support * fix(icon.schema.json): add dependentRequired on deprecated properties * fix(icon.schema.json): remove unicode for now * fix(icon.schema.json): use const true for deprecated * fix(build): convert deprecation reason to enum * fix(build): fix linting of icon.schema.json * fix(build): renamed gracePeriod => toBeRemovedInVersion * fix(build): fix aliases map in related icons generation * fix(build): deprecate aliases using numbers * feat(icon-schema): separate deprecation reason enumerations, extract removal notice * fix(icon-schema): fix linting * Update tools/build-icons/utils/deprecationReasonTemplate.mjs * fix(icons): add deprecation reason to some more icons * fix(docs): fix linting issue --------- Co-authored-by: Karsa <[email protected]> Co-authored-by: Jakob Guddas <[email protected]>
lucide-icons · May 22, 2024 · e2b46ea · e2b46ea
1 parent 1b3173b
commit e2b46ea
Show file tree

Hide file tree

Showing 63 changed files with 352 additions and 169 deletions.
diff --git a/docs/scripts/writeCategoriesMetadata.mjs b/docs/scripts/writeCategoriesMetadata.mjs
@@ -23,7 +23,7 @@ function getAllCategoryFiles() {
 
 const categoriesFile = path.resolve(dataDirectory, `categoriesData.json`);
 
-const categoriesData = getAllCategoryFiles()
+const categoriesData = getAllCategoryFiles();
 
 fs.promises
   .writeFile(categoriesFile, JSON.stringify(categoriesData, null, 2), 'utf-8')
@@ -33,4 +33,3 @@ fs.promises
   .catch((error) => {
     throw new Error(`Something went wrong generating the categoriesData.json file,\n ${error}`);
   });
-
diff --git a/icon.schema.json b/icon.schema.json
@@ -21,7 +21,32 @@
     "aliases": {
       "type": "array",
       "items": {
-        "type": "string"
+        "oneOf": [
+          {
+            "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"]
+            }
+          }
+        ]
       },
       "uniqueItems": true
     },
@@ -49,8 +74,31 @@
       "uniqueItems": true
     },
     "deprecated": {
-      "type": "boolean",
-      "default": false
+      "const": true
+    },
+    "deprecationReason": {
+      "$ref": "#/$defs/iconDeprecationReasons"
+    },
+    "toBeRemovedInVersion": {
+      "$ref": "#/$defs/versionNumber",
+      "description": "The version this icon will be removed in."
+    }
+  },
+  "dependentRequired": {
+    "deprecated": ["deprecationReason", "toBeRemovedInVersion"]
+  },
+  "$defs": {
+    "iconDeprecationReasons": {
+      "type": "string",
+      "enum": ["icon.brand"]
+    },
+    "aliasDeprecationReasons": {
+      "type": "string",
+      "enum": ["alias.typo", "alias.name"]
+    },
+    "versionNumber": {
+      "type": "string",
+      "pattern": "v[0-9]+(\\.[0-9]+)+"
     }
   },
   "description": "A JSON Schema for icons defined by Lucide Icons."

diff --git a/icons/between-horizontal-end.json b/icons/between-horizontal-end.json
@@ -33,6 +33,11 @@
     "account"
   ],
   "aliases": [
-    "between-horizonal-end"
+    {
+      "name": "between-horizonal-end",
+      "deprecated": true,
+      "deprecationReason": "alias.typo",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/between-horizontal-start.json b/icons/between-horizontal-start.json
@@ -33,6 +33,11 @@
     "account"
   ],
   "aliases": [
-    "between-horizonal-start"
+    {
+      "name": "between-horizonal-start",
+      "deprecated": true,
+      "deprecationReason": "alias.typo",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/chrome.json b/icons/chrome.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "ericfennis"

diff --git a/icons/circle-user-round.json b/icons/circle-user-round.json
@@ -13,6 +13,11 @@
     "shapes"
   ],
   "aliases": [
-    "user-circle-2"
+    {
+      "name": "user-circle-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/code-xml.json b/icons/code-xml.json
@@ -15,6 +15,11 @@
     "development"
   ],
   "aliases": [
-    "code-2"
+    {
+      "name": "code-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/codepen.json b/icons/codepen.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "ericfennis"

diff --git a/icons/codesandbox.json b/icons/codesandbox.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/contact-round.json b/icons/contact-round.json
@@ -19,6 +19,11 @@
     "social"
   ],
   "aliases": [
-    "contact-2"
+    {
+      "name": "contact-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/dribbble.json b/icons/dribbble.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "ahtohbi4"
   ],

diff --git a/icons/earth.json b/icons/earth.json
@@ -17,6 +17,11 @@
     "navigation"
   ],
   "aliases": [
-    "globe-2"
+    {
+      "name": "globe-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/facebook.json b/icons/facebook.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/figma.json b/icons/figma.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/file-cog.json b/icons/file-cog.json
@@ -15,6 +15,11 @@
     "files"
   ],
   "aliases": [
-    "file-cog-2"
+    {
+      "name": "file-cog-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/folder-cog.json b/icons/folder-cog.json
@@ -1,8 +1,5 @@
 {
   "$schema": "../icon.schema.json",
-  "aliases": [
-    "folder-cog-2"
-  ],
   "contributors": [
     "karsa-mistmere"
   ],
@@ -17,5 +14,13 @@
   ],
   "categories": [
     "files"
+  ],
+  "aliases": [
+    {
+      "name": "folder-cog-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/framer.json b/icons/framer.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/github.json b/icons/github.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/gitlab.json b/icons/gitlab.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/ice-cream-bowl.json b/icons/ice-cream-bowl.json
@@ -19,6 +19,11 @@
     "food-beverage"
   ],
   "aliases": [
-    "ice-cream-2"
+    {
+      "name": "ice-cream-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/instagram.json b/icons/instagram.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/laptop-minimal.json b/icons/laptop-minimal.json
@@ -12,6 +12,11 @@
     "devices"
   ],
   "aliases": [
-    "laptop-2"
+    {
+      "name": "laptop-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/mic-vocal.json b/icons/mic-vocal.json
@@ -22,6 +22,11 @@
     "multimedia"
   ],
   "aliases": [
-    "mic-2"
+    {
+      "name": "mic-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/pen-line.json b/icons/pen-line.json
@@ -26,6 +26,11 @@
     "tools"
   ],
   "aliases": [
-    "edit-3"
+    {
+      "name": "edit-3",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/pen.json b/icons/pen.json
@@ -26,6 +26,11 @@
     "tools"
   ],
   "aliases": [
-    "edit-2"
+    {
+      "name": "edit-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/pocket.json b/icons/pocket.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/send-horizontal.json b/icons/send-horizontal.json
@@ -17,6 +17,11 @@
     "connectivity"
   ],
   "aliases": [
-    "send-horizonal"
+    {
+      "name": "send-horizonal",
+      "deprecated": true,
+      "deprecationReason": "alias.typo",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }
diff --git a/icons/slack.json b/icons/slack.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "toBeRemovedInVersion": "v1.0",
   "contributors": [
     "colebemis",
     "ashygee",

diff --git a/icons/square-user-round.json b/icons/square-user-round.json
@@ -13,6 +13,11 @@
     "shapes"
   ],
   "aliases": [
-    "user-square-2"
+    {
+      "name": "user-square-2",
+      "deprecated": true,
+      "deprecationReason": "alias.name",
+      "toBeRemovedInVersion": "v1.0"
+    }
   ]
 }