fix: sanitize screenshot filenames

Signed-off-by: Jakub Freisler <[email protected]>

Author: FRSgit

package.json

@@ -44,6 +44,7 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "microbundle": "^0.14.1",
     "prettier": "^2.4.1",
+    "sanitize-filename": "^1.6.3",
     "semantic-release": "^18.0.0",
     "typescript": "^4.4.4"
   },

src/plugins.ts

@@ -5,6 +5,7 @@ import { PNG, PNGWithMetadata } from "pngjs";
 import { FILE_SUFFIX, IMAGE_SNAPSHOT_PREFIX, TASK } from "./constants";
 import moveFile from "move-file";
 import sharp from "sharp";
+import sanitize from "sanitize-filename";
 
 type NotFalsy<T> = T extends false | null | undefined ? never : T;
 
@@ -103,7 +104,7 @@ export const initPlugin = (
         IMAGE_SNAPSHOT_PREFIX,
         path.dirname(specPath),
         ...imagesDir.split("/"),
-        `${title}${FILE_SUFFIX.actual}.png`
+        `${sanitize(title)}${FILE_SUFFIX.actual}.png`
       );
     },
     [TASK.doesFileExist]({ path }) {

yarn.lock

@@ -1444,6 +1444,7 @@ __metadata:
     pixelmatch: ^5.2.1
     pngjs: ^6.0.0
     prettier: ^2.4.1
+    sanitize-filename: ^1.6.3
     semantic-release: ^18.0.0
     sharp: ^0.30.1
     typescript: ^4.4.4
@@ -8662,6 +8663,15 @@ [email protected]:
   languageName: node
   linkType: hard
 
+"sanitize-filename@npm:^1.6.3":
+  version: 1.6.3
+  resolution: "sanitize-filename@npm:1.6.3"
+  dependencies:
+    truncate-utf8-bytes: ^1.0.0
+  checksum: aa733c012b7823cf65730603cf3b503c641cee6b239771d3164ca482f22d81a50e434a713938d994071db18e4202625669cc56bccc9d13d818b4c983b5f47fde
+  languageName: node
+  linkType: hard
+
 "semantic-release@npm:18.0.1, semantic-release@npm:^18.0.0":
   version: 18.0.1
   resolution: "semantic-release@npm:18.0.1"
@@ -9535,6 +9545,15 @@ [email protected]:
   languageName: node
   linkType: hard
 
+"truncate-utf8-bytes@npm:^1.0.0":
+  version: 1.0.2
+  resolution: "truncate-utf8-bytes@npm:1.0.2"
+  dependencies:
+    utf8-byte-length: ^1.0.1
+  checksum: ad097314709ea98444ad9c80c03aac8da805b894f37ceb5685c49ad297483afe3a5ec9572ebcaff699dda72b6cd447a2ba2a3fd10e96c2628cd16d94abeb328a
+  languageName: node
+  linkType: hard
+
 "tslib@npm:2.0.1":
   version: 2.0.1
   resolution: "tslib@npm:2.0.1"
@@ -9803,6 +9822,13 @@ [email protected]:
   languageName: node
   linkType: hard
 
+"utf8-byte-length@npm:^1.0.1":
+  version: 1.0.4
+  resolution: "utf8-byte-length@npm:1.0.4"
+  checksum: f188ca076ec094d58e7009fcc32623c5830c7f0f3e15802bfa4fdd1e759454a481fc4ac05e0fa83b7736e77af628a9ee0e57dcc89683d688fde3811473e42143
+  languageName: node
+  linkType: hard
+
 "util-deprecate@npm:^1.0.1, util-deprecate@npm:^1.0.2, util-deprecate@npm:~1.0.1":
   version: 1.0.2
   resolution: "util-deprecate@npm:1.0.2"