feat: add cleanSymbol config

db-ui · Apr 4, 2024 · c786d98 · c786d98
1 parent e732a51
commit c786d98
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/src/figma-icon-exporter/download-icons/index.ts b/src/figma-icon-exporter/download-icons/index.ts
@@ -2,6 +2,9 @@ import { DownloadTaskType } from "../../types";
 import { createWriteStream } from "fs";
 import axios from "axios";
 
+const cleanSymbols = (iconName: string): string =>
+  iconName.replaceAll("&", "and").replaceAll("/", "or");
+
 export const downloadIcons = async ({
   icon,
   resolvedImages,
@@ -30,8 +33,17 @@ export const downloadIcons = async ({
         } else {
           iconName = iconName.trim().replaceAll(" ", "_");
         }
+
+        if (
+          iconNameConfig.cleanSymbols === undefined ||
+          iconNameConfig.cleanSymbols
+        ) {
+          iconName = cleanSymbols(iconName);
+        }
       } else {
-        iconName = iconName.toLowerCase().trim().replaceAll(" ", "_");
+        iconName = cleanSymbols(
+          iconName.toLowerCase().trim().replaceAll(" ", "_"),
+        );
       }
 
       const filePath = `${icon.dir}/${iconName}.svg`;

diff --git a/src/types.ts b/src/types.ts
@@ -23,6 +23,11 @@ export type IconNameConfigType = {
    * Change the separator, defaults to '_'
    */
   separator?: string;
+
+  /**
+   * Replaces symbols(and,or,...), defaults to true
+   */
+  cleanSymbols?: string;
 };
 
 export type OptionsType = {