@playcraft/cli 0.0.57 → 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 +34 -16
- 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/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 +2 -0
- package/dist/remix/init-template.js +2 -0
- package/dist/remix/pull.js +2 -0
- package/dist/remix/push.js +21 -1
- 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 +4 -1
- 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,243 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* PlayCraft milestone snapshot hook.
|
|
4
|
+
*
|
|
5
|
+
* Triggered on SubagentStop. Reads project-state.md
|
|
6
|
+
* → Agent handoff YAML to detect key milestones, then runs snapshot.mjs to archive
|
|
7
|
+
* current project state.
|
|
8
|
+
*
|
|
9
|
+
* Milestones (only snapshot once each):
|
|
10
|
+
* - ring-1-archived iteration >= 2 or archivedRings contains ring 1
|
|
11
|
+
* - ring-2-archived iteration >= 3 or archivedRings contains ring 2
|
|
12
|
+
* - ring-3-archived iteration >= 4 or archivedRings contains ring 3
|
|
13
|
+
* - dev-ready devStatus: ready (Dev Preview table)
|
|
14
|
+
* - ring-4-done ringGateVerdict pass on iteration 4
|
|
15
|
+
*
|
|
16
|
+
* Exit 0 always — snapshot failures are non-blocking.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
import fs from 'node:fs';
|
|
20
|
+
import path from 'node:path';
|
|
21
|
+
import { spawnSync } from 'node:child_process';
|
|
22
|
+
import { fileURLToPath } from 'node:url';
|
|
23
|
+
|
|
24
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
25
|
+
const __dirname = path.dirname(__filename);
|
|
26
|
+
|
|
27
|
+
// ── helpers ──────────────────────────────────────────────────────────────────
|
|
28
|
+
|
|
29
|
+
function resolveProjectDir() {
|
|
30
|
+
const raw =
|
|
31
|
+
process.env.CODEBUDDY_PROJECT_DIR ||
|
|
32
|
+
process.env.CLAUDE_PROJECT_DIR ||
|
|
33
|
+
process.env.CURSOR_PROJECT_DIR ||
|
|
34
|
+
process.cwd();
|
|
35
|
+
if (process.platform === 'win32' && /^\/[a-zA-Z]\//.test(raw)) {
|
|
36
|
+
return raw[1].toUpperCase() + ':' + raw.slice(2).replace(/\//g, '\\');
|
|
37
|
+
}
|
|
38
|
+
return path.resolve(raw);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
function readProjectState(projectDir) {
|
|
42
|
+
const statePath = path.join(projectDir, 'docs', 'project-state.md');
|
|
43
|
+
if (!fs.existsSync(statePath)) return null;
|
|
44
|
+
return fs.readFileSync(statePath, 'utf8');
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Parse the `## Agent handoff` YAML block from project-state.md.
|
|
49
|
+
*/
|
|
50
|
+
function parseHandoff(content) {
|
|
51
|
+
const fenceStart = content.indexOf('```yaml');
|
|
52
|
+
if (fenceStart === -1) return null;
|
|
53
|
+
|
|
54
|
+
const afterFence = content.indexOf('\n', fenceStart);
|
|
55
|
+
if (afterFence === -1) return null;
|
|
56
|
+
|
|
57
|
+
const fenceEnd = content.indexOf('```', afterFence);
|
|
58
|
+
if (fenceEnd === -1) return null;
|
|
59
|
+
|
|
60
|
+
const yamlBlock = content.slice(afterFence, fenceEnd);
|
|
61
|
+
|
|
62
|
+
const result = {};
|
|
63
|
+
for (const line of yamlBlock.split('\n')) {
|
|
64
|
+
const trimmed = line.trim();
|
|
65
|
+
if (!trimmed || trimmed.startsWith('#')) continue;
|
|
66
|
+
|
|
67
|
+
const colonIdx = trimmed.indexOf(':');
|
|
68
|
+
if (colonIdx === -1) continue;
|
|
69
|
+
|
|
70
|
+
const key = trimmed.slice(0, colonIdx).trim();
|
|
71
|
+
let value = trimmed.slice(colonIdx + 1).trim();
|
|
72
|
+
|
|
73
|
+
if ((value.startsWith('"') && value.endsWith('"')) ||
|
|
74
|
+
(value.startsWith("'") && value.endsWith("'"))) {
|
|
75
|
+
value = value.slice(1, -1);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
if (value === 'true') result[key] = true;
|
|
79
|
+
else if (value === 'false') result[key] = false;
|
|
80
|
+
else if (value === 'null' || value === '') result[key] = null;
|
|
81
|
+
else result[key] = value;
|
|
82
|
+
}
|
|
83
|
+
return result;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** @param {string} content */
|
|
87
|
+
function parseIteration(content) {
|
|
88
|
+
const handoff = parseHandoff(content);
|
|
89
|
+
if (handoff?.iteration) {
|
|
90
|
+
const n = Number(handoff.iteration);
|
|
91
|
+
if (Number.isFinite(n) && n >= 1) return n;
|
|
92
|
+
}
|
|
93
|
+
const m = content.match(/^\s*iteration:\s*(\d+)\s*$/im);
|
|
94
|
+
return m ? Number(m[1]) : 1;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/** @param {string} content @param {number} ring */
|
|
98
|
+
function hasArchivedRing(content, ring) {
|
|
99
|
+
const lineMatch = content.match(/^\s*archivedRings:\s*(.+)\s*$/im);
|
|
100
|
+
if (lineMatch && new RegExp(`\\b${ring}\\s*:`).test(lineMatch[1])) {
|
|
101
|
+
return true;
|
|
102
|
+
}
|
|
103
|
+
const tableRe = new RegExp(`^\\|\\s*${ring}\\s*\\|`, 'm');
|
|
104
|
+
return tableRe.test(content);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/** @param {string} content */
|
|
108
|
+
function parseDevStatus(content) {
|
|
109
|
+
const m = content.match(/^\|\s*devStatus\s*\|\s*(\w+)\s*\|/im);
|
|
110
|
+
return m ? m[1].toLowerCase() : null;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/** @param {string} content */
|
|
114
|
+
function parseRingGateVerdict(content) {
|
|
115
|
+
const m = content.match(/^\|\s*ringGateVerdict\s*\|\s*(\w+)\s*\|/im);
|
|
116
|
+
return m ? m[1].toLowerCase() : null;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Determine which milestones have been reached based on current state.
|
|
121
|
+
* @param {string} content
|
|
122
|
+
*/
|
|
123
|
+
function detectMilestones(content) {
|
|
124
|
+
const milestones = [];
|
|
125
|
+
const iteration = parseIteration(content);
|
|
126
|
+
|
|
127
|
+
if (iteration >= 2 || hasArchivedRing(content, 1)) {
|
|
128
|
+
milestones.push('ring-1-archived');
|
|
129
|
+
}
|
|
130
|
+
if (iteration >= 3 || hasArchivedRing(content, 2)) {
|
|
131
|
+
milestones.push('ring-2-archived');
|
|
132
|
+
}
|
|
133
|
+
if (iteration >= 4 || hasArchivedRing(content, 3)) {
|
|
134
|
+
milestones.push('ring-3-archived');
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
if (parseDevStatus(content) === 'ready') {
|
|
138
|
+
milestones.push('dev-ready');
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
if (iteration >= 4 && parseRingGateVerdict(content) === 'pass') {
|
|
142
|
+
milestones.push('ring-4-done');
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
return milestones;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
function loadSnapshotState(projectDir) {
|
|
149
|
+
const statePath = path.join(projectDir, '.claude', 'hooks', '.snapshot-state.json');
|
|
150
|
+
try {
|
|
151
|
+
if (fs.existsSync(statePath)) {
|
|
152
|
+
return JSON.parse(fs.readFileSync(statePath, 'utf8'));
|
|
153
|
+
}
|
|
154
|
+
} catch {
|
|
155
|
+
// ignore
|
|
156
|
+
}
|
|
157
|
+
return {};
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
function saveSnapshotState(projectDir, state) {
|
|
161
|
+
const statePath = path.join(projectDir, '.claude', 'hooks', '.snapshot-state.json');
|
|
162
|
+
const dir = path.dirname(statePath);
|
|
163
|
+
if (!fs.existsSync(dir)) {
|
|
164
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
165
|
+
}
|
|
166
|
+
fs.writeFileSync(statePath, JSON.stringify(state, null, 2));
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
function resolveSnapshotScript() {
|
|
170
|
+
const local = path.resolve(__dirname, '..', 'snapshot.mjs');
|
|
171
|
+
if (fs.existsSync(local)) return local;
|
|
172
|
+
|
|
173
|
+
const candidate = path.resolve(__dirname, '..', '..', '..', 'snapshot.mjs');
|
|
174
|
+
if (fs.existsSync(candidate)) return candidate;
|
|
175
|
+
|
|
176
|
+
return null;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
function runSnapshot(projectDir, label) {
|
|
180
|
+
const snapshotScript = resolveSnapshotScript();
|
|
181
|
+
|
|
182
|
+
if (!snapshotScript) {
|
|
183
|
+
process.stderr.write('[snapshot-milestone] snapshot script not found\n');
|
|
184
|
+
return false;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
const result = spawnSync('node', [
|
|
188
|
+
snapshotScript,
|
|
189
|
+
'--project', projectDir,
|
|
190
|
+
'--name', label,
|
|
191
|
+
'--force', // non-interactive hook — skip active-CLI check
|
|
192
|
+
], {
|
|
193
|
+
encoding: 'utf8',
|
|
194
|
+
timeout: 120_000, // git add/commit may be slower than zip
|
|
195
|
+
stdio: ['ignore', 'pipe', 'pipe'],
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
if (result.status !== 0) {
|
|
199
|
+
process.stderr.write(`[snapshot-milestone] snapshot failed (${label}): ${result.stderr}\n`);
|
|
200
|
+
return false;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
process.stderr.write(`[snapshot-milestone] snapshot committed: ${label}\n`);
|
|
204
|
+
return true;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
function main() {
|
|
208
|
+
const projectDir = resolveProjectDir();
|
|
209
|
+
const content = readProjectState(projectDir);
|
|
210
|
+
|
|
211
|
+
if (!content) {
|
|
212
|
+
process.exit(0);
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
const currentMilestones = detectMilestones(content);
|
|
216
|
+
|
|
217
|
+
if (currentMilestones.length === 0) {
|
|
218
|
+
process.exit(0);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const snapshotState = loadSnapshotState(projectDir);
|
|
222
|
+
let anyNew = false;
|
|
223
|
+
|
|
224
|
+
for (const milestone of currentMilestones) {
|
|
225
|
+
if (snapshotState[milestone]) {
|
|
226
|
+
continue;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
anyNew = true;
|
|
230
|
+
const ok = runSnapshot(projectDir, milestone);
|
|
231
|
+
if (ok) {
|
|
232
|
+
snapshotState[milestone] = new Date().toISOString();
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
if (anyNew) {
|
|
237
|
+
saveSnapshotState(projectDir, snapshotState);
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
process.exit(0);
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
main();
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* PlayCraft User Prompt Hook — fires on every UserPromptSubmit.
|
|
4
|
+
*
|
|
5
|
+
* Actions:
|
|
6
|
+
* 1. Increment turn counter, log to logs/hook.log
|
|
7
|
+
* 2. Snapshot (always, for full audit trail)
|
|
8
|
+
* Output goes to ../ to avoid nesting.
|
|
9
|
+
*
|
|
10
|
+
* Claude Code / CodeBuddy version — uses CODEBUDDY_PROJECT_DIR / CLAUDE_PROJECT_DIR.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import fs from 'node:fs';
|
|
14
|
+
import path from 'node:path';
|
|
15
|
+
import { fileURLToPath } from 'node:url';
|
|
16
|
+
import { spawnSync } from 'node:child_process';
|
|
17
|
+
|
|
18
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
19
|
+
const __dirname = path.dirname(__filename);
|
|
20
|
+
|
|
21
|
+
// ── helpers ──────────────────────────────────────────────────────────────────
|
|
22
|
+
|
|
23
|
+
function resolveProjectDir() {
|
|
24
|
+
const raw = process.env.CODEBUDDY_PROJECT_DIR || process.env.CLAUDE_PROJECT_DIR || process.cwd();
|
|
25
|
+
if (process.platform === 'win32' && /^\/[a-zA-Z]\//.test(raw))
|
|
26
|
+
return raw[1].toUpperCase() + ':' + raw.slice(2).replace(/\//g, '\\');
|
|
27
|
+
return path.resolve(raw);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function loadState(projectDir) {
|
|
31
|
+
const p = path.join(projectDir, '.claude', 'logs', 'session.json');
|
|
32
|
+
try { if (fs.existsSync(p)) return JSON.parse(fs.readFileSync(p, 'utf8')); }
|
|
33
|
+
catch {}
|
|
34
|
+
return { turns: 0 };
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function saveState(projectDir, state) {
|
|
38
|
+
const d = path.join(projectDir, '.claude', 'logs');
|
|
39
|
+
fs.mkdirSync(d, { recursive: true });
|
|
40
|
+
fs.writeFileSync(path.join(d, 'session.json'), JSON.stringify(state, null, 2));
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
async function readStdin() {
|
|
44
|
+
const chunks = [];
|
|
45
|
+
for await (const chunk of process.stdin) {
|
|
46
|
+
chunks.push(chunk);
|
|
47
|
+
}
|
|
48
|
+
const raw = Buffer.concat(chunks).toString('utf8');
|
|
49
|
+
try { return raw.trim() ? JSON.parse(raw) : null; }
|
|
50
|
+
catch { return null; }
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function sanitize(text, maxLen = 20) {
|
|
54
|
+
return (text || '')
|
|
55
|
+
.replace(/[^\w一-鿿 -]/g, '')
|
|
56
|
+
.replace(/\s+/g, '-')
|
|
57
|
+
.replace(/-+/g, '-')
|
|
58
|
+
.replace(/^-|-$/g, '')
|
|
59
|
+
.slice(0, maxLen)
|
|
60
|
+
.replace(/-$/, '');
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// ── snapshot ─────────────────────────────────────────────────────────────────
|
|
64
|
+
|
|
65
|
+
function runSnapshot(projectDir, state, promptText) {
|
|
66
|
+
const snapScript = path.join(__dirname, '..', 'snapshot.mjs');
|
|
67
|
+
|
|
68
|
+
if (!fs.existsSync(snapScript)) {
|
|
69
|
+
console.error('[snap] script not found');
|
|
70
|
+
return null;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const prefix = sanitize(promptText, 20);
|
|
74
|
+
const snapName = prefix ? `prompt_${prefix}` : `prompt_turn-${state.turns}`;
|
|
75
|
+
|
|
76
|
+
const r = spawnSync('node', [
|
|
77
|
+
snapScript, '--project', projectDir, '--name', snapName, '--force',
|
|
78
|
+
], { encoding: 'utf8', timeout: 120_000, stdio: 'pipe' });
|
|
79
|
+
|
|
80
|
+
if (r.status !== 0) {
|
|
81
|
+
console.error(`[snap] failed: ${r.stderr?.slice(0, 200)}`);
|
|
82
|
+
return false;
|
|
83
|
+
}
|
|
84
|
+
const m = r.stdout.match(/Hash:\s*(\S+)/);
|
|
85
|
+
const hash = m ? m[1] : null;
|
|
86
|
+
if (hash) console.error(`[snap] ${hash}`);
|
|
87
|
+
return true;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// ── log ──────────────────────────────────────────────────────────────────────
|
|
91
|
+
|
|
92
|
+
function writeHookLog(projectDir, entry) {
|
|
93
|
+
const logPath = path.join(projectDir, 'logs', 'hook.log');
|
|
94
|
+
const dir = path.dirname(logPath);
|
|
95
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
96
|
+
fs.appendFileSync(logPath, entry + '\n');
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
// ── main ─────────────────────────────────────────────────────────────────────
|
|
100
|
+
|
|
101
|
+
async function main() {
|
|
102
|
+
const payload = await readStdin();
|
|
103
|
+
if (!payload) return;
|
|
104
|
+
const promptText = payload.prompt || payload.user_prompt || '';
|
|
105
|
+
if (!promptText) return;
|
|
106
|
+
|
|
107
|
+
const projectDir = resolveProjectDir();
|
|
108
|
+
const state = loadState(projectDir);
|
|
109
|
+
state.turns += 1;
|
|
110
|
+
state.lastPromptAt = new Date().toISOString();
|
|
111
|
+
|
|
112
|
+
const ts = new Date().toLocaleString('zh-CN', { timeZone: 'Asia/Shanghai' });
|
|
113
|
+
const preview = promptText.replace(/\n/g, '\\n').slice(0, 300);
|
|
114
|
+
|
|
115
|
+
// Snapshot (always)
|
|
116
|
+
const snapped = runSnapshot(projectDir, state, promptText);
|
|
117
|
+
if (snapped) state.lastSnapAt = ts;
|
|
118
|
+
|
|
119
|
+
// Detailed log entry
|
|
120
|
+
const lines = [
|
|
121
|
+
'─'.repeat(60),
|
|
122
|
+
`[${ts}] PROMPT #${state.turns}`,
|
|
123
|
+
` Input : ${preview}`,
|
|
124
|
+
` Snapshot: ${snapped ? 'ok' : 'FAILED'}`,
|
|
125
|
+
'─'.repeat(60),
|
|
126
|
+
];
|
|
127
|
+
writeHookLog(projectDir, lines.join('\n'));
|
|
128
|
+
|
|
129
|
+
console.error(`prompt #${state.turns} logged`);
|
|
130
|
+
saveState(projectDir, state);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
main().catch(e => { process.stderr.write('[user-prompt] ' + e.message + '\n'); process.exitCode = 1; });
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"defaultMode": "acceptEdits",
|
|
3
|
+
"env": {
|
|
4
|
+
"CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS": "1"
|
|
5
|
+
},
|
|
6
|
+
"hooks": {
|
|
7
|
+
"SubagentStop": [
|
|
8
|
+
{
|
|
9
|
+
"matcher": "artist|technical-artist|developer|reviewer|game-designer|skill-selector",
|
|
10
|
+
"hooks": [
|
|
11
|
+
{
|
|
12
|
+
"type": "command",
|
|
13
|
+
"command": "node",
|
|
14
|
+
"args": ["${CLAUDE_PROJECT_DIR}/.claude/hooks/snapshot-milestone.mjs"],
|
|
15
|
+
"timeout": 30
|
|
16
|
+
}
|
|
17
|
+
]
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"UserPromptSubmit": [
|
|
21
|
+
{
|
|
22
|
+
"hooks": [
|
|
23
|
+
{
|
|
24
|
+
"type": "command",
|
|
25
|
+
"command": "node",
|
|
26
|
+
"args": ["${CLAUDE_PROJECT_DIR}/.claude/hooks/user-prompt.mjs"],
|
|
27
|
+
"timeout": 30
|
|
28
|
+
}
|
|
29
|
+
]
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
}
|
|
33
|
+
}
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: brainstorming
|
|
3
|
+
description: 'Collaborative ideation for new creative concepts and game design. Use when exploring gameplay directions, clarifying vague creative ideas, or making design decisions from scratch. Not for implementation, code changes, workflow coordination, or routine modifications.'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Brainstorming Ideas Into Designs
|
|
7
|
+
|
|
8
|
+
Help turn ideas into fully formed designs and specs through natural collaborative dialogue.
|
|
9
|
+
|
|
10
|
+
Start by understanding the current project context, then ask questions one at a time to refine the idea. Once you understand what you're building, present the design and get user approval.
|
|
11
|
+
|
|
12
|
+
<HARD-GATE>
|
|
13
|
+
Do NOT invoke any implementation skill, write any code, scaffold any project, or take any implementation action until you have presented a design and the user has approved it. This applies to EVERY project regardless of perceived simplicity.
|
|
14
|
+
</HARD-GATE>
|
|
15
|
+
|
|
16
|
+
## Anti-Pattern: "This Is Too Simple To Need A Design"
|
|
17
|
+
|
|
18
|
+
Every project goes through this process. A todo list, a single-function utility, a config change — all of them. "Simple" projects are where unexamined assumptions cause the most wasted work. The design can be short (a few sentences for truly simple projects), but you MUST present it and get approval.
|
|
19
|
+
|
|
20
|
+
## Checklist
|
|
21
|
+
|
|
22
|
+
You MUST create a task for each of these items and complete them in order:
|
|
23
|
+
|
|
24
|
+
1. **Explore project context** — check files, docs, recent commits
|
|
25
|
+
2. ~~**Offer visual companion**~~ — **SKIPPED in this project.** All brainstorm questions are text/option-based. Do not offer or use the browser visual mode.
|
|
26
|
+
3. **Ask clarifying questions** — self-answer what context already tells you, batch related questions, only ask the user what you genuinely need
|
|
27
|
+
4. **Propose 2-3 approaches** — with trade-offs and your recommendation
|
|
28
|
+
5. **Present design** — at confidence threshold, present full design at once; otherwise section-by-section for uncertain areas
|
|
29
|
+
6. **Write design doc** — save to `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md` and commit
|
|
30
|
+
7. **Spec self-review** — quick inline check for placeholders, contradictions, ambiguity, scope (see below)
|
|
31
|
+
8. **User reviews written spec** — ask user to review the spec file before proceeding
|
|
32
|
+
9. **Transition to implementation** — invoke writing-plans skill to create implementation plan
|
|
33
|
+
|
|
34
|
+
## Process Flow
|
|
35
|
+
|
|
36
|
+
```dot
|
|
37
|
+
digraph brainstorming {
|
|
38
|
+
"Explore project context" [shape=box];
|
|
39
|
+
"Ask clarifying questions" [shape=box];
|
|
40
|
+
"Propose 2-3 approaches" [shape=box];
|
|
41
|
+
"Present design sections" [shape=box];
|
|
42
|
+
"User approves design?" [shape=diamond];
|
|
43
|
+
"Write design doc" [shape=box];
|
|
44
|
+
"Spec self-review\n(fix inline)" [shape=box];
|
|
45
|
+
"User reviews spec?" [shape=diamond];
|
|
46
|
+
"Invoke writing-plans skill" [shape=doublecircle];
|
|
47
|
+
|
|
48
|
+
"Explore project context" -> "Ask clarifying questions";
|
|
49
|
+
"Ask clarifying questions" -> "Propose 2-3 approaches";
|
|
50
|
+
"Propose 2-3 approaches" -> "Present design sections";
|
|
51
|
+
"Present design sections" -> "User approves design?";
|
|
52
|
+
"User approves design?" -> "Present design sections" [label="no, revise"];
|
|
53
|
+
"User approves design?" -> "Write design doc" [label="yes"];
|
|
54
|
+
"Write design doc" -> "Spec self-review\n(fix inline)";
|
|
55
|
+
"Spec self-review\n(fix inline)" -> "User reviews spec?";
|
|
56
|
+
"User reviews spec?" -> "Write design doc" [label="changes requested"];
|
|
57
|
+
"User reviews spec?" -> "Invoke writing-plans skill" [label="approved"];
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**The terminal state is invoking writing-plans.** Do NOT invoke frontend-design, mcp-builder, or any other implementation skill. The ONLY skill you invoke after brainstorming is writing-plans.
|
|
62
|
+
|
|
63
|
+
## The Process
|
|
64
|
+
|
|
65
|
+
**Understanding the idea:**
|
|
66
|
+
|
|
67
|
+
- Check out the current project state first (files, docs, recent commits)
|
|
68
|
+
- Before asking detailed questions, assess scope: if the request describes multiple independent subsystems (e.g., "build a platform with chat, file storage, billing, and analytics"), flag this immediately. Don't spend questions refining details of a project that needs to be decomposed first.
|
|
69
|
+
- If the project is too large for a single spec, help the user decompose into sub-projects: what are the independent pieces, how do they relate, what order should they be built? Then brainstorm the first sub-project through the normal design flow. Each sub-project gets its own spec → plan → implementation cycle.
|
|
70
|
+
- Focus on understanding: purpose, constraints, success criteria
|
|
71
|
+
- **Always use the `AskUserQuestion` tool for terminal questions** — never ask questions as plain text. It renders as a clickable option card with a built-in "Other" free-text input, so every question automatically supports both selection and custom responses with a single confirm action.
|
|
72
|
+
- Single-select (default): for mutually exclusive choices
|
|
73
|
+
- `multiSelect: true`: when multiple answers are valid (e.g., "which features do you want?")
|
|
74
|
+
|
|
75
|
+
**Self-answering & batched questions:**
|
|
76
|
+
|
|
77
|
+
Not every question needs to go to the user. Apply these strategies to reduce round-trips:
|
|
78
|
+
|
|
79
|
+
- **Self-answer when confident:** If the project context (files, docs, conventions) already provides a clear answer, state your assumption inline rather than asking. Format: "Based on [evidence], I'm assuming [X]. (Let me know if this is wrong.)" — this turns a blocking question into a non-blocking assertion.
|
|
80
|
+
- **Batch related questions:** When multiple questions are closely related (e.g., all about the same subsystem or decision area), present them together in one message rather than one-at-a-time. Group 2-4 related questions per turn.
|
|
81
|
+
- **Use an intermediate file for complex question sets:** For topics with many interrelated questions, write them to a scratch file (e.g., `docs/superpowers/specs/.brainstorm-questions-<topic>.md`) so the user can review and answer at their own pace. This is especially useful when questions have dependencies or when the user might want to think before answering.
|
|
82
|
+
- **Still ask one-at-a-time for:** genuinely independent decisions where the answer to one changes what you'd ask next, or high-stakes architectural choices that deserve focused attention.
|
|
83
|
+
|
|
84
|
+
**Exploring approaches:**
|
|
85
|
+
|
|
86
|
+
- Propose 2-3 different approaches with trade-offs
|
|
87
|
+
- Present options conversationally with your recommendation and reasoning
|
|
88
|
+
- Lead with your recommended option and explain why
|
|
89
|
+
|
|
90
|
+
**Presenting the design:**
|
|
91
|
+
|
|
92
|
+
- Once you believe you understand what you're building, present the design
|
|
93
|
+
- Scale each section to its complexity: a few sentences if straightforward, up to 200-300 words if nuanced
|
|
94
|
+
- Cover: architecture, components, data flow, error handling, testing
|
|
95
|
+
- Be ready to go back and clarify if something doesn't make sense
|
|
96
|
+
|
|
97
|
+
**Confidence threshold — when to present all at once:**
|
|
98
|
+
|
|
99
|
+
If the clarifying phase has already aligned understanding sufficiently (e.g., user gave detailed requirements, project context is unambiguous, or you self-answered most questions without objection), present the full design in one message and ask for approval at the end. Reserve section-by-section confirmation for cases where:
|
|
100
|
+
|
|
101
|
+
- The design has genuinely uncertain areas you want early feedback on
|
|
102
|
+
- Multiple sections have competing trade-offs the user should weigh independently
|
|
103
|
+
- The project is large enough that a single message would be overwhelming
|
|
104
|
+
|
|
105
|
+
**Design for isolation and clarity:**
|
|
106
|
+
|
|
107
|
+
- Break the system into smaller units that each have one clear purpose, communicate through well-defined interfaces, and can be understood and tested independently
|
|
108
|
+
- For each unit, you should be able to answer: what does it do, how do you use it, and what does it depend on?
|
|
109
|
+
- Can someone understand what a unit does without reading its internals? Can you change the internals without breaking consumers? If not, the boundaries need work.
|
|
110
|
+
- Smaller, well-bounded units are also easier for you to work with - you reason better about code you can hold in context at once, and your edits are more reliable when files are focused. When a file grows large, that's often a signal that it's doing too much.
|
|
111
|
+
|
|
112
|
+
**Working in existing codebases:**
|
|
113
|
+
|
|
114
|
+
- Explore the current structure before proposing changes. Follow existing patterns.
|
|
115
|
+
- Where existing code has problems that affect the work (e.g., a file that's grown too large, unclear boundaries, tangled responsibilities), include targeted improvements as part of the design - the way a good developer improves code they're working in.
|
|
116
|
+
- Don't propose unrelated refactoring. Stay focused on what serves the current goal.
|
|
117
|
+
|
|
118
|
+
## After the Design
|
|
119
|
+
|
|
120
|
+
**Documentation:**
|
|
121
|
+
|
|
122
|
+
- Write the validated design (spec) to `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md`
|
|
123
|
+
- (User preferences for spec location override this default)
|
|
124
|
+
- Use elements-of-style:writing-clearly-and-concisely skill if available
|
|
125
|
+
- Commit the design document to git
|
|
126
|
+
|
|
127
|
+
**Spec Self-Review:**
|
|
128
|
+
After writing the spec document, look at it with fresh eyes:
|
|
129
|
+
|
|
130
|
+
1. **Placeholder scan:** Any "TBD", "TODO", incomplete sections, or vague requirements? Fix them.
|
|
131
|
+
2. **Internal consistency:** Do any sections contradict each other? Does the architecture match the feature descriptions?
|
|
132
|
+
3. **Scope check:** Is this focused enough for a single implementation plan, or does it need decomposition?
|
|
133
|
+
4. **Ambiguity check:** Could any requirement be interpreted two different ways? If so, pick one and make it explicit.
|
|
134
|
+
|
|
135
|
+
Fix any issues inline. No need to re-review — just fix and move on.
|
|
136
|
+
|
|
137
|
+
**User Review Gate:**
|
|
138
|
+
After the spec review loop passes, ask the user to review the written spec before proceeding:
|
|
139
|
+
|
|
140
|
+
> "Spec written and committed to `<path>`. Please review it and let me know if you want to make any changes before we start writing out the implementation plan."
|
|
141
|
+
|
|
142
|
+
Wait for the user's response. If they request changes, make them and re-run the spec review loop. Only proceed once the user approves.
|
|
143
|
+
|
|
144
|
+
**Implementation:**
|
|
145
|
+
|
|
146
|
+
- Invoke the writing-plans skill to create a detailed implementation plan
|
|
147
|
+
- Do NOT invoke any other skill. writing-plans is the next step.
|
|
148
|
+
|
|
149
|
+
## Key Principles
|
|
150
|
+
|
|
151
|
+
- **Self-answer what you can, ask what you must** - Reduce round-trips by leveraging project context to answer your own questions; only ask the user when genuinely uncertain
|
|
152
|
+
- **Batch related questions** - Group related questions together; only go one-at-a-time for independent high-stakes decisions
|
|
153
|
+
- **Always use `AskUserQuestion`** - Every terminal question must use this tool; it provides clickable options + built-in Other input + confirm in one interaction
|
|
154
|
+
- **YAGNI ruthlessly** - Remove unnecessary features from all designs
|
|
155
|
+
- **Explore alternatives** - Always propose 2-3 approaches before settling
|
|
156
|
+
- **Confidence-driven presentation** - If understanding is already aligned, present the full design at once; only section-by-section when genuinely uncertain
|
|
157
|
+
- **Be flexible** - Go back and clarify when something doesn't make sense
|
|
158
|
+
|
|
159
|
+
## Visual Companion
|
|
160
|
+
|
|
161
|
+
**DISABLED in this project.** All brainstorming is text/option-based. Do not offer, use, or reference the visual companion browser mode.
|