feat: add generate mode option (#27)

* feat: add recreate generate mode

* chore: changeset

.changeset/odd-yaks-wash.md

@@ -0,0 +1,10 @@
+---
+"@icona/generator": minor
+"@icona/types": minor
+"@icona/utils": minor
+---
+
+feat: add generate mode option
+
+- `overwrite` (default): overwrite existing files in folder
+- `recreate`: rm -rf all files and generate new files in folder

README.md

@@ -11,6 +11,10 @@ Shorten the process between designers (Figma) and developers (GitHub).
 - **Designer**: Build icon set in Figma and click deploy button, that's it.
 - **Developer**: Check the PR and use the icon svg set in your project. (Make react component, Make Pdf, Make XML, ...etc)
 
+## Boilerplate
+
+- [junghyeonsu/test-icona](https://github.com/junghyeonsu/test-icona)
+
 ## Preview
 
 ![preview](./images/preview.png)

packages/generator/src/core/drawable.ts

@@ -1,5 +1,6 @@
 import type { GenerateDrawableConfig, IconaIconData } from "@icona/types";
 import {
+  deleteAllFilesInDir,
   getIconaIconsFile,
   getProjectRootPath,
   makeFolderIfNotExistFromRoot,
@@ -30,6 +31,10 @@ export const generateDrawable = ({
     throw new Error("There is no icons data");
   }
 
+  if (config.genMode === "recreate") {
+    deleteAllFilesInDir(resolve(projectPath, path));
+  }
+
   // TODO: Name transform option
   Object.entries(icons).forEach(async ([name, data]) => {
     const { svg } = data;

packages/generator/src/core/pdf.ts

@@ -1,5 +1,6 @@
 import type { GeneratePDFConfig, IconaIconData } from "@icona/types";
 import {
+  deleteAllFilesInDir,
   getIconaIconsFile,
   getProjectRootPath,
   makeFolderIfNotExistFromRoot,
@@ -31,6 +32,10 @@ export const generatePDF = ({
     throw new Error("There is no icons data");
   }
 
+  if (config.genMode === "recreate") {
+    deleteAllFilesInDir(resolve(projectPath, path));
+  }
+
   // TODO: Name transform option
   Object.entries(icons).forEach(async ([name, data]) => {
     const { svg } = data;

packages/generator/src/core/png.ts

@@ -1,5 +1,6 @@
 import type { GeneratePNGConfig, IconaIconData } from "@icona/types";
 import {
+  deleteAllFilesInDir,
   getIconaIconsFile,
   getProjectRootPath,
   makeFolderIfNotExistFromRoot,
@@ -27,6 +28,10 @@ export const generatePNG = ({
     throw new Error("There is no icons data");
   }
 
+  if (config.genMode === "recreate") {
+    deleteAllFilesInDir(resolve(projectPath, path));
+  }
+
   // TODO: Name transform option
   Object.entries(icons).forEach(([name, data]) => {
     const { png } = data;

packages/generator/src/core/react.ts

@@ -1,5 +1,6 @@
 import type { GenerateReactConfig, IconaIconData } from "@icona/types";
 import {
+  deleteAllFilesInDir,
   getIconaIconsFile,
   getProjectRootPath,
   makeFolderIfNotExistFromRoot,
@@ -30,6 +31,10 @@ export const generateReact = ({
     throw new Error("There is no icons data");
   }
 
+  if (config.genMode === "recreate") {
+    deleteAllFilesInDir(resolve(projectPath, path));
+  }
+
   // TODO: Name transform option
   Object.entries(icons).forEach(async ([name, data]) => {
     const { svg } = data;

packages/generator/src/core/svg.ts

@@ -1,5 +1,6 @@
 import type { GenerateSVGConfig, IconaIconData } from "@icona/types";
 import {
+  deleteAllFilesInDir,
   getIconaIconsFile,
   getProjectRootPath,
   makeFolderIfNotExistFromRoot,
@@ -29,6 +30,10 @@ export const generateSVG = ({
     throw new Error("There is no icons data");
   }
 
+  if (config.genMode === "recreate") {
+    deleteAllFilesInDir(resolve(projectPath, path));
+  }
+
   // TODO: Name transform option
   Object.entries(icons).forEach(([name, data]) => {
     const { svg } = data;

packages/types/package.json

@@ -6,9 +6,8 @@
     "url": "git+https://github.com/daangn/icona.git",
     "directory": "packages/types"
   },
-  "main": "./dist/index.d.ts",
+  "main": "./src/index.d.ts",
   "files": [
-    "dist",
     "src"
   ],
   "scripts": {

packages/types/src/lib.ts → packages/types/src/lib.d.ts

@@ -30,7 +30,18 @@ export interface SvgToPdfOptions extends SVGtoPDFOptions {
   x?: number;
   y?: number;
 }
+/**
+ * @param overwrite overwrite existing files in folder
+ * @param recreate rm -rf all files and generate new files in folder
+ */
+export type GenerateMode = "recreate" | "overwrite";
+
 export interface GeneratePDFConfig {
+  /**
+   * @default overwrite
+   */
+  genMode?: GenerateMode;
+
   /**
    * generate drawable pdf files
    * @default false
@@ -60,6 +71,11 @@ export interface GeneratePDFConfig {
 }
 
 export interface GenerateReactConfig {
+  /**
+   * @default overwrite
+   */
+  genMode?: GenerateMode;
+
   /**
    * generate drawable react files
    * @default false
@@ -80,6 +96,11 @@ export interface GenerateReactConfig {
 }
 
 export interface GenerateSVGConfig {
+  /**
+   * @default overwrite
+   */
+  genMode?: GenerateMode;
+
   /**
    * generate drawable svg files
    * @default true
@@ -108,6 +129,11 @@ interface Svg2vectordrawableOptions {
 }
 
 export interface GenerateDrawableConfig {
+  /**
+   * @default overwrite
+   */
+  genMode?: GenerateMode;
+
   /**
    * generate drawable xml files
    * @default false
@@ -135,6 +161,11 @@ export interface GenerateDrawableConfig {
 }
 
 export interface GeneratePNGConfig {
+  /**
+   * @default overwrite
+   */
+  genMode?: GenerateMode;
+
   /**
    * generate drawable xml files
    * @default false

packages/types/tsconfig.json

@@ -1,12 +1,5 @@
 {
-  "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "isolatedModules": true,
-    "esModuleInterop": true,
-    "declaration": true,
-    "outDir": "dist",
-    "rootDir": "src",
-    "emitDeclarationOnly": true
   },
-  "include": ["./src"],
+  "include": ["./src/**/*"],
 }

packages/utils/src/index.ts

@@ -1,8 +1,15 @@
 // TODO: Need test code for this file.
 import type { IconaIconData } from "@icona/types";
 import findup from "findup-sync";
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
-import { dirname, resolve } from "path";
+import {
+  existsSync,
+  mkdirSync,
+  readdirSync,
+  readFileSync,
+  unlinkSync,
+  writeFileSync,
+} from "fs";
+import path, { dirname, resolve } from "path";
 
 export const ICONA_FOLDER = ".icona";
 export const ICONA_ICONS_FILE = "icons.json";
@@ -70,3 +77,13 @@ export const generateConfigFile = (config: string) => {
 
   writeFileSync(configPath, config);
 };
+
+export const deleteAllFilesInDir = (dirPath: string) => {
+  try {
+    readdirSync(dirPath).forEach((file) => {
+      unlinkSync(path.join(dirPath, file));
+    });
+  } catch (error) {
+    console.log(error);
+  }
+};