bun-match-svg 0.0.10 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,15 @@
1
1
  # bun-match-svg
2
2
 
3
- A custom matcher for Bun tests to compare SVG snapshots.
3
+ A custom matcher for Bun tests to compare SVG snapshots. Great for GitHub visual snapshot testing.
4
+
5
+ ```ts
6
+ test("your SVG test", () => {
7
+ const svgContent = generateSomeSvg() // Your function to generate SVG
8
+ expect(svgContent).toMatchSvgSnapshot(import.meta.path, "uniqueName")
9
+ })
10
+ ```
11
+
12
+ ![Github Visual Snapshot](https://github.com/user-attachments/assets/35dd7ee1-3e30-4401-827d-469561885375)
4
13
 
5
14
  ## Quick Start
6
15
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bun-match-svg",
3
3
  "module": "index.ts",
4
- "version": "0.0.10",
4
+ "version": "0.0.11",
5
5
  "type": "module",
6
6
  "bin": {
7
7
  "bun-match-svg": "./cli.ts"