styleproof 1.9.1 → 1.9.3

package/CHANGELOG.md

@@ -7,6 +7,23 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [1.9.3]
+
+### Changed
+
+- Maintainer contact moved off a personal email address: security issues now go
+  through GitHub's private vulnerability reporting and conduct reports through the
+  maintainer's GitHub profile, and the `package.json` `author` no longer carries an
+  email. The published package and its metadata are now contact-clean.
+- Canonical `StyleProof`-cased GitHub URLs in `package.json` (`homepage`,
+  `repository`, `bugs`).
+
+### Fixed
+
+- The README demo image now uses an absolute `raw.githubusercontent.com` URL so it
+  renders on the npm package page — relative paths don't resolve there, so the image
+  showed broken on npmjs.com.
+
 ## [1.9.1]
 
 ### Fixed

package/README.md

@@ -23,7 +23,7 @@ On every PR, StyleProof captures a `StyleMap` from the HEAD and from the base br
 
 One change — the hero CTA recoloured cyan → amber — posts as a single section: a side-by-side before/after cropped screenshot, a one-line summary, then the exact property change folded under a toggle.
 
-![A StyleProof report: the CTA button before (cyan) and after (amber), side by side](docs/demo-composite.png)
+![A StyleProof report: the CTA button before (cyan) and after (amber), side by side](https://raw.githubusercontent.com/BenSheridanEdwards/StyleProof/main/docs/demo-composite.png)
 
 As it renders in the PR comment (a plain-English bullet first — naming the theme token and showing the hex with a live colour swatch — then the exact table inside the toggle):
 
@@ -147,6 +147,31 @@ jobs:
 
 Outputs: `changed` (`"true"` when anything changed), `report-url`. Other inputs (`report-branch`, `inline-images`, `github-token`) have sensible defaults — see [`action.yml`](https://github.com/BenSheridanEdwards/styleproof/blob/main/action.yml).
 
+**Capture spec `defineStyleMapCapture({ surfaces, … })`** — determinism is on by default; you rarely set more than `surfaces` and `dir`:
+
+| Option        | Default                     | Purpose                                                                                                          |
+| ------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `surfaces`    | _required_                  | Page states to certify — each `{ key, go, widths, ignore?, height? }`. `go(page)` drives to a settled state.     |
+| `dir`         | `STYLEMAP_DIR`              | Output label (`base`/`head`); the spec is **inert until set**, so it sits safely beside your other specs.        |
+| `replayFrom`  | `STYLEPROOF_REPLAY_FROM`    | Baseline dir whose recorded responses to replay. Unset → this run **records** its HAR for the comparison to use. |
+| `replayUrl`   | `**/api/**` (`…REPLAY_URL`) | URL glob for the data boundary to record/replay; everything else (JS/CSS/fonts) loads live so the code runs.     |
+| `freezeClock` | `true`                      | Pin `Date.now()`/`new Date()` so time-derived styling can't drift; timers keep running so settling still works.  |
+| `clockTime`   | `2025-01-01T00:00:00Z`      | The frozen instant.                                                                                              |
+| `selfCheck`   | `STYLEPROOF_SELFCHECK=1`    | Capture each surface twice and fail on any difference — proves the capture is deterministic.                     |
+| `screenshots` | `true`                      | Save full-page screenshots for the report's before/after crops.                                                  |
+| `baseDir`     | `__stylemaps__`             | Output root directory.                                                                                           |
+
+Non-visual and framework-injected elements (`<meta>`/`<title>`/`<script>`/`<style>`/… and `next-route-announcer`) are skipped automatically; a surface's `ignore` adds to that default, it doesn't replace it.
+
+**Capture env vars** (wire CI without editing the spec):
+
+| Env                      | Purpose                                                                       |
+| ------------------------ | ----------------------------------------------------------------------------- |
+| `STYLEMAP_DIR`           | Output label; the capture is skipped entirely when unset.                     |
+| `STYLEPROOF_REPLAY_FROM` | Baseline dir to replay recorded data from — set this on the **head** capture. |
+| `STYLEPROOF_REPLAY_URL`  | Override the `**/api/**` data-boundary glob.                                  |
+| `STYLEPROOF_SELFCHECK`   | `1` to capture each surface twice and fail if the two differ.                 |
+
 **CLIs** (every flag accepts `--flag value` and `--flag=value`; `--help` lists all):
 
 - `styleproof-init` — scaffold the capture spec (and a starter `playwright.config.ts` if none exists).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "styleproof",
-  "version": "1.9.1",
+  "version": "1.9.3",
   "description": "Catch every CSS change before it ships — review PRs and certify refactors by the browser's computed styles, not pixels. Works with any styling system.",
   "keywords": [
     "playwright",
@@ -16,14 +16,14 @@
     "ci"
   ],
   "license": "MIT",
-  "author": "Ben Sheridan-Edwards <ben@codewalnut.com>",
-  "homepage": "https://github.com/BenSheridanEdwards/styleproof#readme",
+  "author": "Ben Sheridan-Edwards",
+  "homepage": "https://github.com/BenSheridanEdwards/StyleProof#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/BenSheridanEdwards/styleproof.git"
+    "url": "git+https://github.com/BenSheridanEdwards/StyleProof.git"
   },
   "bugs": {
-    "url": "https://github.com/BenSheridanEdwards/styleproof/issues"
+    "url": "https://github.com/BenSheridanEdwards/StyleProof/issues"
   },
   "type": "module",
   "main": "./dist/index.js",