bun-match-svg 0.0.6 → 0.0.8

package/README.md

@@ -2,6 +2,26 @@
 
 A custom matcher for Bun tests to compare SVG snapshots.
 
+## Quick Start
+
+The fastest way to get started is to use the CLI to initialize your project:
+
+```bash
+bunx bun-match-svg init
+```
+
+This will:
+1. Create an example test in `tests/svg.test.ts`
+2. Set up automatic preloading by creating:
+   - `tests/fixtures/preload.ts`
+   - `bunfig.toml`
+
+You can then run the example test:
+
+```bash
+bun test
+```
+
 ## Installation
 
 ```bash

package/cli.ts

@@ -0,0 +1,71 @@
+#!/usr/bin/env bun
+
+import { mkdir, writeFile } from "node:fs/promises"
+import { spawn } from "node:child_process"
+
+const EXAMPLE_TEST = `import { expect, test } from "bun:test"                                                             
+ import "bun-match-svg"                                                                                                    
+                                                                                                                           
+ const testSvg = \`<svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">                                       
+   <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" />                                            
+ </svg>\`                                                                                                                  
+                                                                                                                           
+ test("svg snapshot example", async () => {                                                                                
+   // First run will create the snapshot                                                                                   
+   // Subsequent runs will compare against the saved snapshot                                                              
+   await expect(testSvg).toMatchSvgSnapshot(import.meta.path, "example")                                                   
+ })                                                                                                                        
+ `     
+
+const PRELOAD_FILE = `import "bun-match-svg"`
+
+const BUNFIG = `[test]
+preload = ["./tests/fixtures/preload.ts"]`
+
+async function installDependency() {
+  return new Promise((resolve, reject) => {
+    const install = spawn('bun', ['add', '-d', 'bun-match-svg'], {
+      stdio: 'inherit'
+    })
+
+    install.on('close', (code) => {
+      if (code === 0) {
+        resolve(undefined)
+      } else {
+        reject(new Error(`Installation failed with code ${code}`))
+      }
+    })
+  })
+}
+
+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")
+    console.log("\n🎉 You can now run: bun test")
+  } catch (error) {
+    console.error("❌ Error during initialization:", error)
+    process.exit(1)
+  }
+}
+
+const command = process.argv[2]
+
+if (command === "init") {
+  init().catch(console.error)
+} else {
+  console.log("Usage: bunx bun-match-svg init")
+}

package/index.ts

@@ -25,7 +25,7 @@ async function toMatchSvgSnapshot(
   const updateSnapshot =
     process.argv.includes("--update-snapshots") ||
     process.argv.includes("-u") ||
-    Boolean(process.env.BUN_UPDATE_SNAPSHOTS)
+    Boolean(process.env["BUN_UPDATE_SNAPSHOTS"])
 
   if (!fs.existsSync(filePath) || updateSnapshot) {
     console.log("Writing snapshot to", filePath)
@@ -38,7 +38,7 @@ async function toMatchSvgSnapshot(
 
   const existingSnapshot = fs.readFileSync(filePath, "utf-8")
 
-  const result = await looksSame(
+  const result: any = await looksSame(
     Buffer.from(received),
     Buffer.from(existingSnapshot),
     {
@@ -75,8 +75,8 @@ async function toMatchMultipleSvgSnapshots(
   testPathOriginal: string,
   svgNames: string[],
 ): Promise<MatcherResult> {
-  const passed = []
-  const failed = []
+  const passed: any[] = []
+  const failed: any[] = []
   for (let index = 0; index < svgNames.length; index++) {
     const svgName = svgNames[index]
     const received = await receivedMaybePromise
@@ -94,7 +94,7 @@ async function toMatchMultipleSvgSnapshots(
     const updateSnapshot =
       process.argv.includes("--update-snapshots") ||
       process.argv.includes("-u") ||
-      Boolean(process.env.BUN_UPDATE_SNAPSHOTS)
+      Boolean(process.env["BUN_UPDATE_SNAPSHOTS"])
 
     if (!fs.existsSync(filePath) || updateSnapshot) {
       console.log("Writing snapshot to", filePath)
@@ -108,7 +108,7 @@ async function toMatchMultipleSvgSnapshots(
 
     const existingSnapshot = fs.readFileSync(filePath, "utf-8")
 
-    const result = await looksSame(
+    const result: any = await looksSame(
       Buffer.from(received[index] as any),
       Buffer.from(existingSnapshot),
       {

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "bun-match-svg",
   "module": "index.ts",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "type": "module",
+  "bin": {
+    "bun-match-svg": "./cli.ts"
+  },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/bun": "latest",
+    "biome": "^0.3.3"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
@@ -14,6 +18,8 @@
   },
   "scripts": {
     "test": "bun test",
-    "build": "echo 'no build step'"
+    "build": "echo 'no build step'",
+    "format": "biome format . --write",
+    "format:check": "biome format ."
   }
 }

package/tsconfig.json

@@ -13,6 +13,16 @@
     "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,
     "noEmit": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "useUnknownInCatchVariables": true,
+    "alwaysStrict": true,
+    "exactOptionalPropertyTypes": false,
+    "noImplicitReturns": true,
 
     // Best practices
     "strict": true,
@@ -22,6 +32,6 @@
     // Some stricter flags (disabled by default)
     "noUnusedLocals": false,
     "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
+    "noPropertyAccessFromIndexSignature": true
   }
 }