@riebeckite/plugin-svg-optimizer 0.0.35 → 0.0.37

package/dist/index.js

@@ -16,6 +16,7 @@ function resolveSvgOptimizerOptions(options = {}) {
 function svgOptimizer(options = {}) {
   const resolved = resolveSvgOptimizerOptions(options);
   const config = svgoConfig(resolved);
+  let stats = emptyStats();
   return definePlugin({
     name: PLUGIN_NAME,
     order: 60,
@@ -26,16 +27,20 @@ function svgOptimizer(options = {}) {
     }),
     options,
     transformAssets: async ({ assets, readAsset, cache, logger, tracer }) => {
+      stats = emptyStats();
       if (resolved.keepOriginal) return [];
       const outputs = [];
       for (const asset of assets) {
         if (extensionOf(asset.path) !== "svg") continue;
+        stats.inputs += 1;
         if (asset.size !== void 0 && asset.size > DEFAULT_MAX_INPUT_BYTES) {
+          stats.skipped.push({ path: asset.path, reason: "oversized" });
           logger.warn(`Skipped oversized SVG asset: ${asset.path}`);
           continue;
         }
         const input = await readAsset(asset.path);
         if (!input || input.byteLength > DEFAULT_MAX_INPUT_BYTES) {
+          stats.skipped.push({ path: asset.path, reason: "unreadable" });
           logger.warn(
             `Skipped oversized or unreadable SVG asset: ${asset.path}`
           );
@@ -44,14 +49,22 @@ function svgOptimizer(options = {}) {
         const cacheKey = assetCacheKey(asset.path, input);
         const cached = await cache.get(cacheKey);
         if (isCachedSvgTransform(cached)) {
+          stats.cacheHits += 1;
           tracer.event("svg-transform.cache-hit", { path: asset.path });
           if (cached.content !== null) {
-            outputs.push(outputFor(asset.path, cached.content));
+            const output = outputFor(asset.path, cached.content);
+            stats.optimized += 1;
+            stats.savedBytes += input.byteLength - output.content.byteLength;
+            outputs.push(output);
+          } else {
+            stats.noReduction += 1;
           }
           continue;
         }
+        stats.cacheMisses += 1;
         const source = decode(input);
         if (source === null) {
+          stats.skipped.push({ path: asset.path, reason: "invalid UTF-8" });
           logger.warn(
             `Skipped SVG asset that is not valid UTF-8: ${asset.path}`
           );
@@ -60,6 +73,7 @@ function svgOptimizer(options = {}) {
         }
         const unsafe = unsafeReason(source);
         if (unsafe) {
+          stats.skipped.push({ path: asset.path, reason: unsafe });
           logger.warn(
             `Skipped SVG asset containing ${unsafe}: ${asset.path}. Optimization is not sanitization.`
           );
@@ -70,6 +84,7 @@ function svgOptimizer(options = {}) {
         try {
           optimized = optimize(source, config).data;
         } catch {
+          stats.skipped.push({ path: asset.path, reason: "optimize failed" });
           logger.warn(
             `Skipped SVG asset that could not be optimized: ${asset.path}`
           );
@@ -78,6 +93,7 @@ function svgOptimizer(options = {}) {
         }
         const content = Buffer.from(optimized, "utf8");
         if (content.byteLength >= input.byteLength) {
+          stats.noReduction += 1;
           tracer.event("svg-transform.no-reduction", { path: asset.path });
           await cache.set(cacheKey, { content: null });
           continue;
@@ -86,6 +102,8 @@ function svgOptimizer(options = {}) {
           content: content.toString("base64")
         });
         tracer.event("svg-transform.run", { path: asset.path });
+        stats.optimized += 1;
+        stats.savedBytes += input.byteLength - content.byteLength;
         outputs.push({
           sourcePath: asset.path,
           path: asset.path,
@@ -94,6 +112,69 @@ function svgOptimizer(options = {}) {
         });
       }
       return outputs;
+    },
+    inspector: {
+      apiVersion: 1,
+      tabs: [
+        {
+          id: "svg-optimizer",
+          title: { en: "SVG optimization", ja: "SVG 最適化" },
+          description: {
+            en: "Optimization results, cache use, and skipped assets.",
+            ja: "最適化結果、キャッシュ利用、スキップしたアセットを表示します。"
+          },
+          order: 23,
+          collect: () => resolved.keepOriginal ? {
+            kind: "key-value",
+            items: [
+              {
+                key: { en: "Status", ja: "状態" },
+                value: "disabled (keepOriginal)"
+              }
+            ]
+          } : {
+            kind: "key-value",
+            items: [
+              { key: { en: "Inputs", ja: "入力" }, value: stats.inputs },
+              {
+                key: { en: "Optimized", ja: "最適化" },
+                value: stats.optimized
+              },
+              {
+                key: { en: "No reduction", ja: "削減なし" },
+                value: stats.noReduction
+              },
+              {
+                key: { en: "Cache hits", ja: "キャッシュヒット" },
+                value: stats.cacheHits
+              },
+              {
+                key: { en: "Cache misses", ja: "キャッシュミス" },
+                value: stats.cacheMisses
+              },
+              {
+                key: { en: "Saved", ja: "削減量" },
+                value: formatBytes(stats.savedBytes)
+              },
+              {
+                key: { en: "Skipped", ja: "スキップ" },
+                value: stats.skipped.length
+              },
+              ...stats.skipped.length > 0 ? [
+                {
+                  key: {
+                    en: "Skipped assets",
+                    ja: "スキップしたアセット"
+                  },
+                  value: stats.skipped.slice(0, 20).map(
+                    (skipped) => `${skipped.path} (${skipped.reason})`
+                  ).join("; ")
+                }
+              ] : []
+            ]
+          }
+        }
+      ]
     }
   });
 }
@@ -166,6 +247,22 @@ function outputFor(sourcePath, content) {
     mimeType: MIME_TYPE
   };
 }
+function emptyStats() {
+  return {
+    inputs: 0,
+    optimized: 0,
+    noReduction: 0,
+    cacheHits: 0,
+    cacheMisses: 0,
+    savedBytes: 0,
+    skipped: []
+  };
+}
+function formatBytes(bytes) {
+  if (bytes < 1024) return `${bytes} B`;
+  if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
+  return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
+}
 export {
   resolveSvgOptimizerOptions,
   svgOptimizer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-svg-optimizer",
-  "version": "0.0.35",
+  "version": "0.0.37",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,12 +14,12 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.35",
+    "@riebeckite/core": "0.0.37",
     "svgo": "^4.1.0"
   },
   "devDependencies": {
-    "@riebeckite/plugin-image-optimizer": "0.0.35",
-    "@riebeckite/plugin-obsidian-markdown": "0.0.35",
+    "@riebeckite/plugin-image-optimizer": "0.0.37",
+    "@riebeckite/plugin-obsidian-markdown": "0.0.37",
     "sharp": "^0.35.5",
     "tsx": "^4.22.4"
   },