svg-toolbox 1.0.1 → 1.0.3

package/README.md

@@ -1,2 +1,23 @@
 # svg-toolbox
 This library provides some SVG-related tools
+
+## Installation
+```bash
+npm install svg-toolbox
+```
+## Usage
+```js
+const { svg2png } = require('svg-toolbox')
+
+...
+svg2png(svgPath, pngSavePath, x)
+...
+```
+
+```js
+const { diffSvg } = require('svg-toolbox')
+
+...
+diffSvg(svgPath1, svgPath2, diffResultSavePath)
+...
+```

package/lib/applyDiffSvg.js

@@ -1,38 +1,73 @@
+/**
+ * @file applyDiffSvg.js
+ * @description This module provides a function to compare two PNG images and generate a diff image using the sharp and pixelmatch libraries.
+ * @module applyDiffSvg
+ * @requires sharp - Image processing library
+ * @requires pixelmatch - Image comparison library
+ * @requires fs - File system module
+ * @requires path - Path module
+ * @author pipi
+ */
+
 const fs = require('fs');
 const sharp = require('sharp');
 const PNG = require('pngjs').PNG;
 const path = require('path');
 
+/**
+ * Checks if the filename has a valid suffix.
+ * @param {string} filename - The name of the file.
+ * @returns {boolean} - True if the filename has a suffix, false otherwise.
+ */
 function validSuffix(filename) {
   return path.extname(filename) !== '';
 }
 
+/**
+ * Compares two SVG files and generates a diff image.
+ * @param {string} pathA - The path of the first SVG file.
+ * @param {string} pathB - The path of the second SVG file.
+ * @param {string} diffFilePath - The path to save the diff image.
+ * @returns - The diff image buffer and the number of different pixels.
+ */
 module.exports = async function (pathA, pathB, diffFilePath) {
+  // Read the PNG files as buffers
   const pngA = await sharp(pathA).toBuffer();
   const pngB = await sharp(pathB).toBuffer();
+
+  // Import pixelmatch library
   const pixelmatch = (await import('pixelmatch')).default;
+
+  // Decode the PNG buffers
   const img1 = PNG.sync.read(pngA);
   const img2 = PNG.sync.read(pngB);
   const { width, height } = img1;
+
+  // Create a new PNG object for the diff image
   const diff = new PNG({ width, height });
 
+  // Compare the images and get the number of different pixels
   const numDiffPixels = pixelmatch(img1.data, img2.data, diff.data, width, height, { threshold: 0.1 });
-  if (!fs.existsSync('diff')) {
-    fs.mkdirSync('diff', { recursive: true });
-  }
+
+  // Write the diff image to a buffer
   const diffPngBuffer = PNG.sync.write(diff);
+
+  // If a diff file path is provided, save the diff image
   if (diffFilePath) {
-    const diffFileName = diffFilePath.split('/').pop();
+    const diffFileName = path.basename(diffFilePath);
     if (!validSuffix(diffFileName)) {
-      return console.error(`Error converting ${diffFileName} to PNG: No suffix found.`);
+      console.error(`Error converting ${diffFileName} to PNG: No suffix found.`);
+      return;
     }
-    fs.writeFileSync(`${diffFilePath}`, diffPngBuffer);
+    fs.writeFileSync(diffFilePath, diffPngBuffer);
+
+    // Log the result
     if (numDiffPixels === 0) {
-      console.log(`\x1b[${32}mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
-      return { diffPngBuffer, numDiffPixels };
+      console.log(`\x1b[32mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
     } else {
-      console.log(`\x1b[${33}mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
+      console.log(`\x1b[33mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
     }
   }
+
   return { diffPngBuffer, numDiffPixels };
 }

package/lib/applySvg2Png.js

@@ -2,13 +2,21 @@
  * @file applySvg2Png.js
  * @description This module provides a function to convert SVG files to PNG format using the sharp library.
  * @module applySvg2Png
- * @requires sharp
+ * @requires sharp - Image processing library
+ * @requires fs - File system module
  * @author pipi
  */
 
 const sharp = require('sharp');
 const fs = require('fs');
 
+/**
+ * Converts an SVG file to PNG format.
+ * @param {string} svgPath - The path to read the SVG file. 
+ * @param {string} pngPath - The path to save the PNG file.
+ * @param {number} x - The scaling factor for the PNG image.
+ * @returns
+ */
 module.exports = function (svgPath, pngPath, x = 2) {
   // Read the SVG file
   const file = svgPath.split('/').pop();

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "svg-toolbox",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "This library provides some SVG-related tools",
   "main": "lib/index.js",
+  "repository": "https://github.com/SteamedBread2333/svg-toolbox",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -16,4 +17,4 @@
     "pngjs": "^7.0.0",
     "sharp": "^0.33.5"
   }
-}
+}