DEV: add migration of deprecated icon names to svg_icons site setting, also rename setting to lowercase of svg_icons

Author: tyb-talks

migrations/settings/0002-migrate-from-deprecated-icon-names.js

@@ -1,18 +1,28 @@
 export default function migrate(settings) {
-  const oldSetting = settings.get("header_links");
+  const oldHeaderLinksSetting = settings.get("header_links");
 
-  if (!oldSetting) {
-    return settings;
+  if (oldHeaderLinksSetting) {
+    const newHeaderLinksSetting = oldHeaderLinksSetting.map((link) => {
+      if (link.icon) {
+        link.icon = convertIconName(link.icon);
+      }
+      return link;
+    });
+
+    settings.set("header_links", newHeaderLinksSetting);
   }
 
-  const newSetting = oldSetting.map((link) => {
-    if (link.icon) {
-      link.icon = convertIconName(link.icon);
-    }
-    return link;
-  });
+  const oldSvgIconsSetting = settings.get("Svg_icons");
+  if (oldSvgIconsSetting) {
+    const newSvgIconsSetting = oldSvgIconsSetting
+      .split("|")
+      .map(convertIconName)
+      .join("|");
+
+    settings.set("svg_icons", newSvgIconsSetting);
+    settings.delete("Svg_icons");
+  }
 
-  settings.set("header_links", newSetting);
   return settings;
 }
 

settings.yml

@@ -1,7 +1,7 @@
 add_whitespace:
   type: bool
   default: false
-Svg_icons:
+svg_icons:
   type: "list"
   list_type: "compact"
   default: "fab-facebook|fab-twitter"

test/unit/migrations/settings/0002-migrate-from-deprecated-icon-names-test.js

@@ -37,6 +37,7 @@ module(
               target: "blank",
             },
           ],
+          Svg_icons: "fab-facebook|fab-twitter|fab fa-cog|user-friends",
         })
       );
 
@@ -74,6 +75,7 @@ module(
               target: "blank",
             },
           ],
+          svg_icons: "fab-facebook|fab-twitter|fab-gear|user-group",
         })
       );