lucide-icons · karsa-mistmere · May 22, 2024 · Mar 8, 2024 · Mar 8, 2024 · Mar 8, 2024
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/deprecationReasons"
+              },
+              "gracePeriod": {
+                "$ref": "#/$defs/versionNumber",
+                "description": "The version this icon will be removed in."
+              }
+            },
+            "dependentRequired": {
+              "deprecated": ["deprecationReason", "gracePeriod"]
+            }
+          }
+        ]
       },
       "uniqueItems": true
     },
@@ -49,8 +74,27 @@
       "uniqueItems": true
     },
     "deprecated": {
-      "type": "boolean",
-      "default": false
+      "const": true
+    },
+    "deprecationReason": {
+      "$ref": "#/$defs/deprecationReasons"
+    },
+    "gracePeriod": {
+      "$ref": "#/$defs/versionNumber",
+      "description": "The version this icon will be removed in."
+    }
+  },
+  "dependentRequired": {
+    "deprecated": ["deprecationReason", "gracePeriod"]
+  },
+  "$defs": {
+    "deprecationReasons": {
+      "type": "string",
+      "enum": ["icon.brand", "alias.typo"]
+    },
+    "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",
+      "gracePeriod": "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",
+      "gracePeriod": "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",
+  "gracePeriod": "v1.0",
   "contributors": [
     "colebemis",
     "ericfennis"

diff --git a/icons/codepen.json b/icons/codepen.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "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",
+  "gracePeriod": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/dribbble.json b/icons/dribbble.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "v1.0",
   "contributors": [
     "ahtohbi4"
   ],

diff --git a/icons/facebook.json b/icons/facebook.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "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",
+  "gracePeriod": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

diff --git a/icons/framer.json b/icons/framer.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "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",
+  "gracePeriod": "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",
+  "gracePeriod": "v1.0",
   "contributors": [
     "colebemis",
     "csandman",

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

diff --git a/icons/pocket.json b/icons/pocket.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "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",
+      "gracePeriod": "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",
+  "gracePeriod": "v1.0",
   "contributors": [
     "colebemis",
     "ashygee",

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

diff --git a/icons/twitch.json b/icons/twitch.json
@@ -1,6 +1,8 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "icon.brand",
+  "gracePeriod": "v1.0",
   "contributors": [
     "ahtohbi4",
     "johnletey"

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

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

diff --git a/packages/lucide-angular/scripts/exportTemplate.mjs b/packages/lucide-angular/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -17,7 +17,7 @@ import { LucideIconData } from './types';
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {FunctionalComponent} Vue component
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
 */
 const ${componentName}: LucideIconData = ${JSON.stringify(children)}; //eslint-disable-line no-shadow-restricted-names
 

diff --git a/packages/lucide-preact/scripts/exportTemplate.mjs b/packages/lucide-preact/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -17,7 +17,7 @@ import createLucideIcon from '../createLucideIcon';
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {JSX.Element} JSX Element
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)});
 

diff --git a/packages/lucide-react-native/scripts/exportTemplate.mjs b/packages/lucide-react-native/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -17,7 +17,7 @@ import createLucideIcon from '../createLucideIcon';
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {JSX.Element} JSX Element
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)});
 

diff --git a/packages/lucide-react/package.json b/packages/lucide-react/package.json
@@ -40,7 +40,6 @@
     "copy:license": "cp ../../LICENSE ./LICENSE",
     "clean": "rm -rf dist && rm -rf stats && rm -rf ./src/icons/*.ts && rm -f dynamicIconImports.*",
     "build:icons": "build-icons --output=./src --templateSrc=./scripts/exportTemplate.mjs --renderUniqueKey --withAliases --withDynamicImports --separateAliasesFile --aliasesFileExtension=.ts --iconFileExtension=.ts --exportFileName=index.ts",
-    "build:types": "node ./scripts/buildTypes.mjs",
     "build:bundles": "rollup -c ./rollup.config.mjs",
     "typecheck": "tsc",
     "typecheck:watch": "tsc -w",

diff --git a/packages/lucide-react/scripts/exportTemplate.mjs b/packages/lucide-react/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -17,7 +17,7 @@ import createLucideIcon from '../createLucideIcon';
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {JSX.Element} JSX Element
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)});
 

diff --git a/packages/lucide-react/scripts/getAliasesEntryNames.mjs b/packages/lucide-react/scripts/getAliasesEntryNames.mjs
@@ -11,5 +11,7 @@ export default async function getAliasesEntryNames() {
 
   const aliases = iconWithAliases.flatMap(({ aliases }) => aliases);
 
-  return aliases.map((alias) => path.join('src/icons', `${alias}.ts`));
+  return aliases
+    .map((alias) => (typeof alias === 'string' ? alias : alias.name))
+    .map((alias) => path.join('src/icons', `${alias}.ts`));
 }
diff --git a/packages/lucide-solid/scripts/exportTemplate.mjs b/packages/lucide-solid/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -20,7 +20,7 @@ const iconNode: IconNode = ${JSON.stringify(children)};
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {JSX.Element} JSX Element
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = (props: LucideProps) => (
   <Icon {...props} name="${componentName}" iconNode={iconNode} />

diff --git a/packages/lucide-static/scripts/exportTemplate.mjs b/packages/lucide-static/scripts/exportTemplate.mjs
@@ -1,7 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated }) => {
+export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
   let svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -21,7 +21,7 @@ export default ({ componentName, iconName, children, getSvg, deprecated }) => {
  * @see https://lucide.dev/guide/packages/lucide-static - Documentation
  *
  * @returns {String}
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName}: string = \`\
 ${svgContents}\