feat(icons): add deprecationReason and alias deprecation feature

icon.schema.json

@@ -21,7 +21,26 @@
     "aliases": {
       "type": "array",
       "items": {
-        "type": "string"
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "deprecated": {
+                "type": "boolean",
+                "default": false
+              },
+              "deprecationReason": {
+                "type": "string"
+              }
+            }
+          }
+        ]
       },
       "uniqueItems": true
     },
@@ -51,6 +70,12 @@
     "deprecated": {
       "type": "boolean",
       "default": false
+    },
+    "deprecationReason": {
+      "type": "string"
+    },
+    "unicode": {
+      "type": "string"
     }
   },
   "description": "A JSON Schema for icons defined by Lucide Icons."

icons/between-horizontal-end.json

@@ -33,6 +33,10 @@
     "account"
   ],
   "aliases": [
-    "between-horizonal-end"
+    {
+      "name": "between-horizonal-end",
+      "deprecated": true,
+      "deprecationReason": "Renamed because of typo. This export will be removed in v1.0"
+    }
   ]
 }

icons/between-horizontal-start.json

@@ -33,6 +33,10 @@
     "account"
   ],
   "aliases": [
-    "between-horizonal-start"
+    {
+      "name": "between-horizonal-start",
+      "deprecated": true,
+      "deprecationReason": "Renamed because of typo. This export will be removed in v1.0"
+    }
   ]
 }

icons/chrome.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "ericfennis"

icons/codepen.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "ericfennis"

icons/codesandbox.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/dribbble.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "ahtohbi4"
   ],

icons/facebook.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/figma.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/framer.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/github.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/gitlab.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/instagram.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/pocket.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/send-horizontal.json

@@ -17,6 +17,10 @@
     "connectivity"
   ],
   "aliases": [
-    "send-horizonal"
+    {
+      "name": "send-horizonal",
+      "deprecated": true,
+      "deprecationReason": "Renamed because of typo. This export will be removed in v1.0"
+    }
   ]
 }

icons/slack.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "ashygee",

icons/trello.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "bdbch",
     "csandman",

icons/twitch.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "ahtohbi4",
     "johnletey"

icons/twitter.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

icons/youtube.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../icon.schema.json",
   "deprecated": true,
+  "deprecationReason": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670",
   "contributors": [
     "colebemis",
     "csandman",

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
 

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)});
 

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)});
 

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)});
 

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} />

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}\

packages/lucide-svelte/scripts/exportTemplate.mjs

@@ -2,7 +2,7 @@
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 import { getJSBanner } from './license.mjs';
 
-export default ({ iconName, children, componentName, getSvg, deprecated }) => {
+export default ({ iconName, children, componentName, getSvg, deprecated, deprecationReason }) => {
   const svgContents = getSvg();
   const svgBase64 = base64SVG(svgContents);
 
@@ -25,7 +25,7 @@ const iconNode: IconNode = ${JSON.stringify(children)};
  *
  * @param {Object} props - Lucide icons props and any valid SVG attribute
  * @returns {FunctionalComponent} Svelte component
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 </script>
 

packages/lucide-vue-next/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 {FunctionalComponent} Vue component
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = createLucideIcon('${componentName}Icon', ${JSON.stringify(children)});
 

packages/lucide-vue/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 {Component} Vue Component
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName} = createLucideIcon('${componentName}Icon', ${JSON.stringify(children)});
 

packages/lucide/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 type { IconNode } from '../types';
  * @see https://lucide.dev/guide/packages/lucide - Documentation
  *
  * @returns {Array}
- * ${deprecated ? '@deprecated' : ''}
+ * ${deprecated ? `@deprecated ${deprecationReason}` : ''}
  */
 const ${componentName}: IconNode = [
   'svg',

scripts/generate/generateIcons.mjs

@@ -22,6 +22,8 @@ const iconSvgTemplate = `<svg
 
 const iconJsonTemplate = `{
   "$schema": "../icon.schema.json",
+  "contributors": [
+  ],
   "tags": [
   ],
   "categories": [