v1.1.0 Improvements

Author: AlemTuzlak

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-icons-spritesheet",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Vite plugin that generates a spritesheet out of your icons.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -58,7 +58,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "glob": "^10.3.12",
-    "vite": "^5.2.10",
+    "vite": "5.2.11",
     "node-html-parser": "^6.1.13"
   },
   "devDependencies": {

package.json

@@ -25,7 +25,7 @@ const generateIcons = async ({ withTypes = false, inputDir, outputDir, cwd, file
     cwd: inputDir,
   });
   if (files.length === 0) {
-    console.log(`⚠️ No SVG files found in ${chalk.red(inputDirRelative)}`);
+    console.log(`⚠️  No SVG files found in ${chalk.red(inputDirRelative)}`);
     return;
   }
 
@@ -34,8 +34,8 @@ const generateIcons = async ({ withTypes = false, inputDir, outputDir, cwd, file
     files,
     inputDir,
     outputPath: path.join(outputDir, fileName),
+    outputDirRelative,
   });
-  console.log(`🖼️  Generated SVG spritesheet in ${chalk.green(outputDirRelative)}`);
   if (withTypes) {
     await generateTypes({
       names: files.map((file: string) => fileNameToCamelCase(file.replace(/\.svg$/, ""))),
@@ -56,10 +56,12 @@ async function generateSvgSprite({
   files,
   inputDir,
   outputPath,
+  outputDirRelative,
 }: {
   files: string[];
   inputDir: string;
   outputPath: string;
+  outputDirRelative?: string;
 }) {
   // Each SVG becomes a symbol and we wrap them all in a single SVG
   const symbols = await Promise.all(
@@ -84,17 +86,18 @@ async function generateSvgSprite({
     })
   );
   const output = [
-    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
-    "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"0\" height=\"0\">",
+    '<?xml version="1.0" encoding="UTF-8"?>',
+    '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="0" height="0">',
     "<defs>", // for semantics: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs
     ...symbols.filter(Boolean),
     "</defs>",
     "</svg>",
   ].join("\n");
-  return fs.writeFile(outputPath, output, "utf8");
+
+  return writeIfChanged(outputPath, output, `🖼️  Generated SVG spritesheet in ${chalk.green(outputDirRelative)}`);
 }
 
-function generateTypes({ names, outputPath }: { names: string[]; outputPath: string }) {
+async function generateTypes({ names, outputPath }: { names: string[]; outputPath: string }) {
   const output = [
     "// This file is generated by icon spritesheet generator",
     "",
@@ -107,16 +110,42 @@ function generateTypes({ names, outputPath }: { names: string[]; outputPath: str
     "",
   ].join("\n");
 
-  const file = fs.writeFile(outputPath, output, "utf8");
-  console.log(`${chalk.blueBright("TS")} Generated icon types in ${chalk.green(outputPath)}`);
+  const file = await writeIfChanged(
+    outputPath,
+    output,
+    `${chalk.blueBright("TS")} Generated icon types in ${chalk.green(outputPath)}`
+  );
   return file;
 }
 
+/**
+ * Each write can trigger dev server reloads
+ * so only write if the content has changed
+ */
+async function writeIfChanged(filepath: string, newContent: string, message: string) {
+  const currentContent = await fs.readFile(filepath, "utf8");
+  if (currentContent !== newContent) {
+    await fs.writeFile(filepath, newContent, "utf8");
+    console.log(message);
+  }
+}
+
 export const iconsSpritesheet: (args: PluginProps) => Plugin = ({ withTypes, inputDir, outputDir, fileName, cwd }) => ({
   name: "icon-spritesheet-generator",
   apply(config) {
     return config.mode === "development";
   },
+  async watchChange(file, type) {
+    const inputPath = normalizePath(path.join(cwd ?? process.cwd(), inputDir));
+    if (file.includes(inputPath) && file.endsWith(".svg") && ["create", "delete"].includes(type.event)) {
+      await generateIcons({
+        withTypes,
+        inputDir,
+        outputDir,
+        fileName,
+      });
+    }
+  },
   async handleHotUpdate({ file }) {
     const inputPath = normalizePath(path.join(cwd ?? process.cwd(), inputDir));
     if (file.includes(inputPath) && file.endsWith(".svg")) {

src/index.ts

@@ -32,7 +32,7 @@
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "typescript": "^5.1.6",
-    "vite": "^5.1.0",
+    "vite": "^5.2.11",
     "vite-tsconfig-paths": "^4.2.1"
   },
   "engines": {