feat(icons): add X icon and deprecate Twitter icon

docs/src/documentation/05-development/04-migration-guides/01-v17.mdx

@@ -14,4 +14,10 @@ With this guide, we aim to walk through all the breaking changes and how they ca
 
 ### ColoredTwitter icon removed
 
-The `ColoredTwitter` icon was removed. The `Twitter` icon should be used instead.
+The `ColoredTwitter` icon was removed. The `X` icon should be used instead.
+
+## Deprecations
+
+### `Twitter` icon
+
+The `Twitter` icon was deprecated and will be removed in a future version. The `X` icon should be used instead.

packages/orbit-components/config/build/buildIcons.mts

@@ -16,6 +16,8 @@ const randomId = () => Math.random().toString(36).substring(2, 9);
 const camelcase = (str: string) => str.replace(/[-_.](.)/g, (_, char) => char.toUpperCase());
 const firstToUpper = (str: string) => str.charAt(0).toUpperCase() + str.slice(1);
 
+const DEPRECATED_ICONS = ["Twitter"];
+
 (async () => {
   const files = await globby("src/icons/svg/*.svg");
   const [, __dirname] = filedirname();
@@ -45,6 +47,7 @@ const firstToUpper = (str: string) => str.charAt(0).toUpperCase() + str.slice(1)
     const iconPath = t.jsxFragment(t.jsxOpeningFragment(), t.jsxClosingFragment(), jsx.children);
     const iconViewbox = typeof viewBox === "string" ? t.stringLiteral(viewBox) : "";
     const iconName = t.stringLiteral(componentName);
+    const deprecated = DEPRECATED_ICONS.includes(componentName);
 
     return tpl`
     /* eslint-disable */
@@ -54,6 +57,15 @@ const firstToUpper = (str: string) => str.charAt(0).toUpperCase() + str.slice(1)
 
     import createIcon from "../Icon/createIcon";
 
+    ${
+      deprecated
+        ? `
+    /**
+     * @deprecated
+     */
+      `
+        : ""
+    }
     export default createIcon(${iconPath}, ${iconViewbox}, ${iconName});
     `;
   };