@playcraft/cli 0.0.56 → 0.0.58
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/README.md +41 -26
- package/REMIX.md +17 -5
- package/dist/cli-root-help.js +1 -0
- package/dist/commands/build-all.js +10 -9
- package/dist/commands/build.js +13 -12
- package/dist/commands/create.js +26 -33
- package/dist/commands/platform-skills.generated.js +19 -0
- package/dist/commands/remix.js +48 -2
- package/dist/commands/skills.js +2 -0
- package/dist/commands/tools-generation.js +1 -1
- package/dist/commands/workspace-runtime.js +54 -0
- package/dist/index.js +3 -1
- package/dist/project-skills/commands.js +72 -0
- package/dist/project-skills/lifecycle.js +28 -0
- package/dist/project-skills/local-run.js +112 -0
- package/dist/project-skills/local-store.js +149 -0
- package/dist/project-skills/messages.js +72 -0
- package/dist/project-skills/reconcile.js +62 -0
- package/dist/project-skills/remote-cache.js +51 -0
- package/dist/project-skills/validation.js +19 -0
- package/dist/remix/clone.js +4 -1
- package/dist/remix/init-template.js +2 -0
- package/dist/remix/local-git.js +56 -0
- package/dist/remix/pull.js +66 -0
- package/dist/remix/push.js +90 -0
- package/dist/utils/agent-api-client.js +54 -17
- package/dist/utils/tool-operation-journal.js +54 -0
- package/dist/workspace-runtime/codex/app-server.js +395 -0
- package/dist/workspace-runtime/codex/config-toml.js +25 -0
- package/dist/workspace-runtime/codex/jsonrpc-stdio.js +106 -0
- package/dist/workspace-runtime/codex/loopback.js +59 -0
- package/dist/workspace-runtime/codex/native-adapter.js +3 -0
- package/dist/workspace-runtime/main.js +10 -0
- package/dist/workspace-runtime/persistence/journal.js +350 -0
- package/dist/workspace-runtime/processes/managed-writes.js +69 -0
- package/dist/workspace-runtime/serve.js +111 -0
- package/dist/workspace-runtime/server/auth.js +21 -0
- package/dist/workspace-runtime/server/dispatch.js +861 -0
- package/dist/workspace-runtime/server/execution-group.js +88 -0
- package/dist/workspace-runtime/server/http.js +561 -0
- package/dist/workspace-runtime/server/lock.js +53 -0
- package/dist/workspace-runtime/server/types.js +1 -0
- package/dist/workspace-runtime/workspaces/context-error.js +2 -0
- package/dist/workspace-runtime/workspaces/file-snapshot.js +213 -0
- package/dist/workspace-runtime/workspaces/files.js +143 -0
- package/dist/workspace-runtime/workspaces/git.js +242 -0
- package/dist/workspace-runtime/workspaces/json5-edit.js +170 -0
- package/dist/workspace-runtime/workspaces/parameters.js +272 -0
- package/dist/workspace-runtime/workspaces/prepare.js +364 -0
- package/dist/workspace-runtime/workspaces/registry.js +107 -0
- package/dist/workspace-runtime/workspaces/revisions.js +31 -0
- package/package.json +6 -3
- package/project-template-v2/.claude/agents/artist.md +82 -0
- package/project-template-v2/.claude/agents/developer.md +153 -0
- package/project-template-v2/.claude/agents/game-designer.md +264 -0
- package/project-template-v2/.claude/agents/refs/artist-art-style-catalog.md +533 -0
- package/project-template-v2/.claude/agents/refs/artist-color-audio-recipes.md +153 -0
- package/project-template-v2/.claude/agents/refs/artist-dimension-axis.md +27 -0
- package/project-template-v2/.claude/agents/refs/artist-master-composite-recipes.md +208 -0
- package/project-template-v2/.claude/agents/refs/atom-skill-library.md +81 -0
- package/project-template-v2/.claude/agents/refs/developer-impl-cookbook.md +432 -0
- package/project-template-v2/.claude/agents/refs/framework-5-component-filter.md +252 -0
- package/project-template-v2/.claude/agents/refs/framework-game-feel-juice.md +266 -0
- package/project-template-v2/.claude/agents/refs/framework-mda.md +147 -0
- package/project-template-v2/.claude/agents/refs/game-designer-gameplay-sufficiency.md +123 -0
- package/project-template-v2/.claude/agents/refs/ta-3d-flip-recipe.md +88 -0
- package/project-template-v2/.claude/agents/refs/ta-atlas-deliverable-standard.md +67 -0
- package/project-template-v2/.claude/agents/refs/ta-batch-pipeline-recipes.md +120 -0
- package/project-template-v2/.claude/agents/refs/ta-image-generation-detail.md +300 -0
- package/project-template-v2/.claude/agents/refs/ta-image-ops-reference.md +495 -0
- package/project-template-v2/.claude/agents/refs/ta-pipeline-cookbook.md +1141 -0
- package/project-template-v2/.claude/agents/refs/ta-tools-reference.md +111 -0
- package/project-template-v2/.claude/agents/refs/ta-vfx-preset-catalog.md +365 -0
- package/project-template-v2/.claude/agents/refs/threejs-cannon-pitfalls.md +412 -0
- package/project-template-v2/.claude/agents/reviewer.md +75 -0
- package/project-template-v2/.claude/agents/technical-artist.md +86 -0
- package/project-template-v2/.claude/hooks/snapshot-milestone.mjs +243 -0
- package/project-template-v2/.claude/hooks/user-prompt.mjs +133 -0
- package/project-template-v2/.claude/settings.json +33 -0
- package/project-template-v2/.claude/skills/brainstorming/SKILL.md +161 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/frame-template.html +270 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/helper.js +177 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/server.cjs +354 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/start-server.sh +148 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/stop-server.sh +56 -0
- package/project-template-v2/.claude/skills/brainstorming/scripts/wait-for-selection.sh +62 -0
- package/project-template-v2/.claude/skills/brainstorming/spec-document-reviewer-prompt.md +49 -0
- package/project-template-v2/.claude/skills/brainstorming/visual-companion.md +309 -0
- package/project-template-v2/.claude/skills/playcraft-ad-psychology/SKILL.md +182 -0
- package/project-template-v2/.claude/skills/playcraft-art-style-guide/SKILL.md +123 -0
- package/project-template-v2/.claude/skills/playcraft-asset-state-sheet/SKILL.md +205 -0
- package/project-template-v2/.claude/skills/playcraft-audio-generation/SKILL.md +280 -0
- package/project-template-v2/.claude/skills/playcraft-batch-pipeline/SKILL.md +184 -0
- package/project-template-v2/.claude/skills/playcraft-build-optimizer/SKILL.md +306 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/SKILL.md +298 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/build-sprite-sheet.template.mjs +123 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/compare-style.template.mjs +254 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-batch-sprite.template.mjs +324 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-batch.template.mjs +97 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-edit-variants.template.mjs +118 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/process-batch.template.mjs +137 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/prompt-cookbook.md +397 -0
- package/project-template-v2/.claude/skills/playcraft-image-generation/reference/validate-sprite-sheet.template.mjs +296 -0
- package/project-template-v2/.claude/skills/playcraft-image-ops/SKILL.md +122 -0
- package/project-template-v2/.claude/skills/playcraft-image-processing/SKILL.md +219 -0
- package/project-template-v2/.claude/skills/playcraft-masking/SKILL.md +373 -0
- package/project-template-v2/.claude/skills/playcraft-playable-optimization/SKILL.md +161 -0
- package/project-template-v2/.claude/skills/playcraft-research/SKILL.md +215 -0
- package/project-template-v2/.claude/skills/playcraft-skill-recommender/SKILL.md +382 -0
- package/project-template-v2/.claude/skills/playcraft-sprite-generation/SKILL.md +423 -0
- package/project-template-v2/.claude/skills/playcraft-sprite-remix/SKILL.md +158 -0
- package/project-template-v2/.claude/skills/playcraft-sprite-sheet/SKILL.md +100 -0
- package/project-template-v2/.claude/skills/playcraft-storyboard/SKILL.md +167 -0
- package/project-template-v2/.claude/skills/playcraft-style-qa/SKILL.md +270 -0
- package/project-template-v2/.claude/skills/playcraft-text-rendering/SKILL.md +236 -0
- package/project-template-v2/.claude/skills/playcraft-vfx-animation/SKILL.md +130 -0
- package/project-template-v2/.claude/skills/playwright-cli/SKILL.md +390 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/element-attributes.md +23 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/playwright-tests.md +39 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/request-mocking.md +87 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/running-code.md +240 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/session-management.md +226 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/spec-driven-testing.md +308 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/storage-state.md +275 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/test-generation.md +134 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/tracing.md +142 -0
- package/project-template-v2/.claude/skills/playwright-cli/references/video-recording.md +153 -0
- package/project-template-v2/.claude/skills/session-analyzer/SKILL.md +386 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/execution-breakdown.mjs +182 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/find-turns.mjs +72 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/heavy-output.mjs +121 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/resolve-session.mjs +102 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/subagent-stats.mjs +127 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/subagent-tool-timeline.mjs +106 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/time-gaps.mjs +128 -0
- package/project-template-v2/.claude/skills/session-analyzer/scripts/turn-timeline.mjs +67 -0
- package/project-template-v2/.claude/snapshot.mjs +263 -0
- package/project-template-v2/.playcraft/skills.lock.json +152 -0
- package/project-template-v2/CLAUDE.md +146 -0
- package/project-template-v2/assets/audio/bgm/.gitkeep +0 -0
- package/project-template-v2/assets/audio/sfx/.gitkeep +0 -0
- package/project-template-v2/assets/bundles/.gitkeep +0 -0
- package/project-template-v2/assets/images/bg/.gitkeep +0 -0
- package/project-template-v2/assets/images/reference/.gitkeep +0 -0
- package/project-template-v2/assets/images/storyboard/.gitkeep +0 -0
- package/project-template-v2/assets/images/tiles/.gitkeep +0 -0
- package/project-template-v2/assets/images/ui/.gitkeep +0 -0
- package/project-template-v2/assets/images/vfx/.gitkeep +0 -0
- package/project-template-v2/assets/models/.gitkeep +0 -0
- package/project-template-v2/docs/harness/iteration-1/context-flow.md +254 -0
- package/project-template-v2/docs/harness/iteration-1/generate-flow.md +91 -0
- package/project-template-v2/docs/harness/iteration-1/ideate-flow.md +214 -0
- package/project-template-v2/docs/harness/iteration-1/optimize-flow.md +75 -0
- package/project-template-v2/docs/harness/iteration-1/wrapup-flow.md +63 -0
- package/project-template-v2/docs/harness/iteration-2/context-flow.md +223 -0
- package/project-template-v2/docs/harness/iteration-2/generate-flow.md +129 -0
- package/project-template-v2/docs/harness/iteration-2/ideate-flow.md +267 -0
- package/project-template-v2/docs/harness/iteration-2/optimize-flow.md +164 -0
- package/project-template-v2/docs/harness/iteration-2/wrapup-flow.md +115 -0
- package/project-template-v2/docs/harness/orchestrator-flow.md +364 -0
- package/project-template-v2/docs/project-state.json +60 -0
- package/project-template-v2/docs/project-state.md +72 -0
- package/project-template-v2/docs/standards/README.md +225 -0
- package/project-template-v2/docs/standards/agent-behavior-standards.md +174 -0
- package/project-template-v2/docs/standards/artifacts/design-brief.md +19 -0
- package/project-template-v2/docs/standards/artifacts/design.md +22 -0
- package/project-template-v2/docs/standards/artifacts/game-code.md +41 -0
- package/project-template-v2/docs/standards/artifacts/todo-list.md +41 -0
- package/project-template-v2/docs/standards/iter1-agent-behavior-standards.md +343 -0
- package/project-template-v2/game/index.ts +18 -0
- package/project-template-v2/globals.d.ts +51 -0
- package/project-template-v2/index.css +34 -0
- package/project-template-v2/index.html +18 -0
- package/project-template-v2/main.ts +9 -0
- package/project-template-v2/package.json +46 -0
- package/project-template-v2/skills/_shared/scripts/dispatch-clear.mjs +31 -0
- package/project-template-v2/skills/_shared/scripts/dispatch-set.mjs +86 -0
- package/project-template-v2/skills/_shared/scripts/dod-check.mjs +153 -0
- package/project-template-v2/skills/_shared/scripts/handoff-append.mjs +70 -0
- package/project-template-v2/skills/_shared/scripts/lib/validator-artifacts.mjs +91 -0
- package/project-template-v2/skills/_shared/scripts/pipeline/dod-config.mjs +131 -0
- package/project-template-v2/skills/_shared/scripts/pipeline/index.mjs +80 -0
- package/project-template-v2/skills/_shared/scripts/pipeline/iteration-1-core.mjs +90 -0
- package/project-template-v2/skills/_shared/scripts/pipeline/iteration-2-wrap.mjs +93 -0
- package/project-template-v2/skills/_shared/scripts/pipeline/iteration-3-visual.mjs +23 -0
- package/project-template-v2/skills/_shared/scripts/render-project-state.mjs +230 -0
- package/project-template-v2/skills/_shared/scripts/state-advance-stage.mjs +58 -0
- package/project-template-v2/skills/_shared/scripts/state-get.mjs +339 -0
- package/project-template-v2/skills/_shared/scripts/state-handoff.mjs +39 -0
- package/project-template-v2/skills/_shared/scripts/state-set.mjs +94 -0
- package/project-template-v2/skills/_shared/scripts/state-store.mjs +783 -0
- package/project-template-v2/skills/_shared/scripts/todo-add.mjs +88 -0
- package/project-template-v2/skills/_shared/scripts/todo-get.mjs +130 -0
- package/project-template-v2/skills/_shared/scripts/todo-remove.mjs +33 -0
- package/project-template-v2/skills/_shared/scripts/todo-set.mjs +47 -0
- package/project-template-v2/skills/_shared/scripts/verify-asset-code-sync.mjs +268 -0
- package/project-template-v2/skills/_shared/scripts/verify-env.mjs +285 -0
- package/project-template-v2/skills/_shared/scripts/verify-placeholders.mjs +161 -0
- package/project-template-v2/skills/playable-autoplay/SKILL.md +176 -0
- package/project-template-v2/skills/playable-autoplay/agents/openai.yaml +4 -0
- package/project-template-v2/skills/playable-debug/SKILL.md +116 -0
- package/project-template-v2/skills/playable-debug/agents/openai.yaml +4 -0
- package/project-template-v2/skills/playable-debug/references/debug-config.md +40 -0
- package/project-template-v2/skills/playable-record/SKILL.md +140 -0
- package/project-template-v2/skills/playable-record/scripts/lib/dev-server.mjs +104 -0
- package/project-template-v2/skills/playable-record/scripts/lib/record-audio-bridge.js +141 -0
- package/project-template-v2/skills/playable-record/scripts/record-playable.mjs +425 -0
- package/project-template-v2/skills/playable-record/scripts/verify-contract.mjs +261 -0
- package/project-template-v2/skills/playable-record/scripts/verify-firstwin.mjs +398 -0
- package/project-template-v2/skills/playable-record/scripts/verify-fusion.mjs +322 -0
- package/project-template-v2/skills/playable-record/scripts/verify-lifecycle.mjs +105 -0
- package/project-template-v2/skills/playable-record/scripts/verify-vlm-video.mjs +230 -0
- package/project-template-v2/skills/playable-validate/SKILL.md +61 -0
- package/project-template-v2/skills/playable-validate/validation-rules.md +14 -0
- package/project-template-v2/skills/playable-verify-ui/SKILL.md +63 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/__init__.py +1 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/config_expr.js +218 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/node_utils.js +51 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/profile_loader.py +59 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/report.py +106 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/lib/runtime_contract.js +116 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/verify_fetch_antipatterns.py +59 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/verify_hardcoded_layout.js +64 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/verify_runtime_contract.js +58 -0
- package/project-template-v2/skills/playable-verify-ui/scripts/verify_text_overlap.py +333 -0
- package/project-template-v2/ta-workspace/scripts/.gitkeep +0 -0
- package/project-template-v2/tsconfig.json +20 -0
- package/project-template-v2/vite.config.ts +27 -0
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: playable-validate
|
|
3
|
+
description: >-
|
|
4
|
+
Validation loop for template-v2. Use after game code is runnable to verify
|
|
5
|
+
runtime contract, lifecycle phase path, first-win, fusion, placeholders, asset
|
|
6
|
+
sync, MP4 recording, and VLM video review. Iteration-2 optimize adds lifecycle
|
|
7
|
+
to the standard DoD sequence. UI layout validation is in playable-verify-ui.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Playable Validate
|
|
11
|
+
|
|
12
|
+
## Iteration-1 DoD 序列
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm run verify:env # 环境预检 (Node/Python/Playwright)
|
|
16
|
+
npm run verify:contract # window.__playable 合约接线
|
|
17
|
+
npm run verify:firstwin # autoPlay() 能到达 ENDCARD
|
|
18
|
+
npm run verify:fusion # 多玩法融合接线 (单玩法自动 no-op)
|
|
19
|
+
npm run record:mp4 -- --headed --fps=60
|
|
20
|
+
npm run verify:vlm-video -- --record-first
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Iteration-2 DoD 序列(在 iter-1 序列基础上新增)
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm run verify:lifecycle # phasePath: HOOK→TUTORIAL→GAMEPLAY→WIN/FAIL→ENDCARD 完整无跳跃
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
lifecycle 失败时:检查 phasePath 输出,定位哪个 phase 缺失,路由回 generate 修复状态机骨架。
|
|
30
|
+
|
|
31
|
+
## 辅助检查(generate / optimize 阶段可按需运行)
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run verify:placeholders # ✅ 可用:代码引用的资产路径实际存在于磁盘
|
|
35
|
+
npm run verify:asset-sync # ✅ 可用:资产文件与代码引用双向一致
|
|
36
|
+
npm run verify:runtime-contract # ✅ 可用:静态合约检查(无需浏览器)
|
|
37
|
+
|
|
38
|
+
# ⚠️ 暂不可用——需先创建 playable.ui.profile.yaml:
|
|
39
|
+
# npm run verify:hardcoded-layout
|
|
40
|
+
# python3 skills/playable-verify-ui/scripts/verify_fetch_antipatterns.py --root .
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Scope
|
|
44
|
+
|
|
45
|
+
| 命令 | 检查内容 | 产出 |
|
|
46
|
+
| ------------------------- | ------------------------------------------------------------- | ------------------------- |
|
|
47
|
+
| `verify:env` | Node ≥20 / Python3 / Pillow / Playwright Chromium | 控制台报告 |
|
|
48
|
+
| `verify:contract` | `window.__playable` 动态接线 | `validate/contract.json` |
|
|
49
|
+
| `verify:lifecycle` | phasePath 顺序完整性(HOOK 开头,ENDCARD 结尾,中间节点存在) | `validate/lifecycle.json` |
|
|
50
|
+
| `verify:firstwin` | autoPlay 到达 ENDCARD + isGameOver | `validate/firstwin.json` |
|
|
51
|
+
| `verify:fusion` | 多玩法 atom 融合类型 + 源码接线 | `validate/fusion.json` |
|
|
52
|
+
| `verify:placeholders` | 代码 load.image/atlas 路径磁盘存在 | 控制台 |
|
|
53
|
+
| `verify:asset-sync` | 资产↔代码双向引用一致 | 控制台 |
|
|
54
|
+
| `verify:runtime-contract` | 静态合约(无浏览器) | 控制台 |
|
|
55
|
+
| `verify:hardcoded-layout` | 硬编码 px 宽高 | 控制台 |
|
|
56
|
+
| `record:mp4` | headed 60fps MP4 | `recordings/*.mp4` |
|
|
57
|
+
| `verify:vlm-video` | VLM 语义视频评审 | `validate/vlm-video.json` |
|
|
58
|
+
|
|
59
|
+
## UI 布局验证
|
|
60
|
+
|
|
61
|
+
文字叠加、fetch 反模式、布局区域规则等 UI 检查在 `playable-verify-ui` skill。
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Validation Rules
|
|
2
|
+
|
|
3
|
+
Current template-v2 iteration 1 validates the runtime/video path only.
|
|
4
|
+
|
|
5
|
+
| Check | Command | Pass condition |
|
|
6
|
+
| ---------------- | -------------------------- | --------------------------------------------------------------------------------------- |
|
|
7
|
+
| Runtime contract | `npm run verify:contract` | `window.__playable.autoPlay()` and `getState()` exist; initial phase is `HOOK` |
|
|
8
|
+
| First win | `npm run verify:firstwin` | Auto-play reaches `ENDCARD` with `isGameOver=true` |
|
|
9
|
+
| Fusion | `npm run verify:fusion` | Single gameplay atom no-ops; multi-atom projects document fusion and show source wiring |
|
|
10
|
+
| Recording | `npm run record:mp4` | MP4 is produced without contract/runtime timeout |
|
|
11
|
+
| Video semantics | `npm run verify:vlm-video` | No P0/fail findings in `vlm-video.json` |
|
|
12
|
+
|
|
13
|
+
UI, atlas, layout, focus playground, and visual ring checks are deferred until
|
|
14
|
+
their migration stage.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: playable-verify-ui
|
|
3
|
+
description: >-
|
|
4
|
+
UI integrity checks for playable ads: static runtime contract and text overlap
|
|
5
|
+
detection. Use during iteration-2 generate/optimize when adding overlay UI
|
|
6
|
+
layers. verify:hardcoded-layout and verify_fetch_antipatterns require
|
|
7
|
+
playable.ui.profile.yaml and are NOT usable until that file is created.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Playable Verify UI
|
|
11
|
+
|
|
12
|
+
布局层和 UI 层的静态完整性检查。部分工具不需要浏览器或 profile 配置;部分工具依赖 `playable.ui.profile.yaml`,在 v2 模板中该文件尚未创建,标记为暂不可用。
|
|
13
|
+
|
|
14
|
+
## 何时使用
|
|
15
|
+
|
|
16
|
+
- 包装层新增 Tutorial 引导层、HUD、EndCard 等 UI 覆盖层时
|
|
17
|
+
- optimize 阶段完整游戏评价前的 UI 快速自检
|
|
18
|
+
|
|
19
|
+
## ✅ 可用命令
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm run verify:runtime-contract # 静态合约:扫描 game/ 确认 window.__playable 接口声明存在
|
|
23
|
+
python3 skills/playable-verify-ui/scripts/verify_text_overlap.py --root .
|
|
24
|
+
# 文字叠加检测(需 Python3;无 tesseract 时 degraded pass,不 block)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## ⚠️ 暂不可用(需要 playable.ui.profile.yaml)
|
|
28
|
+
|
|
29
|
+
下列工具依赖项目根目录的 `playable.ui.profile.yaml`,v2 模板尚未提供该文件。
|
|
30
|
+
直接运行会报 profile 缺失错误,**不要在 DoD 中引用这两个命令**:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# ❌ 暂不可用
|
|
34
|
+
npm run verify:hardcoded-layout
|
|
35
|
+
python3 skills/playable-verify-ui/scripts/verify_fetch_antipatterns.py --root .
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
启用方式:参考 project-template 的 `examples/mahjong-match.profile.yaml`,
|
|
39
|
+
创建并填写本项目的 `playable.ui.profile.yaml`,然后这两个命令才可使用。
|
|
40
|
+
|
|
41
|
+
## 检查内容
|
|
42
|
+
|
|
43
|
+
| 脚本 | 状态 | 检查内容 | 失败含义 |
|
|
44
|
+
| ------------------------------ | ------------- | ---------------------------------------------------- | ----------------------------------------- |
|
|
45
|
+
| `verify_runtime_contract.js` | ✅ 可用 | 静态扫描 game/ 确认 `window.__playable` 接口声明存在 | 接口未声明,动态 verify:contract 必然失败 |
|
|
46
|
+
| `verify_text_overlap.py` | ✅ 可用 | OCR 检测 CTA 区域文字是否重叠 | Tutorial 文字 + HUD 文字在同区域叠加 |
|
|
47
|
+
| `verify_hardcoded_layout.js` | ⚠️ 需 profile | 检测 game/ 中直接写死的 px 宽高 | 多分辨率适配和包装层叠加会错位 |
|
|
48
|
+
| `verify_fetch_antipatterns.py` | ⚠️ 需 profile | 扫描是否有 placehold.co 等外部 fetch 引用 | 所有渠道禁止外部请求 |
|
|
49
|
+
|
|
50
|
+
## 与 verify:contract 的关系
|
|
51
|
+
|
|
52
|
+
`verify:runtime-contract`(静态,无浏览器)和 `verify:contract`(动态,需 dev server)互补:
|
|
53
|
+
|
|
54
|
+
- 静态版在 generate 阶段写完代码后即可运行,快速确认接口声明
|
|
55
|
+
- 动态版在 optimize 阶段作为 DoD 项运行
|
|
56
|
+
|
|
57
|
+
## 依赖
|
|
58
|
+
|
|
59
|
+
- Node.js(`verify_runtime_contract.js`)
|
|
60
|
+
- Python3(`verify_text_overlap.py`)
|
|
61
|
+
- tesseract(可选,无 OCR 时 degraded pass)
|
|
62
|
+
|
|
63
|
+
运行 `npm run verify:env` 确认环境满足要求。
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Playable UI verification library
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Safely evaluate layout expressions against GAME_CONFIG + profile.safeArea.
|
|
5
|
+
* Only allows numeric literals, + - * /, parentheses, and dotted identifiers.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
const TOKEN_RE = /(\d+(?:\.\d+)?|[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*|[+\-*/()]|\s+)/g;
|
|
9
|
+
|
|
10
|
+
function getPathValue(root, path) {
|
|
11
|
+
const parts = path.split('.');
|
|
12
|
+
let cur = root;
|
|
13
|
+
for (const part of parts) {
|
|
14
|
+
if (cur == null || typeof cur !== 'object' || !(part in cur)) {
|
|
15
|
+
throw new Error(`Unknown path: ${path}`);
|
|
16
|
+
}
|
|
17
|
+
cur = cur[part];
|
|
18
|
+
}
|
|
19
|
+
if (typeof cur !== 'number' || !Number.isFinite(cur)) {
|
|
20
|
+
throw new Error(`Path is not a finite number: ${path}`);
|
|
21
|
+
}
|
|
22
|
+
return cur;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function resolveRef(expr, gameConfig, profile) {
|
|
26
|
+
const trimmed = expr.trim();
|
|
27
|
+
if (/^\d+(?:\.\d+)?$/.test(trimmed)) {
|
|
28
|
+
return Number(trimmed);
|
|
29
|
+
}
|
|
30
|
+
if (trimmed.startsWith('safeArea.')) {
|
|
31
|
+
const key = trimmed.slice('safeArea.'.length);
|
|
32
|
+
const safe = profile && profile.safeArea;
|
|
33
|
+
if (!safe || !(key in safe)) {
|
|
34
|
+
throw new Error(`Unknown safeArea key: ${key}`);
|
|
35
|
+
}
|
|
36
|
+
return Number(safe[key]);
|
|
37
|
+
}
|
|
38
|
+
return getPathValue(gameConfig, trimmed);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
function tokenize(expr) {
|
|
42
|
+
const tokens = [];
|
|
43
|
+
let m;
|
|
44
|
+
TOKEN_RE.lastIndex = 0;
|
|
45
|
+
while ((m = TOKEN_RE.exec(expr)) !== null) {
|
|
46
|
+
const t = m[0];
|
|
47
|
+
if (/^\s+$/.test(t)) continue;
|
|
48
|
+
tokens.push(t);
|
|
49
|
+
}
|
|
50
|
+
return tokens;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function parseExpression(tokens, gameConfig, profile) {
|
|
54
|
+
let pos = 0;
|
|
55
|
+
|
|
56
|
+
function peek() {
|
|
57
|
+
return tokens[pos];
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
function consume(expected) {
|
|
61
|
+
const t = tokens[pos++];
|
|
62
|
+
if (expected && t !== expected) {
|
|
63
|
+
throw new Error(`Expected '${expected}' but got '${t}'`);
|
|
64
|
+
}
|
|
65
|
+
return t;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
function parsePrimary() {
|
|
69
|
+
const t = peek();
|
|
70
|
+
if (t === '(') {
|
|
71
|
+
consume('(');
|
|
72
|
+
const val = parseAddSub();
|
|
73
|
+
consume(')');
|
|
74
|
+
return val;
|
|
75
|
+
}
|
|
76
|
+
if (/^\d+(?:\.\d+)?$/.test(t)) {
|
|
77
|
+
consume();
|
|
78
|
+
return Number(t);
|
|
79
|
+
}
|
|
80
|
+
if (/^[A-Za-z_]/.test(t)) {
|
|
81
|
+
consume();
|
|
82
|
+
return resolveRef(t, gameConfig, profile);
|
|
83
|
+
}
|
|
84
|
+
throw new Error(`Unexpected token: ${t}`);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function parseMulDiv() {
|
|
88
|
+
let left = parsePrimary();
|
|
89
|
+
while (peek() === '*' || peek() === '/') {
|
|
90
|
+
const op = consume();
|
|
91
|
+
const right = parsePrimary();
|
|
92
|
+
left = op === '*' ? left * right : left / right;
|
|
93
|
+
}
|
|
94
|
+
return left;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
function parseAddSub() {
|
|
98
|
+
let left = parseMulDiv();
|
|
99
|
+
while (peek() === '+' || peek() === '-') {
|
|
100
|
+
const op = consume();
|
|
101
|
+
const right = parseMulDiv();
|
|
102
|
+
left = op === '+' ? left + right : left - right;
|
|
103
|
+
}
|
|
104
|
+
return left;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
const result = parseAddSub();
|
|
108
|
+
if (pos !== tokens.length) {
|
|
109
|
+
throw new Error(`Unexpected trailing tokens at position ${pos}`);
|
|
110
|
+
}
|
|
111
|
+
return result;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
function evaluate(expr, gameConfig, profile) {
|
|
115
|
+
if (expr == null) {
|
|
116
|
+
throw new Error('Expression is required');
|
|
117
|
+
}
|
|
118
|
+
if (typeof expr === 'number') return expr;
|
|
119
|
+
const str = String(expr).trim();
|
|
120
|
+
if (/^\d+(?:\.\d+)?$/.test(str)) {
|
|
121
|
+
return Number(str);
|
|
122
|
+
}
|
|
123
|
+
if (/^[A-Za-z_][A-Za-z0-9_.]*$/.test(str) && !/[+\-*/()]/.test(str)) {
|
|
124
|
+
return resolveRef(str, gameConfig, profile);
|
|
125
|
+
}
|
|
126
|
+
const tokens = tokenize(str);
|
|
127
|
+
return parseExpression(tokens, gameConfig, profile);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
function regionBounds(regionDef, gameConfig, profile) {
|
|
131
|
+
if (regionDef.cy != null && regionDef.h != null) {
|
|
132
|
+
const cy = evaluate(regionDef.cy, gameConfig, profile);
|
|
133
|
+
const h = evaluate(regionDef.h, gameConfig, profile);
|
|
134
|
+
return { y0: cy - h / 2, y1: cy + h / 2 };
|
|
135
|
+
}
|
|
136
|
+
if (regionDef.y0 != null && regionDef.y1 != null) {
|
|
137
|
+
return {
|
|
138
|
+
y0: evaluate(regionDef.y0, gameConfig, profile),
|
|
139
|
+
y1: evaluate(regionDef.y1, gameConfig, profile),
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
throw new Error('Region must define y0/y1 or cy/h');
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Load GAME_CONFIG from the project's single source of truth.
|
|
147
|
+
*
|
|
148
|
+
* Supports TypeScript (`.ts`/`.tsx`) directly so the project keeps ONE config
|
|
149
|
+
* file — verify reads exactly what the game runs, making drift structurally
|
|
150
|
+
* impossible. Legacy plain `.js` configs remain supported.
|
|
151
|
+
*
|
|
152
|
+
* Extraction order (robust to authoring style):
|
|
153
|
+
* 1. `module.exports.GAME_CONFIG` (CJS / esbuild output / current stub)
|
|
154
|
+
* 2. bare top-level `const GAME_CONFIG = {...}` (legacy hand-written JS)
|
|
155
|
+
*/
|
|
156
|
+
function loadGameConfig(configPath) {
|
|
157
|
+
const fs = require('fs');
|
|
158
|
+
const vm = require('vm');
|
|
159
|
+
const path = require('path');
|
|
160
|
+
|
|
161
|
+
let code = fs.readFileSync(configPath, 'utf8');
|
|
162
|
+
const ext = path.extname(configPath).toLowerCase();
|
|
163
|
+
|
|
164
|
+
if (ext === '.ts' || ext === '.tsx' || ext === '.mts' || ext === '.cts') {
|
|
165
|
+
let esbuild;
|
|
166
|
+
try {
|
|
167
|
+
esbuild = require('esbuild');
|
|
168
|
+
} catch (err) {
|
|
169
|
+
throw new Error(
|
|
170
|
+
`Loading ${path.basename(configPath)} needs esbuild (bundled with vite). ` +
|
|
171
|
+
`Run "npm install" in the project root. Original: ${err.message}`,
|
|
172
|
+
);
|
|
173
|
+
}
|
|
174
|
+
code = esbuild.transformSync(code, {
|
|
175
|
+
loader: ext === '.tsx' ? 'tsx' : 'ts',
|
|
176
|
+
format: 'cjs',
|
|
177
|
+
target: 'es2020',
|
|
178
|
+
}).code;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
const moduleObj = { exports: {} };
|
|
182
|
+
const sandbox = {
|
|
183
|
+
module: moduleObj,
|
|
184
|
+
exports: moduleObj.exports,
|
|
185
|
+
require,
|
|
186
|
+
console,
|
|
187
|
+
__DEV__: false,
|
|
188
|
+
globalThis: undefined,
|
|
189
|
+
};
|
|
190
|
+
vm.createContext(sandbox);
|
|
191
|
+
sandbox.globalThis = sandbox;
|
|
192
|
+
|
|
193
|
+
// Capture a bare top-level `const GAME_CONFIG` (block-scoped, won't leak to
|
|
194
|
+
// the sandbox object on its own) by re-exposing it after the script body.
|
|
195
|
+
const wrapped = `${code}\n;try{ globalThis.__GAME_CONFIG__ = (typeof GAME_CONFIG !== 'undefined') ? GAME_CONFIG : undefined; }catch(_e){}`;
|
|
196
|
+
vm.runInContext(wrapped, sandbox, { filename: configPath });
|
|
197
|
+
|
|
198
|
+
const exported = moduleObj.exports || {};
|
|
199
|
+
const cfg =
|
|
200
|
+
exported.GAME_CONFIG ||
|
|
201
|
+
(exported.default && exported.default.GAME_CONFIG) ||
|
|
202
|
+
sandbox.__GAME_CONFIG__;
|
|
203
|
+
|
|
204
|
+
if (!cfg || typeof cfg !== 'object') {
|
|
205
|
+
throw new Error(
|
|
206
|
+
`GAME_CONFIG not found after loading ${path.basename(configPath)} — ` +
|
|
207
|
+
`export a GAME_CONFIG object (e.g. "export const GAME_CONFIG = { ... }").`,
|
|
208
|
+
);
|
|
209
|
+
}
|
|
210
|
+
return cfg;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
module.exports = {
|
|
214
|
+
evaluate,
|
|
215
|
+
regionBounds,
|
|
216
|
+
loadGameConfig,
|
|
217
|
+
resolveRef,
|
|
218
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const fs = require('fs');
|
|
4
|
+
const path = require('path');
|
|
5
|
+
const { execFileSync } = require('child_process');
|
|
6
|
+
|
|
7
|
+
function loadProfile(profilePath) {
|
|
8
|
+
const out = execFileSync(
|
|
9
|
+
'python3',
|
|
10
|
+
[
|
|
11
|
+
'-c',
|
|
12
|
+
'import json, sys, yaml; print(json.dumps(yaml.safe_load(open(sys.argv[1], encoding="utf-8"))))',
|
|
13
|
+
profilePath,
|
|
14
|
+
],
|
|
15
|
+
{ encoding: 'utf8' },
|
|
16
|
+
);
|
|
17
|
+
return JSON.parse(out);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function walkFiles(root, matcher) {
|
|
21
|
+
const results = [];
|
|
22
|
+
function walk(dir) {
|
|
23
|
+
if (!fs.existsSync(dir)) return;
|
|
24
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
25
|
+
const full = path.join(dir, entry.name);
|
|
26
|
+
if (entry.isDirectory()) {
|
|
27
|
+
walk(full);
|
|
28
|
+
} else if (matcher(full)) {
|
|
29
|
+
results.push(full);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
walk(root);
|
|
34
|
+
return results;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function globFiles(projectRoot, pattern) {
|
|
38
|
+
// Supports patterns like game/**/*.js, game/**/*.ts, game/**/*.tsx
|
|
39
|
+
const normalized = pattern.replace(/\\/g, '/');
|
|
40
|
+
const recursive = normalized.match(/^(.*)\/\*\*\/\*\.([A-Za-z0-9]+)$/);
|
|
41
|
+
if (recursive) {
|
|
42
|
+
const base = recursive[1];
|
|
43
|
+
const ext = `.${recursive[2]}`;
|
|
44
|
+
const baseDir = path.join(projectRoot, base);
|
|
45
|
+
return walkFiles(baseDir, (f) => f.endsWith(ext));
|
|
46
|
+
}
|
|
47
|
+
const direct = path.join(projectRoot, normalized);
|
|
48
|
+
return fs.existsSync(direct) ? [direct] : [];
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
module.exports = { loadProfile, globFiles };
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"""Load and validate playable.ui.profile.yaml against JSON Schema."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import json
|
|
6
|
+
from pathlib import Path
|
|
7
|
+
from typing import Any
|
|
8
|
+
|
|
9
|
+
import yaml
|
|
10
|
+
|
|
11
|
+
SKILL_ROOT = Path(__file__).resolve().parents[2]
|
|
12
|
+
DEFAULT_SCHEMA = SKILL_ROOT / "schema" / "playable-ui-profile.schema.json"
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def load_schema(schema_path: Path | None = None) -> dict[str, Any]:
|
|
16
|
+
path = schema_path or DEFAULT_SCHEMA
|
|
17
|
+
with path.open(encoding="utf-8") as fh:
|
|
18
|
+
return json.load(fh)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def load_profile(
|
|
22
|
+
profile_path: Path,
|
|
23
|
+
*,
|
|
24
|
+
schema_path: Path | None = None,
|
|
25
|
+
validate: bool = True,
|
|
26
|
+
) -> dict[str, Any]:
|
|
27
|
+
with profile_path.open(encoding="utf-8") as fh:
|
|
28
|
+
profile = yaml.safe_load(fh)
|
|
29
|
+
|
|
30
|
+
if not isinstance(profile, dict):
|
|
31
|
+
raise ValueError(f"Profile must be a mapping: {profile_path}")
|
|
32
|
+
|
|
33
|
+
if validate:
|
|
34
|
+
validate_profile(profile, schema_path=schema_path)
|
|
35
|
+
|
|
36
|
+
return profile
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
def validate_profile(profile: dict[str, Any], *, schema_path: Path | None = None) -> None:
|
|
40
|
+
try:
|
|
41
|
+
import jsonschema
|
|
42
|
+
except ImportError as exc:
|
|
43
|
+
raise RuntimeError("jsonschema is required: pip install jsonschema") from exc
|
|
44
|
+
|
|
45
|
+
schema = load_schema(schema_path)
|
|
46
|
+
jsonschema.validate(instance=profile, schema=schema)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
def resolve_project_path(profile_path: Path, relative: str) -> Path:
|
|
50
|
+
return (profile_path.parent / relative).resolve()
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def get_paths(profile: dict[str, Any], profile_path: Path) -> dict[str, Path]:
|
|
54
|
+
paths_cfg = profile.get("paths", {})
|
|
55
|
+
return {
|
|
56
|
+
key: resolve_project_path(profile_path, value)
|
|
57
|
+
for key, value in paths_cfg.items()
|
|
58
|
+
if isinstance(value, str)
|
|
59
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
"""Unified pass / warn / fail reporting for UI verification scripts."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import json
|
|
6
|
+
import sys
|
|
7
|
+
from dataclasses import asdict, dataclass, field
|
|
8
|
+
from enum import Enum
|
|
9
|
+
from typing import Any
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class Status(str, Enum):
|
|
13
|
+
PASS = "pass"
|
|
14
|
+
WARN = "warn"
|
|
15
|
+
FAIL = "fail"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
@dataclass
|
|
19
|
+
class Finding:
|
|
20
|
+
check: str
|
|
21
|
+
status: Status
|
|
22
|
+
message: str
|
|
23
|
+
details: dict[str, Any] = field(default_factory=dict)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
@dataclass
|
|
27
|
+
class Report:
|
|
28
|
+
findings: list[Finding] = field(default_factory=list)
|
|
29
|
+
metadata: dict[str, Any] = field(default_factory=dict)
|
|
30
|
+
|
|
31
|
+
def add(self, check: str, status: Status | str, message: str, **details: Any) -> None:
|
|
32
|
+
if isinstance(status, str):
|
|
33
|
+
status = Status(status)
|
|
34
|
+
self.findings.append(Finding(check=check, status=status, message=message, details=details))
|
|
35
|
+
|
|
36
|
+
def pass_(self, check: str, message: str, **details: Any) -> None:
|
|
37
|
+
self.add(check, Status.PASS, message, **details)
|
|
38
|
+
|
|
39
|
+
def warn(self, check: str, message: str, **details: Any) -> None:
|
|
40
|
+
self.add(check, Status.WARN, message, **details)
|
|
41
|
+
|
|
42
|
+
def fail(self, check: str, message: str, **details: Any) -> None:
|
|
43
|
+
self.add(check, Status.FAIL, message, **details)
|
|
44
|
+
|
|
45
|
+
@property
|
|
46
|
+
def worst(self) -> Status:
|
|
47
|
+
order = {Status.PASS: 0, Status.WARN: 1, Status.FAIL: 2}
|
|
48
|
+
if not self.findings:
|
|
49
|
+
return Status.PASS
|
|
50
|
+
return max(self.findings, key=lambda f: order[f.status]).status
|
|
51
|
+
|
|
52
|
+
@property
|
|
53
|
+
def exit_code(self) -> int:
|
|
54
|
+
return 1 if self.worst == Status.FAIL else 0
|
|
55
|
+
|
|
56
|
+
def counts(self) -> dict[str, int]:
|
|
57
|
+
counts = {s.value: 0 for s in Status}
|
|
58
|
+
for finding in self.findings:
|
|
59
|
+
counts[finding.status.value] += 1
|
|
60
|
+
return counts
|
|
61
|
+
|
|
62
|
+
def merge(self, other: Report) -> None:
|
|
63
|
+
self.findings.extend(other.findings)
|
|
64
|
+
|
|
65
|
+
def print_summary(self, title: str = "Playable UI Verification") -> None:
|
|
66
|
+
counts = self.counts()
|
|
67
|
+
print(f"\n=== {title} ===")
|
|
68
|
+
for finding in self.findings:
|
|
69
|
+
icon = {"pass": "✓", "warn": "!", "fail": "✗"}[finding.status.value]
|
|
70
|
+
print(f" [{icon}] {finding.check}: {finding.message}")
|
|
71
|
+
print(
|
|
72
|
+
f"\nSummary: {counts['pass']} pass, {counts['warn']} warn, {counts['fail']} fail"
|
|
73
|
+
)
|
|
74
|
+
if self.worst == Status.FAIL:
|
|
75
|
+
print("Result: FAIL")
|
|
76
|
+
elif self.worst == Status.WARN:
|
|
77
|
+
print("Result: PASS (with warnings)")
|
|
78
|
+
else:
|
|
79
|
+
print("Result: PASS")
|
|
80
|
+
|
|
81
|
+
def to_json(self) -> dict[str, Any]:
|
|
82
|
+
payload = {
|
|
83
|
+
"summary": self.counts(),
|
|
84
|
+
"worst": self.worst.value,
|
|
85
|
+
"findings": [
|
|
86
|
+
{**asdict(f), "status": f.status.value}
|
|
87
|
+
for f in self.findings
|
|
88
|
+
],
|
|
89
|
+
}
|
|
90
|
+
payload.update(self.metadata)
|
|
91
|
+
return payload
|
|
92
|
+
|
|
93
|
+
def write_json(self, path: str) -> None:
|
|
94
|
+
with open(path, "w", encoding="utf-8") as fh:
|
|
95
|
+
json.dump(self.to_json(), fh, indent=2, ensure_ascii=False)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
def exit_with_report(report: Report, *, json_path: str | None = None, json_stdout: bool = False) -> None:
|
|
99
|
+
if json_stdout:
|
|
100
|
+
print(json.dumps(report.to_json(), ensure_ascii=False))
|
|
101
|
+
elif json_path:
|
|
102
|
+
report.write_json(json_path)
|
|
103
|
+
report.print_summary()
|
|
104
|
+
else:
|
|
105
|
+
report.print_summary()
|
|
106
|
+
sys.exit(report.exit_code)
|