vitest-image-snapshot 0.6.48 → 0.6.50

package/dist/index.js

@@ -72,6 +72,8 @@ function pngBuffer(imageData) {
 }
 //#endregion
 //#region src/SnapshotManager.ts
+const replaceableChars = /[<>:"/\\|?*]/g;
+const unreplaceableChars = /\p{Control}+/gu;
 /** Manage reference/actual/diff snapshot files. */
 var ImageSnapshotManager = class {
 	config;
@@ -87,13 +89,13 @@ var ImageSnapshotManager = class {
 		};
 	}
 	referencePath(snapshotName) {
-		return path.join(this.testDir, this.config.snapshotDir, `${snapshotName}.png`);
+		return path.join(this.testDir, this.config.snapshotDir, `${sanitizeName(snapshotName)}.png`);
 	}
 	actualPath(snapshotName) {
-		return path.join(this.testDir, this.config.actualDir, `${snapshotName}.png`);
+		return path.join(this.testDir, this.config.actualDir, `${sanitizeName(snapshotName)}.png`);
 	}
 	diffPath(snapshotName) {
-		return path.join(this.testDir, this.config.diffDir, `${snapshotName}.png`);
+		return path.join(this.testDir, this.config.diffDir, `${sanitizeName(snapshotName)}.png`);
 	}
 	/** Update failing snapshots (only in "all" mode with vitest -u) */
 	shouldUpdate() {
@@ -123,6 +125,10 @@ var ImageSnapshotManager = class {
 		await fs.promises.writeFile(filepath, buffer);
 	}
 };
+/** Replace chars that are invalid in Windows filenames. */
+function sanitizeName(input) {
+	return input.replace(replaceableChars, "_").replace(unreplaceableChars, "").trim();
+}
 //#endregion
 //#region src/ImageSnapshotMatcher.ts
 /** Register toMatchImage() matcher with Vitest */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-image-snapshot",
-  "version": "0.6.48",
+  "version": "0.6.50",
   "type": "module",
   "files": [
     "dist",

package/src/SnapshotManager.ts

@@ -1,6 +1,9 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 
+const replaceableChars = /[<>:"/\\|?*]/g;
+const unreplaceableChars = /\p{Control}+/gu;
+
 export interface SnapshotConfig {
   snapshotDir?: string;
   diffDir?: string;
@@ -29,7 +32,7 @@ export class ImageSnapshotManager {
     return path.join(
       this.testDir,
       this.config.snapshotDir,
-      `${snapshotName}.png`,
+      `${sanitizeName(snapshotName)}.png`,
     );
   }
 
@@ -37,12 +40,16 @@ export class ImageSnapshotManager {
     return path.join(
       this.testDir,
       this.config.actualDir,
-      `${snapshotName}.png`,
+      `${sanitizeName(snapshotName)}.png`,
     );
   }
 
   diffPath(snapshotName: string): string {
-    return path.join(this.testDir, this.config.diffDir, `${snapshotName}.png`);
+    return path.join(
+      this.testDir,
+      this.config.diffDir,
+      `${sanitizeName(snapshotName)}.png`,
+    );
   }
 
   /** Update failing snapshots (only in "all" mode with vitest -u) */
@@ -88,3 +95,11 @@ export class ImageSnapshotManager {
     await fs.promises.writeFile(filepath, buffer);
   }
 }
+
+/** Replace chars that are invalid in Windows filenames. */
+function sanitizeName(input: string): string {
+  return input
+    .replace(replaceableChars, "_")
+    .replace(unreplaceableChars, "")
+    .trim();
+}

package/src/test/SnapshotManager.test.ts

@@ -17,6 +17,30 @@ test("generates correct file paths", () => {
   );
 });
 
+test("sanitizes invalid filename characters", () => {
+  const manager = new ImageSnapshotManager(path.join("/path/to/test.ts"));
+  const snap = (name: string) => manager.referencePath(name);
+  const snapDir = path.join("/path/to", "__image_snapshots__");
+
+  // filesystem-invalid chars replaced with underscores
+  expect(snap("Category > test")).toBe(
+    path.join(snapDir, "Category _ test.png"),
+  );
+  expect(snap('a<>:"/\\|?*b')).toBe(path.join(snapDir, "a_________b.png"));
+
+  // control chars removed, outer whitespace trimmed
+  expect(snap("word1\x02word2")).toBe(path.join(snapDir, "word1word2.png"));
+  expect(snap(" spaced ")).toBe(path.join(snapDir, "spaced.png"));
+
+  // sanitization applied to all path types
+  expect(manager.actualPath("a > b")).toBe(
+    path.join("/path/to", "__image_actual__", "a _ b.png"),
+  );
+  expect(manager.diffPath("a > b")).toBe(
+    path.join("/path/to", "__image_diffs__", "a _ b.png"),
+  );
+});
+
 test("supports custom directory names", () => {
   const testPath = path.join("/path/to/test.ts");
   const manager = new ImageSnapshotManager(testPath, {