@vizzly-testing/honeydiff 0.10.3 → 0.11.1
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.
- package/CHANGELOG.md +36 -16
- package/README.md +182 -689
- package/assets/honeydiff-mascot-diff-drizzle.png +0 -0
- package/examples/color-blindness.js +18 -18
- package/examples/wcag.js +17 -17
- package/index.d.ts +59 -56
- package/index.js +1 -1
- package/package.json +2 -1
- package/platforms/index-aarch64-apple-darwin.node +0 -0
- package/platforms/index-aarch64-unknown-linux-gnu.node +0 -0
- package/platforms/index-x86_64-pc-windows-msvc.node +0 -0
- package/platforms/index-x86_64-unknown-linux-gnu.node +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,39 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.11.1] - 2026-06-20
|
|
11
|
+
|
|
12
|
+
## What's Changed
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
- Recovered hot-path performance after the 0.11.0 metric correctness update:
|
|
16
|
+
- Anti-aliasing now gathers sibling and edge context in one neighbor pass and skips Delta E work for exact RGB neighbor matches.
|
|
17
|
+
- Exact/no-AA count-only comparisons scan raw RGB rows directly.
|
|
18
|
+
- SSIM keeps the Gaussian-weighted 0.11 semantics while using a separable blur path for larger images and a direct small-image path where allocation overhead would dominate.
|
|
19
|
+
- Local Criterion runs on Apple Silicon now show the tall screenshot fixture faster than 0.10.3 (`~192ms` default and `~4.1ms` exact/no-AA), while synthetic full-surface gradient stress cases remain slower because stricter AA checks do more work.
|
|
20
|
+
- Documented the real benchmark tradeoff for the 0.11 metric changes instead of leaving the release note at “metric values can change.”
|
|
21
|
+
|
|
22
|
+
**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.11.0...v0.11.1
|
|
23
|
+
|
|
24
|
+
## [0.11.0] - 2026-06-20
|
|
25
|
+
|
|
26
|
+
## What's Changed
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
- SSIM, MS-SSIM, GMSD, and color vision deficiency simulation now align with the studies and standards cited in the docs. Metric values can change as a result.
|
|
30
|
+
- Screenshot contrast analysis is described as screening, and the default reports every detected WCAG color-pair failure unless callers opt into a max-contrast filter.
|
|
31
|
+
- Variable-height comparisons report GMSD for the overlapping image region.
|
|
32
|
+
|
|
33
|
+
### Fixed
|
|
34
|
+
- Anti-aliasing detection no longer hides flat full-surface color regressions.
|
|
35
|
+
- Variable-height comparisons keep a height-difference cluster visible even when `maxDiffs` caps the reported output below `minClusterSize`.
|
|
36
|
+
- `clusterMerge.maxHeightRatio` and `clusterMerge.maxWidthRatio` now reject `0`, while `maxContrastThreshold: 0` remains valid.
|
|
37
|
+
- Release packaging keeps npm assets included with the published package.
|
|
38
|
+
|
|
39
|
+
**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.10.3...v0.11.0
|
|
40
|
+
|
|
8
41
|
## [0.10.3] - 2026-05-19
|
|
9
42
|
|
|
10
43
|
## What's Changed
|
|
@@ -45,7 +78,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
45
78
|
- Returns `gmsdScore` in results (0.0 = identical, higher = more different)
|
|
46
79
|
- Very fast compared to SSIM, ideal for detecting border/outline changes
|
|
47
80
|
- Based on Xue et al. 2014 research paper
|
|
48
|
-
- **Note:**
|
|
81
|
+
- **Note:** In v0.10.0, GMSD required identical dimensions. Current releases calculate `gmsdScore` on the overlapping region for variable-height comparisons.
|
|
49
82
|
- **Cluster Merging** - New `clusterMerge` option to consolidate fragmented text regions
|
|
50
83
|
- Simple API: `clusterMerge: true` enables with sensible defaults
|
|
51
84
|
- Advanced API: Pass an object with `horizontalDistance`, `yBandTolerance`, `maxHeightRatio`, `maxWidthRatio`
|
|
@@ -54,19 +87,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
54
87
|
|
|
55
88
|
**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.9.0...v0.10.0
|
|
56
89
|
|
|
57
|
-
## [Unreleased]
|
|
58
|
-
|
|
59
|
-
### Added
|
|
60
|
-
- **GMSD (Gradient Magnitude Similarity Deviation)** - New `includeGMSD` option for fast, edge-sensitive perceptual comparison
|
|
61
|
-
- Returns `gmsdScore` in results (0.0 = identical, higher = more different)
|
|
62
|
-
- Very fast compared to SSIM, ideal for detecting border/outline changes
|
|
63
|
-
- Based on Xue et al. 2014 research paper
|
|
64
|
-
- **Cluster Merging** - New `clusterMerge` option to consolidate fragmented text regions
|
|
65
|
-
- Simple API: `clusterMerge: true` enables with sensible defaults
|
|
66
|
-
- Advanced API: Pass an object with `horizontalDistance`, `yBandTolerance`, `maxHeightRatio`, `maxWidthRatio`
|
|
67
|
-
- Solves the "59 clusters for one date string" problem
|
|
68
|
-
- Uses SWT-inspired heuristics (Epshtein et al. 2010)
|
|
69
|
-
|
|
70
90
|
## [0.9.0] - 2026-01-26
|
|
71
91
|
|
|
72
92
|
## What's Changed
|
|
@@ -249,8 +269,8 @@ const result = await compare('baseline.png', 'current.png', {
|
|
|
249
269
|
## [0.3.0] - 2025-11-15
|
|
250
270
|
|
|
251
271
|
### Added
|
|
252
|
-
-
|
|
253
|
-
- `analyzeWcagContrast` / `analyzeWcagContrastSync` -
|
|
272
|
+
- Screenshot contrast screening API using WCAG color-pair math
|
|
273
|
+
- `analyzeWcagContrast` / `analyzeWcagContrastSync` - Screen images for detected contrast warnings
|
|
254
274
|
- `saveWcagOverlay` / `saveWcagOverlaySync` - Generate visual overlays highlighting contrast issues
|
|
255
275
|
|
|
256
276
|
**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.2.1...v0.3.0
|