styleproof 1.9.3 → 1.9.4
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 +21 -16
- package/README.md +7 -7
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,14 +7,19 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [1.9.4]
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- Repository URLs now use the canonical `BenSheridanEdwards/StyleProof` casing
|
|
15
|
+
everywhere — README badges, Action references, and doc links, plus the CHANGELOG
|
|
16
|
+
compare links, CONTRIBUTING, SECURITY, `action.yml`, and the release workflow.
|
|
17
|
+
(npm package-name URLs stay lowercase, as npm requires.)
|
|
18
|
+
|
|
10
19
|
## [1.9.3]
|
|
11
20
|
|
|
12
21
|
### Changed
|
|
13
22
|
|
|
14
|
-
- Maintainer contact moved off a personal email address: security issues now go
|
|
15
|
-
through GitHub's private vulnerability reporting and conduct reports through the
|
|
16
|
-
maintainer's GitHub profile, and the `package.json` `author` no longer carries an
|
|
17
|
-
email. The published package and its metadata are now contact-clean.
|
|
18
23
|
- Canonical `StyleProof`-cased GitHub URLs in `package.json` (`homepage`,
|
|
19
24
|
`repository`, `bugs`).
|
|
20
25
|
|
|
@@ -503,15 +508,15 @@ number)`), so each viewport band can capture at its own height. Default remains
|
|
|
503
508
|
- `styleproof-diff` CLI: certifies a refactor (exit 0) or names the exact element,
|
|
504
509
|
property, and state that drifted (exit 1).
|
|
505
510
|
|
|
506
|
-
[Unreleased]: https://github.com/BenSheridanEdwards/
|
|
507
|
-
[1.2.0]: https://github.com/BenSheridanEdwards/
|
|
508
|
-
[1.1.0]: https://github.com/BenSheridanEdwards/
|
|
509
|
-
[1.0.0]: https://github.com/BenSheridanEdwards/
|
|
510
|
-
[0.7.0]: https://github.com/BenSheridanEdwards/
|
|
511
|
-
[0.6.0]: https://github.com/BenSheridanEdwards/
|
|
512
|
-
[0.5.0]: https://github.com/BenSheridanEdwards/
|
|
513
|
-
[0.4.0]: https://github.com/BenSheridanEdwards/
|
|
514
|
-
[0.3.0]: https://github.com/BenSheridanEdwards/
|
|
515
|
-
[0.2.1]: https://github.com/BenSheridanEdwards/
|
|
516
|
-
[0.2.0]: https://github.com/BenSheridanEdwards/
|
|
517
|
-
[0.1.0]: https://github.com/BenSheridanEdwards/
|
|
511
|
+
[Unreleased]: https://github.com/BenSheridanEdwards/StyleProof/compare/v1.2.0...HEAD
|
|
512
|
+
[1.2.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v1.1.0...v1.2.0
|
|
513
|
+
[1.1.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v1.0.0...v1.1.0
|
|
514
|
+
[1.0.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.7.0...v1.0.0
|
|
515
|
+
[0.7.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.6.0...v0.7.0
|
|
516
|
+
[0.6.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.5.0...v0.6.0
|
|
517
|
+
[0.5.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.4.0...v0.5.0
|
|
518
|
+
[0.4.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.3.0...v0.4.0
|
|
519
|
+
[0.3.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.2.1...v0.3.0
|
|
520
|
+
[0.2.1]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.2.0...v0.2.1
|
|
521
|
+
[0.2.0]: https://github.com/BenSheridanEdwards/StyleProof/compare/v0.1.0...v0.2.0
|
|
522
|
+
[0.1.0]: https://github.com/BenSheridanEdwards/StyleProof/releases/tag/v0.1.0
|
package/README.md
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
**Know exactly what every PR changes visually, and sign it off.** StyleProof captures the browser's _computed_ styles (not pixels), diffs your PR's HEAD against its base branch, and posts a per-change report on the PR, so a styling change never ships without someone confirming it was intended.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/styleproof)
|
|
6
|
-
[](https://github.com/BenSheridanEdwards/
|
|
6
|
+
[](https://github.com/BenSheridanEdwards/StyleProof/actions)
|
|
7
|
+
[](https://github.com/BenSheridanEdwards/StyleProof/blob/main/LICENSE)
|
|
8
8
|
|
|
9
9
|
## Why
|
|
10
10
|
|
|
@@ -111,14 +111,14 @@ jobs:
|
|
|
111
111
|
- run: STYLEMAP_DIR=head STYLEPROOF_REPLAY_FROM=__stylemaps__/base npx playwright test e2e/styleproof.spec.ts
|
|
112
112
|
|
|
113
113
|
# report + gate
|
|
114
|
-
- uses: BenSheridanEdwards/
|
|
114
|
+
- uses: BenSheridanEdwards/StyleProof@v1
|
|
115
115
|
with:
|
|
116
116
|
baseline-dir: base
|
|
117
117
|
fresh-dir: head
|
|
118
118
|
require-approval: true # review-gate mode (omit / use fail-on-diff: true to certify)
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
**3. Copy [`example/styleproof-approve.yml`](https://github.com/BenSheridanEdwards/
|
|
121
|
+
**3. Copy [`example/styleproof-approve.yml`](https://github.com/BenSheridanEdwards/StyleProof/blob/main/example/styleproof-approve.yml) to `.github/workflows/` on your default branch** — GitHub only runs `issue_comment` workflows from there, so the checkboxes do nothing until it's merged.
|
|
122
122
|
|
|
123
123
|
**4. Require the `StyleProof` status** in branch protection. Now an unsigned visual change can't merge.
|
|
124
124
|
|
|
@@ -135,7 +135,7 @@ jobs:
|
|
|
135
135
|
|
|
136
136
|
## Reference
|
|
137
137
|
|
|
138
|
-
**Action `BenSheridanEdwards/
|
|
138
|
+
**Action `BenSheridanEdwards/StyleProof@v1`** — key inputs:
|
|
139
139
|
|
|
140
140
|
| Input | Default | Purpose |
|
|
141
141
|
| ------------------ | ------------ | -------------------------------------------------------------------------- |
|
|
@@ -145,7 +145,7 @@ jobs:
|
|
|
145
145
|
| `fail-on-diff` | `true` | Certify mode: fail on any diff. Ignored when `require-approval` is true. |
|
|
146
146
|
| `status-context` | `StyleProof` | Commit-status name. Must match the approve workflow and branch protection. |
|
|
147
147
|
|
|
148
|
-
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/
|
|
148
|
+
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).
|
|
149
149
|
|
|
150
150
|
**Capture spec `defineStyleMapCapture({ surfaces, … })`** — determinism is on by default; you rarely set more than `surfaces` and `dir`:
|
|
151
151
|
|
|
@@ -178,7 +178,7 @@ Non-visual and framework-injected elements (`<meta>`/`<title>`/`<script>`/`<styl
|
|
|
178
178
|
- `styleproof-diff <beforeDir> <afterDir>` — the certify gate; exits `1` on any difference.
|
|
179
179
|
- `styleproof-report <beforeDir> <afterDir> --out <dir>` — render the diff to a Markdown report with before/after crops.
|
|
180
180
|
|
|
181
|
-
A programmatic API (`captureStyleMap`, `diffStyleMaps`, `generateStyleMapReport`, …) is also exported. For the capture internals, the approve-workflow trust model, and how to contribute, see [CONTRIBUTING](https://github.com/BenSheridanEdwards/
|
|
181
|
+
A programmatic API (`captureStyleMap`, `diffStyleMaps`, `generateStyleMapReport`, …) is also exported. For the capture internals, the approve-workflow trust model, and how to contribute, see [CONTRIBUTING](https://github.com/BenSheridanEdwards/StyleProof/blob/main/CONTRIBUTING.md) and the [`example/`](https://github.com/BenSheridanEdwards/StyleProof/tree/main/example) workflows.
|
|
182
182
|
|
|
183
183
|
## License
|
|
184
184
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "styleproof",
|
|
3
|
-
"version": "1.9.
|
|
3
|
+
"version": "1.9.4",
|
|
4
4
|
"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.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"playwright",
|