svg-toolbox 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 pipi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# svg-toolbox
+This library provides some SVG-related tools

package/lib/applyDiffSvg.js

@@ -0,0 +1,38 @@
+const fs = require('fs');
+const sharp = require('sharp');
+const PNG = require('pngjs').PNG;
+const path = require('path');
+
+function validSuffix(filename) {
+  return path.extname(filename) !== '';
+}
+
+module.exports = async function (pathA, pathB, diffFilePath) {
+  const pngA = await sharp(pathA).toBuffer();
+  const pngB = await sharp(pathB).toBuffer();
+  const pixelmatch = (await import('pixelmatch')).default;
+  const img1 = PNG.sync.read(pngA);
+  const img2 = PNG.sync.read(pngB);
+  const { width, height } = img1;
+  const diff = new PNG({ width, height });
+
+  const numDiffPixels = pixelmatch(img1.data, img2.data, diff.data, width, height, { threshold: 0.1 });
+  if (!fs.existsSync('diff')) {
+    fs.mkdirSync('diff', { recursive: true });
+  }
+  const diffPngBuffer = PNG.sync.write(diff);
+  if (diffFilePath) {
+    const diffFileName = diffFilePath.split('/').pop();
+    if (!validSuffix(diffFileName)) {
+      return console.error(`Error converting ${diffFileName} to PNG: No suffix found.`);
+    }
+    fs.writeFileSync(`${diffFilePath}`, diffPngBuffer);
+    if (numDiffPixels === 0) {
+      console.log(`\x1b[${32}mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
+      return { diffPngBuffer, numDiffPixels };
+    } else {
+      console.log(`\x1b[${33}mFile name: ${diffFileName} Number of different pixels: ${numDiffPixels}\x1b[0m`);
+    }
+  }
+  return { diffPngBuffer, numDiffPixels };
+}

package/lib/applySvg2Png.js

@@ -0,0 +1,40 @@
+/**
+ * @file applySvg2Png.js
+ * @description This module provides a function to convert SVG files to PNG format using the sharp library.
+ * @module applySvg2Png
+ * @requires sharp
+ * @author pipi
+ */
+
+const sharp = require('sharp');
+const fs = require('fs');
+
+module.exports = function (svgPath, pngPath, x = 2) {
+  // Read the SVG file
+  const file = svgPath.split('/').pop();
+  const svgContent = fs.readFileSync(svgPath, 'utf8');
+
+  // Extract the viewBox from the SVG content
+  const viewBoxRegex = /viewBox="(\d+) (\d+) (\d+) (\d+)"/;
+  const viewBoxMatch = viewBoxRegex.exec(svgContent);
+
+  if (!viewBoxMatch) {
+    console.error(`Error converting ${file} to PNG: No viewBox found.`);
+    return;
+  }
+
+  // Extract the width and height from the viewBox
+  const [, , , baseWidth, baseHeight] = viewBoxMatch.map(Number);
+
+  // Resize the SVG to the desired dimensions and convert it to PNG
+  sharp(svgPath)
+    .resize(x * baseWidth, x * baseHeight)
+    .png()
+    .toFile(pngPath)
+    .then(() => {
+      console.log(`\x1b[32mConverted ${file} to PNG successfully.\x1b[0m`);
+    })
+    .catch(error => {
+      console.error(`Error converting ${file} to PNG:`, error);
+    });
+}

package/lib/index.js

@@ -0,0 +1,7 @@
+const svg2Png = require('./applySvg2Png');
+const diffSvg = require('./applyDiffSvg');
+
+module.exports = {
+  svg2Png,
+  diffSvg
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "svg-toolbox",
+  "version": "1.0.0",
+  "description": "This library provides some SVG-related tools",
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "svg"
+  ],
+  "author": "pipi",
+  "license": "MIT",
+  "devDependencies": {
+    "pixelmatch": "^6.0.0",
+    "pngjs": "^7.0.0",
+    "sharp": "^0.33.5"
+  }
+}