@blazediff/vitest 1.1.10 → 1.1.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 +20 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -117,6 +117,12 @@ Vitest matcher for image snapshot comparison.
117
117
  <td>true</td>
118
118
  <td>Run comparison in worker thread for better performance</td>
119
119
  </tr>
120
+ <tr>
121
+ <td><code>outputFormat</code></td>
122
+ <td>'png' | 'html'</td>
123
+ <td>'png'</td>
124
+ <td>Diff output format (<code>core-native</code> only). Use <code>'html'</code> for an interactive interpret report with detected change regions, classification, and severity</td>
125
+ </tr>
120
126
  </table>
121
127
 
122
128
  See [@blazediff/matcher](https://www.npmjs.com/package/@blazediff/matcher) for full options documentation.
@@ -184,6 +190,20 @@ await expect(screenshot).toMatchImageSnapshot({
184
190
  });
185
191
  ```
186
192
 
193
+ ### HTML Interpret Report
194
+
195
+ When using `core-native`, set `outputFormat: 'html'` to generate an interactive HTML report on failure instead of a plain diff image. The report includes detected change regions with classification, severity, and spatial analysis.
196
+
197
+ ```typescript
198
+ await expect('/path/to/image.png').toMatchImageSnapshot({
199
+ method: 'core-native',
200
+ outputFormat: 'html',
201
+ });
202
+
203
+ // On failure, the diff file will be .html instead of .png
204
+ // e.g., __snapshots__/test-name.diff.html
205
+ ```
206
+
187
207
  ### Custom Thresholds
188
208
 
189
209
  ```typescript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blazediff/vitest",
3
- "version": "1.1.10",
3
+ "version": "1.1.11",
4
4
  "description": "Vitest matcher for visual regression testing with blazediff",
5
5
  "private": false,
6
6
  "publishConfig": {
@@ -33,7 +33,7 @@
33
33
  "homepage": "https://blazediff.dev",
34
34
  "license": "MIT",
35
35
  "dependencies": {
36
- "@blazediff/matcher": "1.4.0"
36
+ "@blazediff/matcher": "1.4.1"
37
37
  },
38
38
  "devDependencies": {
39
39
  "@types/node": "^24.3.0",