bun-match-svg 0.0.9 → 0.0.11

package/README.md

@@ -1,6 +1,15 @@
 # bun-match-svg
 
-A custom matcher for Bun tests to compare SVG snapshots.
+A custom matcher for Bun tests to compare SVG snapshots. Great for GitHub visual snapshot testing.
+
+```ts
+test("your SVG test", () => {
+  const svgContent = generateSomeSvg() // Your function to generate SVG
+  expect(svgContent).toMatchSvgSnapshot(import.meta.path, "uniqueName")
+})
+```
+
+![Github Visual Snapshot](https://github.com/user-attachments/assets/35dd7ee1-3e30-4401-827d-469561885375)
 
 ## Quick Start
 

package/cli.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env bun
 
-import { mkdir, writeFile } from "node:fs/promises"
+import { mkdir, writeFile, access } from "node:fs/promises"
 import { spawn } from "node:child_process"
 
 const EXAMPLE_TEST = `import { expect, test } from "bun:test"                                                             
@@ -37,23 +37,43 @@ async function installDependency() {
   })
 }
 
+async function fileExists(path: string): Promise<boolean> {
+  try {
+    await access(path)
+    return true
+  } catch {
+    return false
+  }
+}
+
 async function init() {
   try {
     console.log("📦 Installing bun-match-svg...")
     await installDependency()
     
     await mkdir("tests/fixtures", { recursive: true })
-    
-    await writeFile("tests/svg.test.ts", EXAMPLE_TEST)
-    
-    await writeFile("tests/fixtures/preload.ts", PRELOAD_FILE)
-    
-    await writeFile("bunfig.toml", BUNFIG)
-    
-    console.log("✅ Installed bun-match-svg")
-    console.log("✅ Created example test in tests/svg.test.ts")
-    console.log("✅ Created preload file in tests/fixtures/preload.ts")
-    console.log("✅ Created bunfig.toml")
+
+    if (!await fileExists("tests/svg.test.ts")) {
+      await writeFile("tests/svg.test.ts", EXAMPLE_TEST)
+      console.log("✅ Created example test in tests/svg.test.ts")
+    } else {
+      console.log("🔒 tests/svg.test.ts already exists, skipping.")
+    }
+
+    if (!await fileExists("tests/fixtures/preload.ts")) {
+      await writeFile("tests/fixtures/preload.ts", PRELOAD_FILE)
+      console.log("✅ Created preload file in tests/fixtures/preload.ts")
+    } else {
+      console.log("🔒 tests/fixtures/preload.ts already exists, skipping.")
+    }
+
+    if (!await fileExists("bunfig.toml")) {
+      await writeFile("bunfig.toml", BUNFIG)
+      console.log("✅ Created bunfig.toml")
+    } else {
+      console.log("🔒 bunfig.toml already exists, skipping.")
+    }
+
     console.log("\n🎉 You can now run: bun test")
   } catch (error) {
     console.error("❌ Error during initialization:", error)

package/index.ts

@@ -28,10 +28,14 @@ async function toMatchSvgSnapshot(
     Boolean(process.env["BUN_UPDATE_SNAPSHOTS"])
 
   if (!fs.existsSync(filePath) || updateSnapshot) {
-    console.log("Writing snapshot to", filePath)
+    if (updateSnapshot && fs.existsSync(filePath)) {
+      console.log("Updating snapshot at", filePath)
+    } else {
+      console.log("Writing snapshot to", filePath)
+    }
     fs.writeFileSync(filePath, received)
     return {
-      message: () => `Snapshot created at ${filePath}`,
+      message: () => `Snapshot ${updateSnapshot ? 'updated' : 'created'} at ${filePath}`,
       pass: true,
     }
   }
@@ -97,10 +101,14 @@ async function toMatchMultipleSvgSnapshots(
       Boolean(process.env["BUN_UPDATE_SNAPSHOTS"])
 
     if (!fs.existsSync(filePath) || updateSnapshot) {
-      console.log("Writing snapshot to", filePath)
+      if (updateSnapshot && fs.existsSync(filePath)) {
+        console.log("Updating snapshot at", filePath)
+      } else {
+        console.log("Writing snapshot to", filePath)
+      }
       fs.writeFileSync(filePath, received[index] as any)
       passed.push({
-        message: `Snapshot ${svgName} created at ${filePath}`,
+        message: `Snapshot ${svgName} ${updateSnapshot ? 'updated' : 'created'} at ${filePath}`,
         pass: true,
       })
       continue

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-match-svg",
   "module": "index.ts",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "type": "module",
   "bin": {
     "bun-match-svg": "./cli.ts"