fix(icons): deprecated swiss franc icons (#4799)

* fix(icons): deprecated swiss franc icons & refined icon deprecation reasons

* Update tools/build-icons/utils/deprecationReasonTemplate.ts

Co-authored-by: Jakob Guddas <github@jguddas.de>

* fix(icons): replace icon.obsolete => icon.use-case

---------

Co-authored-by: Jakob Guddas <github@jguddas.de>

icon.schema.json

@@ -141,7 +141,7 @@
   "$defs": {
     "iconDeprecationReasons": {
       "type": "string",
-      "enum": ["icon.renamed"]
+      "enum": ["icon.design", "icon.use-case"]
     },
     "aliasDeprecationReasons": {
       "type": "string",

icons/badge-swiss-franc.json

@@ -3,6 +3,8 @@
   "contributors": [
     "danielbayley"
   ],
+  "deprecated": true,
+  "deprecationReason": "icon.use-case",
   "use-cases": [],
   "tags": [
     "discount",

icons/receipt-swiss-franc.json

@@ -4,6 +4,8 @@
     "danielbayley",
     "karsa-mistmere"
   ],
+  "deprecated": true,
+  "deprecationReason": "icon.use-case",
   "use-cases": [],
   "tags": [
     "bill",

icons/swiss-franc.json

@@ -4,6 +4,8 @@
     "ericfennis",
     "mittalyashu"
   ],
+  "deprecated": true,
+  "deprecationReason": "icon.use-case",
   "use-cases": [],
   "tags": [
     "currency",

lab/swiss-franc-circle.json

@@ -3,6 +3,8 @@
   "contributors": [
     "danielbayley"
   ],
+  "deprecated": true,
+  "deprecationReason": "icon.use-case",
   "tags": [
     "monetization",
     "marketing",

lab/swiss-franc-square.json

@@ -3,6 +3,8 @@
   "contributors": [
     "danielbayley"
   ],
+  "deprecated": true,
+  "deprecationReason": "icon.use-case",
   "tags": [
     "monetization",
     "marketing",

tools/build-icons/types.ts

@@ -32,7 +32,7 @@ export type AliasDeprecation = {
   deprecationReason: AliasDeprecationReason;
 };
 
-export type IconDeprecationReason = 'icon.renamed' | '';
+export type IconDeprecationReason = 'icon.design' | 'icon.use-case' | '';
 
 export type IconMetadataBase = {
   categories: string[];

tools/build-icons/utils/deprecationReasonTemplate.ts

@@ -16,6 +16,10 @@ export default function deprecationReasonTemplate(
       return `The icon was combined with another icon that shares the same use case, use {@link ${componentName}} instead.`;
     case 'alias.name':
       return `The name of this icon was changed because it didn't meet our guidelines anymore, use {@link ${componentName}} instead.`;
+    case 'icon.design':
+      return `Removed because the icon didn't meet our design guidelines.`;
+    case 'icon.use-case':
+      return `Removed because the depicted concept became obsolete and no longer had relevant use cases.`;
     default:
       throw new Error(`Unknown deprecation reason: ${deprecationReason}`);
   }