yam-flow 2.0.0 → 2.2.0
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/AGENTS.md +7 -5
- package/CHANGELOG.md +26 -0
- package/COMMANDS.md +10 -4
- package/DECISIONS.md +3 -0
- package/README.md +17 -9
- package/dist/bin/yam.js +211 -30
- package/dist/lib/trust-kernel.d.ts +31 -1
- package/dist/lib/trust-kernel.js +128 -6
- package/package.json +2 -1
- package/references/final-report.md +17 -11
- package/references/honest-completion.md +13 -0
- package/references/study-note.md +69 -0
- package/references/tool-trust-layer.md +6 -1
- package/references/ueye-proof.md +42 -1
- package/references/ueye.md +29 -3
- package/references/verification-levels.md +130 -25
- package/skills/deep/SKILL.md +10 -2
- package/skills/mission/SKILL.md +10 -1
- package/skills/quick/SKILL.md +6 -2
- package/skills/ueye/SKILL.md +5 -1
- package/src/bin/yam.ts +217 -31
- package/src/lib/trust-kernel.ts +155 -7
- package/templates/yam.project.md +5 -1
- package/yam.manifest.json +6 -3
package/AGENTS.md
CHANGED
|
@@ -8,14 +8,16 @@
|
|
|
8
8
|
6. Check local project fit before changing code, even for small work.
|
|
9
9
|
7. Prefer existing project patterns over new abstractions.
|
|
10
10
|
8. Make the smallest useful change.
|
|
11
|
-
9. Verify at the lightest level that honestly supports the claim, then escalate verification when the claim is larger.
|
|
11
|
+
9. Verify at the lightest level that honestly supports the claim, then escalate verification with the L0-L5 Verification Ladder when the claim, scope, risk, public release, runtime, UI completion, auth, DB, broad refactor, learning value, or user intent is larger.
|
|
12
12
|
10. Report skipped, partial, blocked, or assumed verification plainly.
|
|
13
13
|
11. Do not run broad tests for tiny changes, but do not under-verify risky, security-sensitive, or public work.
|
|
14
14
|
12. Do not use teams, orchestration, structured proof, or tmux unless risk, user intent, learning value, or an approved route justifies it.
|
|
15
15
|
13. Escalate risky work by asking or recommending, not by silently switching modes.
|
|
16
16
|
14. For UI work, inspect real states and responsive behavior when feasible.
|
|
17
17
|
15. For long-running processes, do not claim cleanup unless process exit is checked.
|
|
18
|
-
16.
|
|
19
|
-
17.
|
|
20
|
-
18.
|
|
21
|
-
19.
|
|
18
|
+
16. When code, config, release metadata, documentation, or project artifacts changed, include a Study Note even if no yam skill was explicitly invoked.
|
|
19
|
+
17. Explain useful change insight for non-specialists: what the touched code or artifact does, what role it has, where it runs or is read, what was wrong or missing, what changed before/after, what behavior is expected, one useful syntax/structure insight, what was verified, and what remains uncertain.
|
|
20
|
+
18. Use external references deliberately, preserve source clarity in research/proof notes, and rework good ideas into yam style.
|
|
21
|
+
19. Treat security as the first project lens: identify sensitive surfaces early and guide safer defaults before convenience.
|
|
22
|
+
20. Keep final reports short and concrete, but always include remaining tasks or state that none are meaningful.
|
|
23
|
+
21. When relevant, include architecture hygiene in the Study Note: avoid dumping unrelated logic into `page.tsx`, one-off component CSS into `global.css`, or structured product data into broad DB `jsonb` blobs when existing project boundaries, scoped styles, typed tables, constraints, or indexes fit better.
|
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to yam-flow are documented here.
|
|
4
4
|
|
|
5
|
+
## v2.2.0 - 2026-07-07
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- Added `yam study-note check` as a read-only Study Note Guard Lite for changed files and supplied final-report text.
|
|
10
|
+
- Added an opt-in `study-note` hook profile via `yam hook enable study-note --global` for prompt-time Study Note reminders without auto-generating or editing reports.
|
|
11
|
+
- Extended `yam loop report --json` with resume-ready handoff fields: touched/read/verified files, skipped checks, stop condition, resume hint, and readiness state.
|
|
12
|
+
- Added Ueye deep visual review fields for acceptance criteria, touched/read/verified files, skipped checks, residual risks, stop condition, resume hint, design-system evidence, implementation evidence, and state matrix.
|
|
13
|
+
|
|
14
|
+
### Improved
|
|
15
|
+
|
|
16
|
+
- Strengthened Study Note v3 guidance for non-developer learning with execution point, before/after behavior, expected behavior, and architecture hygiene checks for `page.tsx`, `global.css`, and DB `jsonb` boundaries.
|
|
17
|
+
- Strengthened Ueye guidance so serious UI work can carry Deep-grade verification inside the Ueye route without requiring a separate Deep route.
|
|
18
|
+
|
|
19
|
+
## v2.1.0 - 2026-06-30
|
|
20
|
+
|
|
21
|
+
### Added
|
|
22
|
+
|
|
23
|
+
- Added `references/study-note.md` with required Study Note guidance for any changed code, config, release metadata, documentation, or project artifact.
|
|
24
|
+
- Reworked `references/verification-levels.md` into an L0-L5 Verification Ladder covering stated, inspected, local check, integrated, release/runtime/visual proof, and bounded deep verification.
|
|
25
|
+
|
|
26
|
+
### Improved
|
|
27
|
+
|
|
28
|
+
- Updated core, final-report, route skill, project-pack, and trust-layer guidance so serious claims can require heavier evidence while bounded stop conditions prevent endless proof loops.
|
|
29
|
+
- Strengthened `$quick`, `$deep`, `$mission`, and `$ueye` final report rules so changed artifacts include code/artifact role, expected behavior, syntax or structure insight, verification note, and uncertainty.
|
|
30
|
+
|
|
5
31
|
## v2.0.0 - 2026-06-24
|
|
6
32
|
|
|
7
33
|
### Added
|
package/COMMANDS.md
CHANGED
|
@@ -45,7 +45,7 @@ Opt-in visual evidence helpers:
|
|
|
45
45
|
yam ueye preflight /path/to/project --json
|
|
46
46
|
yam ueye capture --url http://localhost:3000 --out .yam/screens/home.png
|
|
47
47
|
yam ueye compare --reference ./reference.png --actual .yam/screens/home.png
|
|
48
|
-
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --preflight-id ueye-preflight-123 --p0-risk "mobile CTA may clip" --quality-gate-note "check CTA contrast before done" --brief-dimension "primary CTA clarity" --constraint "mobile first" --review-session-id pricing-card-v1 --provider-context local --execution-surface in-app-browser --browser-surface in-app-browser --similar "overall hierarchy" --different "button glow intensity" --missing "mobile state" --design-quality needs-polish --json
|
|
48
|
+
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --preflight-id ueye-preflight-123 --p0-risk "mobile CTA may clip" --quality-gate-note "check CTA contrast before done" --brief-dimension "primary CTA clarity" --constraint "mobile first" --acceptance-criterion "primary CTA remains visible on mobile" --design-system-evidence "uses existing button token" --implementation-evidence "browser screenshot reviewed" --state-check default:pass --state-check mobile:partial --skipped-check "hover state not checked on touch viewport" --residual-risk "tablet breakpoint still needs visual pass" --stop-condition "stop after primary states are checked and residual risk is recorded" --resume-hint "capture tablet screenshot next" --review-session-id pricing-card-v1 --provider-context local --execution-surface in-app-browser --browser-surface in-app-browser --similar "overall hierarchy" --different "button glow intensity" --missing "mobile state" --design-quality needs-polish --json
|
|
49
49
|
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --completion-claim done --design-quality pass --direction-locked --reference-read --states-checked --mobile-checked --contrast-checked --cta-checked --json
|
|
50
50
|
yam media proof --requested --attempted --output ./generated.png --wait-loop --json
|
|
51
51
|
yam proof --route ueye --truth partial --visual "browser/local screenshot comparison executed" --require-visual
|
|
@@ -148,7 +148,8 @@ yam tools doctor /path/to/project
|
|
|
148
148
|
yam tools doctor /path/to/project --json
|
|
149
149
|
yam context pressure /path/to/project --json
|
|
150
150
|
yam cleanup scan /path/to/project --json
|
|
151
|
-
yam
|
|
151
|
+
yam study-note check /path/to/project --text "Study Note: Touched code role before/after verification limits." --json
|
|
152
|
+
yam loop report --route quick --intent "fix release readiness" --stage "inspect:passed:read release report" --evidence "typecheck passed" --evidence-level local --evidence-stamp "sha256:release-report" --touched-file src/bin/yam.ts --read-file README.md --verified-file scripts/cli-smoke.mjs --skipped-check "npm publish skipped by design" --stop-condition "stop after readiness evidence is recorded" --resume-hint "rerun release report after npm auth refresh" --readiness-state blocked --covered-requirement "release report is read-only" --uncovered-requirement "npm auth verified" --blocked-kind auth_blocked --failure-cause auth_token_invalid --safe-retry "retry after npm whoami succeeds" --recovery-hint "refresh npm auth, then rerun readiness checks" --fix-first-item "npm auth must be verified before publish" --remaining-task "rerun release report after auth refresh" --recommended-direction "fix npm auth first, then publish manually" --implementation-note "keep loop report read-only" --why-this-next "auth blocks public release claims" --blocked-by "npm whoami E401" --owner-route deep --owner-scope "release readiness only" --scope-owner deep --side-effect "no publish attempted" --avoidance-note "do not retry publish before npm auth is proven" --issue-code "src/bin/yam.ts release report" --issue-role "summarizes release readiness without publishing" --issue-symptom "npm auth failure needs clearer next action" --changed-code "yam loop report" --changed-role "records loop evidence and learning note" --change-summary "added a read-only loop artifact" --why-important "it helps users learn what changed without overclaiming verification" --learning-note "fix blockers before claiming done" --json
|
|
152
153
|
yam proof /path/to/project
|
|
153
154
|
yam proof --route deep --truth verified --command "npm run build: pass"
|
|
154
155
|
yam proof --route ueye --truth verified --visual "reference image only"
|
|
@@ -195,12 +196,15 @@ Supported report shapes:
|
|
|
195
196
|
|
|
196
197
|
- Runtime evidence mini: command/process, observation, cleanup, truth status, next action.
|
|
197
198
|
- Patch queue lite: mission lane status, changed files, verification hint, rollback hint, truth status.
|
|
198
|
-
-
|
|
199
|
-
-
|
|
199
|
+
- Verification Ladder: L0 stated, L1 inspected, L2 local check, L3 integrated, L4 release/runtime/visual proof, L5 bounded deep with stop condition and skipped/remaining work.
|
|
200
|
+
- Loop report: intent, guided stage outcomes, touched/read/verified files, skipped checks, stop condition, resume hint, readiness state, evidence level/stamp, blockers, blocker kind, safe retry, next action, fix-first items, remaining tasks, recommended direction, blocked-by notes, owner route/scope, side effects, and study note.
|
|
201
|
+
- Study note: non-specialist explanation of the changed code/artifact, its role, execution point, before/after behavior, expected behavior, one syntax/structure insight, verification, uncertainty, and architecture hygiene around `page.tsx`, `global.css`, and DB `jsonb`.
|
|
202
|
+
- Study Note guard: read-only check for changed files and supplied final-report text; opt into prompt-time reminders with `yam hook enable study-note --global`.
|
|
200
203
|
- Benchmark optimization loop lite: baseline, one change, rerun, keep/revert decision.
|
|
201
204
|
- Structured diagnostic next action: severity, evidence, owner route, next action, truth status.
|
|
202
205
|
- Ueye continuity/comparison: previous report, current report, comparison delta, design quality, next action.
|
|
203
206
|
- Ueye design brief/anti-slop: brief dimensions, constraints, invented metrics, placeholder copy, generic visuals, and custom P0 blockers.
|
|
207
|
+
- Ueye deep visual review: acceptance criteria, touched/read/verified files, skipped checks, residual risks, stop condition, resume hint, design-system evidence, implementation evidence, and state matrix.
|
|
204
208
|
- Context pressure: project pack age/size, memory summary, dirty scope, scripts, instruction surfaces, and route hint.
|
|
205
209
|
- Cleanup scan: advisory-only list of confusing surfaces with destructive=false.
|
|
206
210
|
|
|
@@ -211,5 +215,7 @@ Advisory-only hook. It does not run checks or force routes.
|
|
|
211
215
|
```bash
|
|
212
216
|
yam hook status --global
|
|
213
217
|
yam hook enable lite --global
|
|
218
|
+
yam hook enable study-note --global
|
|
214
219
|
yam hook disable lite --global
|
|
220
|
+
yam hook disable study-note --global
|
|
215
221
|
```
|
package/DECISIONS.md
CHANGED
|
@@ -38,11 +38,14 @@ Every `yam` change is evaluated against honest proof, progressive depth, securit
|
|
|
38
38
|
- Rules the model can actually follow.
|
|
39
39
|
- Fast momentum without pretending simple work is always enough.
|
|
40
40
|
- Depth growth when the user's understanding, project risk, or product quality benefits from it.
|
|
41
|
+
- L0-L5 verification ladder with bounded heavy verification and explicit stop conditions.
|
|
41
42
|
|
|
42
43
|
### Beginner Insight
|
|
43
44
|
|
|
44
45
|
- Explain changed behavior in plain language.
|
|
45
46
|
- Name the code area touched and what it is responsible for.
|
|
47
|
+
- Include Study Note whenever code, config, release metadata, documentation, or project artifacts changed.
|
|
48
|
+
- Teach one useful syntax, schema, or structure insight without turning the final report into a long tutorial.
|
|
46
49
|
- Separate implementation facts from judgment.
|
|
47
50
|
- Always close with remaining tasks or useful improvements.
|
|
48
51
|
|
package/README.md
CHANGED
|
@@ -14,6 +14,8 @@ Context-reuse first.
|
|
|
14
14
|
End with remaining tasks and fix-first items.
|
|
15
15
|
Security-first project guidance.
|
|
16
16
|
Useful change insight for non-specialists.
|
|
17
|
+
Study Note for changed artifacts.
|
|
18
|
+
Verification Ladder for larger claims.
|
|
17
19
|
Reference-led judgment with clear source boundaries.
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -31,17 +33,18 @@ See `ROADMAP.md` for remaining implementation stages.
|
|
|
31
33
|
|
|
32
34
|
## Defaults
|
|
33
35
|
|
|
34
|
-
- No hooks.
|
|
36
|
+
- No required hooks.
|
|
35
37
|
- Optional `yam-lite` hook is advisory-only and off by default.
|
|
36
38
|
- No automatic Team routing.
|
|
37
39
|
- No automatic proof loops.
|
|
38
40
|
- No automatic tmux.
|
|
39
41
|
- No false completion claims: verification, cleanup, and visual checks must match actual evidence.
|
|
40
42
|
- `yam` is not lightweight-only; it is progressive: fast direction, broader judgment when useful, stronger proof as scope/risk grows.
|
|
41
|
-
- Every route should check project direction and use
|
|
43
|
+
- Every route should check project direction and use the L0-L5 Verification Ladder honestly.
|
|
42
44
|
- Small work stays small, but serious work is allowed to become serious.
|
|
43
45
|
- Security-sensitive work is never treated as ordinary polish.
|
|
44
|
-
-
|
|
46
|
+
- When code, config, release metadata, documentation, or project artifacts changed, final reports include a Study Note even if no yam skill was invoked.
|
|
47
|
+
- Useful Study Notes explain what the changed code or artifact does, what role it has, what was wrong or missing, what changed, what behavior is expected, one small syntax/structure insight, what was verified, and what remains uncertain.
|
|
45
48
|
- Research and reference scans should keep source boundaries clear, then rework good ideas into yam style.
|
|
46
49
|
- Token economy is part of quality.
|
|
47
50
|
- Project packs prevent re-reading and re-planning from scratch.
|
|
@@ -131,6 +134,7 @@ yam tools doctor /path/to/project
|
|
|
131
134
|
yam tools doctor /path/to/project --json
|
|
132
135
|
yam context pressure /path/to/project --json
|
|
133
136
|
yam cleanup scan /path/to/project --json
|
|
137
|
+
yam study-note check /path/to/project --text "Study Note: ..." --json
|
|
134
138
|
yam proof /path/to/project
|
|
135
139
|
yam proof write /path/to/project --route quick --truth verified --command "npm run verify:self: pass"
|
|
136
140
|
yam proof --route ueye --truth verified --visual "reference image only"
|
|
@@ -138,17 +142,18 @@ yam proof --route ueye --truth partial --visual-provenance '{"source_kind":"refe
|
|
|
138
142
|
yam ueye capture --url http://localhost:3000 --out .yam/screens/home.png
|
|
139
143
|
yam ueye compare --reference ./reference.png --actual .yam/screens/home.png
|
|
140
144
|
yam ueye preflight /path/to/project --json
|
|
141
|
-
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --preflight-id ueye-preflight-123 --p0-risk "mobile CTA may clip" --quality-gate-note "check CTA contrast before done" --completion-claim done --design-quality pass --direction-locked --reference-read --states-checked --mobile-checked --contrast-checked --cta-checked --provider-context local --execution-surface in-app-browser --app-surface codex-app --browser-surface in-app-browser --preserved-state --json
|
|
145
|
+
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --preflight-id ueye-preflight-123 --p0-risk "mobile CTA may clip" --quality-gate-note "check CTA contrast before done" --acceptance-criterion "primary CTA remains visible on mobile" --state-check default:pass --state-check mobile:partial --implementation-evidence "browser screenshot reviewed" --completion-claim done --design-quality pass --direction-locked --reference-read --states-checked --mobile-checked --contrast-checked --cta-checked --provider-context local --execution-surface in-app-browser --app-surface codex-app --browser-surface in-app-browser --preserved-state --json
|
|
142
146
|
yam proof --route ueye --truth verified --visual "implementation screenshot evidence recorded" --design-completion '{"completion_claim":"done","has_implementation_screenshot":true,"design_quality":"pass","states_checked":true,"mobile_checked":true,"contrast_checked":true,"cta_checked":true,"direction_locked":true,"truth_status":"verified"}'
|
|
143
147
|
yam media proof --requested --attempted --output ./generated.png --wait-loop --json
|
|
144
148
|
yam proof --route mission --mission-envelope '{"agent_id":"implementer","assigned_scope":"target component","changed_files":["src/file.ts"],"verification_hint":"npm run typecheck","truth_status":"partial"}'
|
|
145
|
-
yam loop report --route quick --intent "fix release readiness" --stage "inspect:passed:read release report" --evidence "typecheck passed" --evidence-level local --evidence-stamp "sha256:release-report" --covered-requirement "release report is read-only" --uncovered-requirement "npm auth verified" --blocked-kind auth_blocked --failure-cause auth_token_invalid --safe-retry "retry after npm whoami succeeds" --recovery-hint "refresh npm auth, then rerun readiness checks" --fix-first-item "npm auth must be verified before publish" --remaining-task "rerun release report after auth refresh" --recommended-direction "fix npm auth first, then publish manually" --implementation-note "keep loop report read-only" --why-this-next "auth blocks public release claims" --blocked-by "npm whoami E401" --owner-route deep --owner-scope "release readiness only" --scope-owner deep --side-effect "no publish attempted" --avoidance-note "do not retry publish before npm auth is proven" --issue-code "src/bin/yam.ts release report" --issue-role "summarizes release readiness without publishing" --issue-symptom "npm auth failure needs clearer next action" --changed-code "yam loop report" --changed-role "records loop evidence and learning note" --change-summary "added a read-only loop artifact" --why-important "it helps users learn what changed without overclaiming verification" --learning-note "fix blockers before claiming done" --json
|
|
149
|
+
yam loop report --route quick --intent "fix release readiness" --stage "inspect:passed:read release report" --evidence "typecheck passed" --evidence-level local --evidence-stamp "sha256:release-report" --touched-file src/bin/yam.ts --read-file README.md --verified-file scripts/cli-smoke.mjs --skipped-check "npm publish skipped by design" --stop-condition "stop after readiness evidence is recorded" --resume-hint "rerun release report after npm auth refresh" --readiness-state blocked --covered-requirement "release report is read-only" --uncovered-requirement "npm auth verified" --blocked-kind auth_blocked --failure-cause auth_token_invalid --safe-retry "retry after npm whoami succeeds" --recovery-hint "refresh npm auth, then rerun readiness checks" --fix-first-item "npm auth must be verified before publish" --remaining-task "rerun release report after auth refresh" --recommended-direction "fix npm auth first, then publish manually" --implementation-note "keep loop report read-only" --why-this-next "auth blocks public release claims" --blocked-by "npm whoami E401" --owner-route deep --owner-scope "release readiness only" --scope-owner deep --side-effect "no publish attempted" --avoidance-note "do not retry publish before npm auth is proven" --issue-code "src/bin/yam.ts release report" --issue-role "summarizes release readiness without publishing" --issue-symptom "npm auth failure needs clearer next action" --changed-code "yam loop report" --changed-role "records loop evidence and learning note" --change-summary "added a read-only loop artifact" --why-important "it helps users learn what changed without overclaiming verification" --learning-note "fix blockers before claiming done" --json
|
|
146
150
|
yam release report --json
|
|
147
151
|
yam safety "supabase db reset"
|
|
148
152
|
yam detect /path/to/project
|
|
149
153
|
yam pack /path/to/project
|
|
150
154
|
yam hook status --global
|
|
151
155
|
yam hook enable lite --global
|
|
156
|
+
yam hook enable study-note --global
|
|
152
157
|
yam hook disable lite --global
|
|
153
158
|
yam budget ueye
|
|
154
159
|
yam measure ueye --files 5 --commands 2 --report-lines 12 --seconds 180
|
|
@@ -215,9 +220,11 @@ These shapes keep reports machine-readable without turning normal work into a he
|
|
|
215
220
|
|
|
216
221
|
- Runtime evidence mini: compact route, command/process, observation, cleanup, truth status, and next action fields for `$deep` or `$mission` runtime claims.
|
|
217
222
|
- Patch queue lite: `$mission` lane records with pending/applied/verified/reverted/blocked state, changed files, verification hint, rollback hint, truth status, and next action.
|
|
223
|
+
- Verification Ladder: L0 stated, L1 inspected, L2 local check, L3 integrated, L4 release/runtime/visual proof, and L5 bounded deep. Heavier claims require heavier evidence, but stop conditions prevent endless proof loops.
|
|
218
224
|
- Release report JSON: `yam release report --json` summarizes typecheck, forbidden-name scan, package boundary, registry status, CLI smoke, dist freshness, diagnostics, readiness receipt, and final truth status.
|
|
219
|
-
- Loop report JSON: `yam loop report --json` records a read-only handoff artifact: guided stages, requirement coverage, evidence level/stamp, blocker kind, failure cause, safe retry, recovery hint, owner route/scope, side effects, next action, fix-first items, remaining tasks, recommended direction, implementation notes, blocked-by notes, avoidance note, tool intent, truth status, and study note.
|
|
220
|
-
- Study note: `yam.study-note.v1`
|
|
225
|
+
- Loop report JSON: `yam loop report --json` records a read-only handoff artifact: guided stages, touched/read/verified files, skipped checks, stop condition, resume hint, readiness state, requirement coverage, evidence level/stamp, blocker kind, failure cause, safe retry, recovery hint, owner route/scope, side effects, next action, fix-first items, remaining tasks, recommended direction, implementation notes, blocked-by notes, avoidance note, tool intent, truth status, and study note.
|
|
226
|
+
- Study note: `yam.study-note.v1` and `references/study-note.md` keep non-specialist explanations for what code/artifact changed, what role it plays, where it runs, what changed from before to after, what behavior is expected, one syntax/structure insight, what was verified, and what remains uncertain. Missing details stay in `limits` instead of being guessed. Study Note v3 also asks whether work was dumped into `page.tsx`, `global.css`, or broad DB `jsonb` when a smaller component, style module/token, typed column, relation, or validation schema would teach and scale better.
|
|
227
|
+
- Study Note guard: `yam study-note check` is a read-only missing-note guard. It checks changed files against supplied final-report text and can be used directly or through the opt-in `yam hook enable study-note --global` advisory hook.
|
|
221
228
|
- Avoidance note: loop reports may include one short mistake-to-avoid note, but durable memory stays explicit through `yam memory add`; `yam loop report` does not write `.yam/memory`.
|
|
222
229
|
- Publish blocker evidence: release reports classify common npm auth, permission, OTP, immutable-version, cache, registry, and tarball failures into safe next actions.
|
|
223
230
|
- Publish readiness evidence: release reports run read-only registry/auth/version probes, redact account/token details, keep npm publish outside the report, and include a `yam.release-readiness-receipt.v1` basis for the readiness judgment.
|
|
@@ -229,6 +236,7 @@ These shapes keep reports machine-readable without turning normal work into a he
|
|
|
229
236
|
- Ueye surface context: `$ueye` run reports can record provider context, provider badge, execution surface, app surface, browser surface, control mode, preserved URL/state, and evidence id.
|
|
230
237
|
- Ueye design completion gate: `$ueye` can stay fast for draft work, but a `done` claim is capped until implementation evidence, comparison/design-quality status, P0/P1 status, key states, mobile/responsive behavior, contrast/accessibility visuals, CTA affordance, and direction/reference-read proof are recorded when relevant.
|
|
231
238
|
- Ueye design brief and anti-slop review: `$ueye` reports can record operator-provided brief dimensions, constraints, invented metrics, placeholder copy, generic visuals, and custom anti-slop blockers. P0 anti-slop findings block `done` claims.
|
|
239
|
+
- Ueye deep visual review: `$ueye` can record acceptance criteria, touched/read/verified files, skipped checks, residual risks, stop condition, resume hint, design-system evidence, implementation evidence, and a state matrix so serious UI work can carry Deep-grade verification without leaving the Ueye route.
|
|
232
240
|
|
|
233
241
|
## Ueye Capture And Compare
|
|
234
242
|
|
|
@@ -238,14 +246,14 @@ These shapes keep reports machine-readable without turning normal work into a he
|
|
|
238
246
|
yam ueye capture --url http://localhost:3000 --out .yam/screens/home.png
|
|
239
247
|
yam ueye compare --reference ./reference.png --actual .yam/screens/home.png --json
|
|
240
248
|
yam ueye preflight . --json
|
|
241
|
-
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --brief-dimension "primary CTA clarity" --constraint "mobile first" --anti-slop "placeholder copy remains" --completion-claim done --design-quality pass --direction-locked --reference-read --states-checked --mobile-checked --contrast-checked --cta-checked --provider-context local --execution-surface in-app-browser --browser-surface in-app-browser --preserved-state --json
|
|
249
|
+
yam ueye report --reference ./reference.png --actual .yam/screens/home.png --brief-dimension "primary CTA clarity" --constraint "mobile first" --anti-slop "placeholder copy remains" --acceptance-criterion "pricing card CTA remains visible on mobile" --design-system-evidence "uses existing button token" --implementation-evidence "browser screenshot reviewed" --state-check default:pass --state-check mobile:partial --skipped-check "hover state not checked on touch viewport" --residual-risk "tablet breakpoint still needs visual pass" --stop-condition "stop after primary states are checked and residual risk is recorded" --resume-hint "capture tablet screenshot next" --completion-claim done --design-quality pass --direction-locked --reference-read --states-checked --mobile-checked --contrast-checked --cta-checked --provider-context local --execution-surface in-app-browser --browser-surface in-app-browser --preserved-state --json
|
|
242
250
|
```
|
|
243
251
|
|
|
244
252
|
`capture` uses a Playwright install from the current project when present, then falls back to the package context. It does not install browsers or add runtime dependencies by itself. If capture is unavailable, the visual claim stays `partial` or `blocked` until a real screenshot is supplied.
|
|
245
253
|
|
|
246
254
|
`compare` is local-only and dependency-free. It records file hashes, dimensions, comparison result, and proof-ready visual provenance. Exact image matches can be `verified`; different screenshots stay `partial` so visual parity is not overclaimed.
|
|
247
255
|
|
|
248
|
-
`report` gathers reference sources, implementation screenshots, comparison result, continuity fields, design quality judgment, design completion gate, surface context, and next action into one compact proof-ready JSON object. Draft and needs-polish work can stay fast; `--completion-claim done` turns on the stricter design gate.
|
|
256
|
+
`report` gathers reference sources, implementation screenshots, comparison result, continuity fields, design quality judgment, design completion gate, deep visual review, surface context, and next action into one compact proof-ready JSON object. Draft and needs-polish work can stay fast; `--completion-claim done` turns on the stricter design gate.
|
|
249
257
|
|
|
250
258
|
`preflight` does not claim visual verification. It is a pre-work checklist for reference source, target states, mobile/responsive needs, CTA/contrast/accessibility risk, screenshot availability, and likely P0/P1 candidates.
|
|
251
259
|
|