mirror of
https://github.com/garrytan/gstack.git
synced 2026-05-01 19:25:10 +02:00
9e244c0bed
* feat: plan-mode handshake for interactive review skills Add a preamble-level STOP-Ask handshake that fires when the user invokes any of the 4 interactive review skills (plan-ceo-review, plan-eng-review, plan-design-review, plan-devex-review) while their Claude Code session is in plan mode. Without this gate, plan mode's "this supercedes any other instructions" system-reminder outranked the skills' interactive STOP gates and the skills silently wrote plan files without any per-finding AskUserQuestion. The handshake offers 2 options (exit-and-rerun, cancel) — the original third "stay and batch" option was dropped after two independent reviewers flagged it as a silent bypass of the skills' anti-skip rule. Architecture decisions (CEO+Eng review): - Preamble-level resolver, not per-template injection (Codex finding #2) - Position 1 in preamble composition: after bash block (_SESSION_ID live), before onboarding AskUserQuestion gates (so fresh-install users see the handshake first, not drowned in telemetry/proactive/routing prompts) - Generator-only `interactive: true` frontmatter flag, following the `preamble-tier` precedent (no host-config frontmatter allowlist edits) - Host-scoped to Claude via `ctx.host === 'claude'` check inside the resolver (simpler than `suppressedResolvers` which only gates `{{}}` placeholders) - One-way-door classification in scripts/question-registry.ts for all 4 skills so question-tuning `never-ask` preferences can't suppress the gate - Synchronous telemetry write to ~/.gstack/analytics/skill-usage.jsonl on handshake fire (captures A-exit and C-cancel outcomes that terminate the skill before end-of-run telemetry runs) Also adds an explicit STOP block to plan-ceo-review Step 0C-bis so the approach-selection question can't silently skip to mode selection. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * feat: extend agent-sdk-runner with canUseTool for AskUserQuestion interception Test harness at test/helpers/agent-sdk-runner.ts gains an optional `canUseTool` callback parameter. When a test supplies it, the harness flips `permissionMode` from `bypassPermissions` (overlay-harness default) to `default` so the SDK actually invokes the callback on every tool use, and auto-adds `AskUserQuestion` to `allowedTools` so Claude can fire it at all. Exports a `passThroughNonAskUserQuestion` helper so tests that only want to intercept AskUserQuestion can auto-allow every other tool with one line: `return passThroughNonAskUserQuestion(toolName, input)`. This is the foundation for D14 — every future interactive-skill E2E test can now assert on AskUserQuestion shape and routing. Previous E2E tests at `test/skill-e2e.test.ts` explicitly instructed the model to skip AskUserQuestion ("non-interactive run") which meant no test could actually verify the question content or routing. 6 new unit tests in test/agent-sdk-runner.test.ts cover: - permissionMode flips to 'default' when canUseTool supplied - permissionMode stays 'bypassPermissions' when canUseTool absent - canUseTool callback reaches the SDK options - AskUserQuestion auto-added to allowedTools when canUseTool supplied - AskUserQuestion NOT added when canUseTool absent - passThroughNonAskUserQuestion helper returns allow+updatedInput Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * test: plan-mode handshake E2E coverage and unit assertions Adds 6 E2E test files and 8 new unit assertions to verify the plan-mode handshake works end-to-end and stays correct under regeneration. E2E tests (gate-tier, paid, EVALS=1 EVALS_TIER=gate): - test/skill-e2e-plan-ceo-plan-mode.test.ts — handshake fires before any Write/Edit when plan-mode distinctive phrase is present; 2-option shape (Exit/Cancel); option A routes to ExitPlanMode cleanly - test/skill-e2e-plan-eng-plan-mode.test.ts — same contract for plan-eng - test/skill-e2e-plan-design-plan-mode.test.ts — same contract for plan-design; exercises C-cancel branch instead of A-exit - test/skill-e2e-plan-devex-plan-mode.test.ts — same contract for plan-devex - test/skill-e2e-plan-mode-no-op.test.ts — negative regression: handshake must NOT fire when distinctive phrase is absent; skill proceeds normally through Step 0 (REGRESSION RULE guardrail against breaking existing interactive-review sessions) - test/e2e-harness-audit.test.ts — free unit test asserting every `interactive: true` skill has at least one canUseTool-using test file (prevents future drift where a skill opts in without coverage) Shared helper test/helpers/plan-mode-handshake-helpers.ts centralizes the canUseTool interceptor + distinctive-phrase injection so the 4 sibling E2E tests are thin wiring (~20 LOC each) and can't drift out of sync. Unit assertions added to test/gen-skill-docs.test.ts: - handshake section present in all 4 Claude-generated SKILL.md files - handshake section absent from non-interactive Claude skills (ship, review, qa, office-hours, codex, retro, cso) - handshake section absent from non-Claude host outputs (.agents, etc.) - 0C-bis STOP block present in plan-ceo-review/SKILL.md at correct position (between the "Present these approach options" line and "### 0D-prelude" header) - handshake resolver wired BEFORE generateUpgradeCheck in preamble composition order 6 new gate-tier entries added to test/helpers/touchfiles.ts so any change to the handshake resolver, preamble composition, skill templates, question registry, one-way-door classifier, or agent-sdk-runner fires the relevant E2E tests. test/touchfiles.test.ts updated for the new selection count (plan-ceo-review/** now triggers 15 tests, up from 8). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * chore(v1.11.1.0): VERSION bump + CHANGELOG entry + TODOS follow-ups Bumps from main's v1.11.0.0 to v1.11.1.0 (PATCH — bug-fix release, no new user-facing artifacts). CHANGELOG entry covers the plan-mode handshake, agent-sdk-runner canUseTool extension, and the 2 follow-up TODOs. CHANGELOG order: v1.11.1.0 (this) → v1.11.0.0 (workspace-aware ship, merged from main) → v1.10.1.0 (overlay efficacy harness). No duplicate headers. Syncs package.json version to match VERSION per the Step 12 idempotency invariant (both files must agree or /ship halts). TODOS.md: - Preserves the Testing/security-bench-haiku-responses P1 added on main - Adds P1 "Structural STOP-Ask forcing function" — broader class of the bug this release fixes - Adds P2 "Apply interactive: true to non-review skills (office-hours, codex, investigate, qa, retro, cso)" Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
120 lines
5.9 KiB
TypeScript
120 lines
5.9 KiB
TypeScript
/**
|
|
* Preamble composition root.
|
|
*
|
|
* Each generator lives in its own file under ./preamble/*.ts. This file only
|
|
* wires them together via generatePreamble(). Keep composition declarative —
|
|
* no inline logic beyond tier gating.
|
|
*
|
|
* Each skill runs independently via `claude -p` (or the host's equivalent).
|
|
* There is no shared loader. The preamble provides: update checks, session
|
|
* tracking, user preferences, repo mode detection, model overlays, and
|
|
* telemetry.
|
|
*
|
|
* Telemetry data flow:
|
|
* 1. Always: local JSONL append to ~/.gstack/analytics/ (inline, inspectable)
|
|
* 2. If _TEL != "off" AND binary exists: gstack-telemetry-log for remote reporting
|
|
*/
|
|
|
|
|
|
import type { TemplateContext } from './types';
|
|
import { generateModelOverlay } from './model-overlay';
|
|
import { generateQuestionTuning } from './question-tuning';
|
|
|
|
// Core bootstrap
|
|
import { generatePreambleBash } from './preamble/generate-preamble-bash';
|
|
import { generatePlanModeHandshake } from './preamble/generate-plan-mode-handshake';
|
|
import { generateUpgradeCheck } from './preamble/generate-upgrade-check';
|
|
import { generateCompletionStatus } from './preamble/generate-completion-status';
|
|
|
|
// One-time onboarding prompts
|
|
import { generateLakeIntro } from './preamble/generate-lake-intro';
|
|
import { generateTelemetryPrompt } from './preamble/generate-telemetry-prompt';
|
|
import { generateProactivePrompt } from './preamble/generate-proactive-prompt';
|
|
import { generateRoutingInjection } from './preamble/generate-routing-injection';
|
|
import { generateVendoringDeprecation } from './preamble/generate-vendoring-deprecation';
|
|
import { generateSpawnedSessionCheck } from './preamble/generate-spawned-session-check';
|
|
import { generateWritingStyleMigration } from './preamble/generate-writing-style-migration';
|
|
|
|
// Host-specific instructions
|
|
import { generateBrainHealthInstruction } from './preamble/generate-brain-health-instruction';
|
|
|
|
// GBrain cross-machine sync (runs at skill start; end-side handled in completion-status)
|
|
import { generateBrainSyncBlock } from './preamble/generate-brain-sync-block';
|
|
|
|
// Behavioral / voice
|
|
import { generateVoiceDirective } from './preamble/generate-voice-directive';
|
|
|
|
// Tier 2+ context and interaction framework
|
|
import { generateContextRecovery } from './preamble/generate-context-recovery';
|
|
import { generateAskUserFormat } from './preamble/generate-ask-user-format';
|
|
import { generateWritingStyle } from './preamble/generate-writing-style';
|
|
import { generateCompletenessSection } from './preamble/generate-completeness-section';
|
|
import { generateConfusionProtocol } from './preamble/generate-confusion-protocol';
|
|
import { generateContinuousCheckpoint } from './preamble/generate-continuous-checkpoint';
|
|
import { generateContextHealth } from './preamble/generate-context-health';
|
|
|
|
// Tier 3+ repo mode + search
|
|
import { generateRepoModeSection } from './preamble/generate-repo-mode-section';
|
|
import { generateSearchBeforeBuildingSection } from './preamble/generate-search-before-building';
|
|
|
|
// Standalone export used directly by the resolver registry
|
|
export { generateTestFailureTriage } from './preamble/generate-test-failure-triage';
|
|
|
|
// Preamble Composition (tier → sections)
|
|
// ─────────────────────────────────────────────
|
|
// T1: core + upgrade + lake + telemetry + voice(trimmed) + completion
|
|
// T2: T1 + voice(full) + ask + completeness + context-recovery + confusion + checkpoint + context-health
|
|
// T3: T2 + repo-mode + search
|
|
// T4: (same as T3 — TEST_FAILURE_TRIAGE is a separate {{}} placeholder, not preamble)
|
|
//
|
|
// Skills by tier:
|
|
// T1: browse, setup-cookies, benchmark
|
|
// T2: investigate, cso, retro, doc-release, setup-deploy, canary, context-save, context-restore, health
|
|
// T3: autoplan, codex, design-consult, office-hours, ceo/design/eng-review
|
|
// T4: ship, review, qa, qa-only, design-review, land-deploy
|
|
export function generatePreamble(ctx: TemplateContext): string {
|
|
const tier = ctx.preambleTier ?? 4;
|
|
if (tier < 1 || tier > 4) {
|
|
throw new Error(`Invalid preamble-tier: ${tier} in ${ctx.tmplPath}. Must be 1-4.`);
|
|
}
|
|
const sections = [
|
|
generatePreambleBash(ctx),
|
|
// Plan-mode handshake at position 1: after bash (so _SESSION_ID / _BRANCH /
|
|
// _TEL env vars are live for the synchronous telemetry write) and before
|
|
// all onboarding AskUserQuestion gates (so fresh-install users in plan mode
|
|
// see the handshake first, not drowned in telemetry / proactive / routing
|
|
// prompts). Host-scoped to Claude + interactive-frontmatter-scoped inside
|
|
// the resolver — no-op for every other skill/host combination.
|
|
generatePlanModeHandshake(ctx),
|
|
generateUpgradeCheck(ctx),
|
|
generateWritingStyleMigration(ctx),
|
|
generateLakeIntro(),
|
|
generateTelemetryPrompt(ctx),
|
|
generateProactivePrompt(ctx),
|
|
generateRoutingInjection(ctx),
|
|
generateVendoringDeprecation(ctx),
|
|
generateSpawnedSessionCheck(),
|
|
generateBrainHealthInstruction(ctx),
|
|
// AskUserQuestion Format renders BEFORE the model overlay so the pacing rule
|
|
// is the ambient default; the overlay's behavioral nudges land as subordinate
|
|
// patches. Opus 4.7 reads top-to-bottom and absorbs the first pacing directive
|
|
// it hits; reversing this order regresses plan-review cadence (v1.6.4.0 bug).
|
|
...(tier >= 2 ? [generateAskUserFormat(ctx)] : []),
|
|
generateBrainSyncBlock(ctx),
|
|
generateModelOverlay(ctx),
|
|
generateVoiceDirective(tier),
|
|
...(tier >= 2 ? [
|
|
generateContextRecovery(ctx),
|
|
generateWritingStyle(ctx),
|
|
generateCompletenessSection(),
|
|
generateConfusionProtocol(),
|
|
generateContinuousCheckpoint(),
|
|
generateContextHealth(),
|
|
generateQuestionTuning(ctx),
|
|
] : []),
|
|
...(tier >= 3 ? [generateRepoModeSection(), generateSearchBeforeBuildingSection(ctx)] : []),
|
|
generateCompletionStatus(ctx),
|
|
];
|
|
return sections.filter(s => s && s.trim().length > 0).join('\n\n');
|
|
}
|