mirror of
https://github.com/garrytan/gstack.git
synced 2026-10-04 10:26:52 +02:00
* refactor(resolvers): split review.ts into MECE resolver modules (pure move) Move every function from scripts/resolvers/review.ts, unchanged, into: - review-dashboard.ts: review dashboard, plan-file review report - plan-gates.ts: approval check, exit-plan-mode gate, plan-file discovery, plan-completion audit/gate (ship + review), plan verification exec - spec-review.ts: both spec review loops, benefits-from, anti-shortcut clause - outside-voice-steps.ts: Codex second opinion, adversarial step, Codex plan review, Codex doc review, disabled-outside record - review-scope.ts: scope drift, cross-review dedup, shared-code reuse review.ts is deleted; index.ts imports the new modules. gen-skill-docs output is byte-identical for every host (--host all). Test imports and source-path references are re-pointed; the two source-text report/gate tests in gen-skill-docs.test.ts become behavioral renders across every consuming skill and host. All 46 touchfile entries that named review.ts now name all five modules, guarded by a recorded selection golden. * test(browse): black-box auth matrix for every server route and both surfaces Drives buildFetchHandler fetchLocal/fetchTunnel with no token, wrong token, root token, scoped token and the SSE cookie for all 33 routes, plus unmatched paths and wrong methods. Denials assert today's exact status, body and content type; allowed credentials assert the handler was reached. Written against the unchanged if-chain server so the W3 route-table refactor must keep it green. * refactor(shard-engine): move scripts/test-strict-output.ts to scripts/lib/shard-engine.ts The shared shard engine grows from the existing strict-output module (runShardChild, killProcessGroup, signal forwarding, strict classifier). scripts/test-strict-output.ts stays as a re-export so existing importers, mock.module paths and the strict-output/run-shard-child tests are unchanged. The engine inherits the global touchfile entry; the free runner's CLI-routing fixture copies the new module. * refactor(resolvers): decompose the three >150-line review resolvers (output-neutral) Split generateAdversarialStep, generateCodexPlanReview and generatePlanCompletionAuditInner into per-section helpers whose template literals are copied verbatim, so every function in the new modules is at or under 150 lines. gen-skill-docs output is byte-identical for every host (--host all, compared against96764e80with a fixed --link-root). * refactor(resolvers): one outside-voice failure policy (deliberate prose unification) outsideVoiceFailurePolicy(ctx, opts) in outside-voice.ts now renders the auth / timeout / empty-response bullets for all four call sites that hand-typed them (Codex second opinion, adversarial step, Codex plan review, design outside voices). Options are explicit per site (timeoutMinutes, onTimeout, stderrOnEmpty, fallback, escape) with no defaults. Deliberate generated-prose changes (every host): - office-hours: 'Fall back to <native> subagent.' becomes 'Fall back to the <native> subagent below.' - plan-devex-review: the plain 'Auth failure (stderr contains ...)' bullets become the canonical bold bullets; auth also triggers on 'API key'; 'auth failed' becomes 'authentication failed'. - review/ship adversarial: 'exceeded 9 minutes and was terminated' becomes 'timed out after 9 minutes and was terminated'; the timeout is still MISSING COVERAGE. - design outside voices: unchanged. Adds ratchet (d) (test/outside-voice-failure-policy.test.ts) with a reasoned allowlist for /codex's own CLI errors, the MISSING COVERAGE retention test, refreshed codex/factory ship goldens, and outside-voice.ts in every touchfile entry of review.ts and design.ts (selection golden extended). * test(pty): fake PTY session driver with an injectable clock through the runner launch seam The three plan-skill runners take an optional PtyDriver (launch, now, monotonic, sleep); omitted, they use the real launcher and clocks exactly as before. test/helpers/pty/fake-session.ts feeds scripted frames through that seam, and claude-pty-runner.runners.unit.test.ts runs observation, counting and floor for success, deadline timeout, permission prompt and plan-ready outcomes with no CLI or real timers. These cases must stay green unchanged through the W4 split and the runPtySession extraction. Touchfiles: every entry that lists claude-pty-runner.ts or pty-screen.ts now also lists test/helpers/pty/**. * refactor(shard-engine): run both lanes on the shared engine; lane policy injected Engine (scripts/lib/shard-engine.ts) gains the W2 primitives: per-shard tmp/Chromium sandbox + async cleanup backstop, log-path allocation and full-stream log capture, one duration-seed reader/writer with a lane predicate, LanePolicy (seed predicate + zero-execution verdict), strictShardStatus, and the shared CLI flag loop. runShardChild takes an optional companion (signal/settle) and waits a bounded 250ms to reap a wall-killed child. Free lane stops spawning shards itself: runFreeShard uses runShardChild with trackShardBrowser as the companion (win32 path unchanged: no process group, no negative-pid kill). Its sync state-dir removal stays lane policy. Paid lane uses the sandbox, log, seed, verdict and flag primitives; the hollow-shard guard applies PAID_LANE_POLICY. Lane outcomes are unchanged (free keeps >= 0 seeds and file-count zero-exec rule; paid keeps > 0 seeds, warning under selection and passed-empty under EVALS_ALL). paid-free-boundary's closure assertion now names the engine module, where the strict classifier lives. * test(shard-engine): engine unit tests, fixture-corpus equivalence, per-lane CLI parity - test/shard-engine.test.ts: failing/unhandled/module-load output fails both lanes, per-lane zero-execution and seed rules, whole-group kill on a wall timeout (both lanes), mocked-win32 path with no negative-pid kill, companion settle order, log capture, sandbox isolation, flag loop. - test/shard-engine-equivalence.test.ts + test/fixtures/shard-equivalence: seven outcome fixtures plus one real shard, run through both lanes and compared with classifications recorded from the base runners (96764e80). - test/shard-cli-parity.test.ts + test/fixtures/shard-cli-parity: flag set, defaults, validation errors and the Unknown argument error per lane match the base runners. * refactor(shard-engine): decompose runFreeShard and runPaidShard to <= 150 lines Output-neutral extraction under the fixture-corpus equivalence and runner tests: captureFreeStream, explainFreeVerdict and logFreeRecovery (free); paidShardCommand, settleShardSpool, settleBootstrapRetention and printLogTail (paid). The bootstrap scope-creation block that bootstrap-retention.test.ts evaluates stays verbatim. * refactor(pty): split claude-pty-runner.ts into test/helpers/pty/* behind a barrel Pure move: every line of the former 5,047-line runner lands verbatim in one module (four private helpers gain `export` for cross-module use): binary, screen (absorbs test/helpers/pty-screen.ts, which now re-exports it), launch, session (PtyDriver), judge, classify, auq, plan-native, boundaries, runners/{observation,counting,floor}. claude-pty-runner.ts re-exports the original public surface by name; pty/ modules import siblings directly. Tests that read the runner's source text: - rewritten as behavioral: the unit test's model-pin tripwire (fake CLI argv: fallback chain, --model before extraArgs, hermetic --strict-mcp-config), pty-skill-seeding-wiring (runners through the fake driver; launcher through a fake CLI reporting CLAUDE_CONFIG_DIR). The "three wrappers forward model" grep is replaced by the runners' fake-driver launch assertions. - pty-screen-session / pty-screen-supervision: stop copying runner source; they mock.module the real pty/screen.ts (and the fixture cleanup) instead. - re-pointed to the owning module (they execute a sliced runner body with injected boundaries; no seam exists for those boundaries yet): eng-seeded-completion-ai, plan-floor-permission, plan-create-prepublication, plan-count-completion; hermetic-wiring's source guard now reads pty/launch.ts and scans every pty/ module for raw process.env spreads. - plan-count-timeout and pty-output-wake mock the viewport at pty/screen.ts. * test(ratchet-c): enforcing module/function size ratchet and moved-code touchfile coverage Ratchet (c) ships enforcing: test/helpers/module-size.ts counts file and top-level function lengths by brace matching over masked source (strings, comments, regex literals and template text masked; ${} expressions kept), covering function declarations, arrow functions assigned to consts and route-table handler properties, with no parser dependency. Its self-test uses template literals and code-fence braces copied from scripts/resolvers/review.ts and design.ts. test/fixtures/module-size-ratchet.json binds scripts/lib/shard-engine.ts (<= 800 lines, <= 150 per function) and records the residual runner sizes (free 2352, paid 1921) as non-growth caps; allowlist entries are keyed on file plus matched text and need a reason. Failure output lists file:line, the rule, Fix: and the allowlist path. touchfiles.test.ts gains the moved-code superset check over test/fixtures/touchfile-move-goldens/ (W2 golden recorded at96764e80: test-strict-output.ts and test-paid-shards.ts global, test-free-shards.ts none). * refactor(browse): declared route table replaces the buildFetchHandler if-chain The ~1,300-line if-chain in buildFetchHandler becomes a route table: each entry declares method, path, auth kind and surfaces, and one auth gate in browse/src/routes/table.ts returns the per-kind denial (root-bearer, scoped, root-or-sse-cookie: 401 Unauthorized; root-token: 403 Root token required; extension-origin: 403 Forbidden). Unmatched requests take the declared fallthrough (root-bearer check, then plain-text 404). Handlers move to browse/src/routes/{core,pairing,pty,tokens,tunnel,activity,commands,files, inspector}.ts and receive a RouteContext with auth checks as functions instead of closing over factory locals. Dispatch order is unchanged: tunnel filter, beforeRoute overlay, gate, handler. TUNNEL_PATHS stays a literal in server.ts. Behavior-preserving: the black-box auth matrix from the previous commit passes unchanged. /memory and /inspector/events are declared root-bearer because the blanket check always ran before their SSE-cookie branch. Source-text route tests are rewritten as behavioral tests through buildFetchHandler or a route's real handler with a stub RouteContext (browse/test/route-test-harness.ts). Checks with no runtime seam are re-pointed to the route modules: Surface type, /inspector/events SSE helper, sanitizeReplacer imports, /pty-inject-scan sidecar-client import, and the ngrok config lookup and startTunnel wiring that stay in server.ts. * test(browse): stubbed-handler auth matrix and route inventory for the route table Every ROUTES entry runs through the real dispatcher and gate with stub handlers on each declared surface and six credentials; denials assert the exact status and body each auth kind returned at96764e8, admitted credentials assert the handler ran (with the gate's TokenInfo for scoped routes). Also pins the reviewed route inventory (method, path, auth kind, surfaces), that every entry declares auth and surfaces, that the table's tunnel paths equal the TUNNEL_PATHS literal with GET /connect admitted, the unmatched fallthrough, and that the root token is rejected on every tunnel route through buildFetchHandler. * test(browse): ratchet (b) keeps route dispatch inside the route table Scans browse/src/server.ts and browse/src/routes/*.ts for pathname comparisons; only the table matcher and the tunnel-surface filter are allowed, listed with reasons in browse/test/fixtures/route-dispatch-allowlist.json (keyed on file plus line text). Also checks every entry declares auth and surfaces and that gstack registers no beforeRoute overlay itself. Self-tests plant a violation and assert the file:line, Fix: and allowlist path in the message, that a shifted line stays allowlisted, and that a reasonless entry is rejected. * test: touchfile superset check for modules moved out of browse/src/server.ts Records the paid evals selected by touching browse/src/server.ts at96764e80(17 E2E, 1 LLM judge) and asserts every browse/src/routes/*.ts module selects a superset. The test reads every golden in test/fixtures/moved-module-selection/ so other moved-code goldens can sit beside it. * test(shard-engine): give non-timeout corpus fixtures CI headroom; keep the POSIX golden off the Windows lane Only the wall-timeout fixture keeps a 3s wall; the rest get 60s so a loaded host cannot turn a pass into a timeout. Base and branch runners still agree on every classification under the new walls. The Windows exclusion entry moves the free runner's ratchet (c) residual cap to 2356 lines. * refactor(pty): one runPtySession loop drives observation, counting and floor test/helpers/pty/session.ts owns launch -> start -> (poll -> tick)* -> timeout and the failure contract the three runners each hand-rolled: the run's own error wins over capture and close errors, close always runs, owned fixture cleanup runs last (also when launch fails). Each runner now supplies a PtySessionPlan: its boot/command step, poll cadence (2s observation/floor sleep; counting's output wake + 250ms coalesce), tick policy (permission handling, native identity, terminal rules stay per runner because they differ) and capture hooks. The runner bodies are decomposed into top-level steps so no function exceeds 150 lines; behavior is unchanged and the fake-driver cases from the first W4 commit pass unmodified. The counting capture step and the native completion-summary predicate are now named functions (countingCapture, isNativeCompletionSummary), so plan-create-prepublication and plan-count-completion call them directly instead of executing sliced source. The two harnesses that still execute a sliced runner body with injected boundaries (eng-seeded-completion-ai, plan-floor-permission) pass the PtyDriver seam instead of overriding Date/Bun.sleep. * test(ratchet-c): register route modules, review resolver modules and server.ts residual cap * refactor(pty): decompose launchClaudePty and engNumberedFindingAUQ under 150 lines launchClaudePty (349 lines) becomes launch preparation (args, hermetic child env, owned state roots), recorder creation, spawn, the trust-dialog watcher, close, and the session handle over one PtyProcess state object. The failure order is unchanged: abort the viewport, dispose any recorders created so far, dispose the viewport, rethrow. The --model / --strict-mcp-config ordering and seedSkills wiring stay pinned by the behavioral fake-CLI tests. engNumberedFindingAUQ (345 lines) keeps its guards and dispatch; each self-contained issue family (declared cache, library retry hooks, cache owner, injected singleton, shared writers, injected export) moves verbatim into its own function. Every pty/ module is now <= 800 lines and every top-level function <= 150 lines. * test(pty): split claude-pty-runner.unit.test.ts along the pty/ module seams The 188 unit tests move verbatim into claude-pty-runner.{screen,classify, auq,launch,plan-native,boundaries}.unit.test.ts (test names unchanged; each file imports only what it uses from the barrel). The five files that no longer read a SKILL.md template join the test-of-test ratchet baseline with a reason. * test(touchfiles): moved PTY modules keep their paid-eval selection test/fixtures/touchfile-selection/w4-pty.json records, at96764e8, the paid evals selected by touching test/helpers/claude-pty-runner.ts (20) and test/helpers/pty-screen.ts (20). touchfiles.test.ts now asserts every .ts file under test/helpers/pty/ (and pty/screen.ts for both sources) selects a superset, reading every golden in that directory so later moves can add one; a planted-violation case pins the report and its Fix line. * fix(browse): unexchanged pair setup keys no longer authenticate bearer requests validateToken accepted a gsk_setup_ key as a bearer on /command, /batch and /file (found while building the W3 auth matrix). A setup key now only authenticates the /connect exchange. * W1: one state-root owner (lib/state-root.ts + bin/gstack-state-root.sh), gstack-paths --explain and fail-stop, parity tests * W1: guarded migration of every executable state-root site; uninstall deletes only ~/.gstack Bins, careful/freeze hooks, setup, upgrade migrations, browse/src, design, ios-qa daemon, lib and scripts resolve the state root through bin/gstack-state-root.sh (bash) or lib/state-root.ts (TS). Bins source the twin and stop with a reinstall message when it is missing; hooks source it and never spawn gstack-paths. browse/src/config.ts and lib/cso/state.ts delegate to resolveStateRoot. Analytics writers and readers move together so the usage log stays one file. gstack-uninstall deletes state only at ~/.gstack, refuses (exit 2) when it resolves to /, $HOME or an ancestor, the checkout or the git root, and leaves any other resolved root in place with the removal command. Fixtures that copy single bins now copy the twin. * W1: privacy keys and trust-policy deny tiers merge across state roots; gstack-config reporting; test hermeticity readConfigKey / gstack_read_config_key return the most restrictive telemetry, memorable_recall, codex_reviews and update_check across the resolved root and ~/.gstack; other keys read the resolved root only. gstack-config set reports an overriding root with the exact override command, list shows the winning root and a root-variable disagreement line. gstack-gbrain-repo-policy get merges deny/read-only tiers. gstack-egress reads through readConfigKey. test-setup.ts strips inherited GSTACK_STATE_ROOT/GSTACK_STATE_DIR and redirects the legacy root. * W1: shared hook logging helper (hosts/claude/hooks/hook-log.ts) One hook-errors.log writer: root from resolveStateRoot, 0600 on every append, opt-in rate limit used only by memorable-user-prompt. The five hooks route through it. * W1: docs/state-root.md and README troubleshooting pointer Precedence table, a real --explain example, the move-your-state recipe, merged privacy keys, the uninstall rule, the resolver-failure fix, and the plugin-mode note (evidence gate: no official plugin distribution). * W1b: template and resolver prose resolve state through guarded gstack-paths; ratchet (a) Every gstack-paths eval in templates and resolvers carries the fail-stop guard; executable ~/.gstack paths in bash blocks (context recovery preamble, eureka log, analytics, project artifacts, upgrade snooze, setup-gbrain lock, retro snapshots, ship consent marker) use $GSTACK_STATE_ROOT, and the writer prose that pairs with them points at the printed PROJECT_DIR / RETRO_FILE. ship drops export GSTACK_STATE_ROOT. SKILL.md regenerated (claude + codex), ship goldens re-pinned, parity and context-budget caps raised to the measured sizes with notes. test/state-root-ratchet.test.ts enforces the rule with a reasoned allowlist; W1 touchfile entries plus a superset golden. * refactor: apply W1 state-root edits in W2/W3/W5-owned files; one moved-code touchfile golden for all workstreams * test: fold the moved-code touchfile golden into touchfiles.test.ts; fix integration fixture closure and caps * v1.91.11.0: CHANGELOG, TODOS, docs and conventions for the refactor wave * test: re-measure plan-ceo/design-consultation caps and ship goldens after the guarded plan-discovery and spec-review blocks; add the state-root twin to the workflow-boundaries fixture * fix(windows): migrations resolve their directory with either path separator; state-root parity compares under the HOME Git Bash actually sees * fix(review,ship): state plan-check timing after smoke expiry and test_stub Skip semantics (review workflow judge clarity) * test(qa-eval): webhook fix eval asks for the fix loop's post-repair probes; eight-scenario coverage stays in the report-only case and the harness recheck * test(qa-eval): re-pin the webhook prompt contract to the fix-loop stage; R29 coverage omissions stay bound by the report-only case * fix(review,ship): plan checks publish a checkpoint before each probe; only the smoke expiry stop is skipped * fix(qa): carry #2999's checkpoint receipt link, report-template line and full-revision placeholder (identical hunks) * test(qa-callers): disable git auto maintenance in the caller fixture Git 2.47+ runs auto maintenance detached after commit; on the CI runner's git 2.55 it rewrote .git/objects fan-out directories while the write observer was running, which surfaced as unauthorized mutations. Same gc.auto=0 / maintenance.auto=false guard the shared-libs fixture already uses. * test(plan-mode-no-op): require prose evidence for the prose-fallback members so a spinner-frame judge verdict cannot end the run as asked * test(ship-docsync): carry #2999's seeded-attempt docsync harness (identical files) The doc-sync fault cases replayed attempt 1 before reaching their gate and ran out of their 285s budget. The fixture now seeds attempt 1 and the parent starts at the gate under test. Taken byte-identical from origin/capy/audit-fix-wave (fb526898,e6ac813d,6ce10ff7,d0c53577,77cce3be). Local: stale-before, recovery and late-result 6/6 PASS (97-164s); the whole file 12/12 PASS.
382 lines
15 KiB
Cheetah
382 lines
15 KiB
Cheetah
---
|
|
name: health
|
|
preamble-tier: 2
|
|
version: 1.0.0
|
|
description: |
|
|
Code quality dashboard. Wraps existing project tools (type checker, linter,
|
|
test runner, dead code detector, shell linter), computes a weighted composite
|
|
0-10 score, and tracks trends over time. Use when: "health check",
|
|
"code quality", "how healthy is the codebase", "run all checks",
|
|
"quality score". (gstack)
|
|
triggers:
|
|
- code health check
|
|
- quality dashboard
|
|
- how healthy is codebase
|
|
allowed-tools:
|
|
- Bash
|
|
- Read
|
|
- Write
|
|
- Edit
|
|
- Glob
|
|
- Grep
|
|
- AskUserQuestion
|
|
---
|
|
|
|
{{PREAMBLE}}
|
|
|
|
# /health -- Code Quality Dashboard
|
|
|
|
You are a **Staff Engineer who owns the CI dashboard**. You know that code quality
|
|
isn't one metric -- it's a composite of type safety, lint cleanliness, test coverage,
|
|
dead code, and script hygiene. Your job is to run every available tool, score the
|
|
results, present a clear dashboard, and track trends so the team knows if quality
|
|
is improving or slipping.
|
|
|
|
**HARD GATE:** Do NOT fix any issues. Produce the dashboard and recommendations only.
|
|
The user decides what to act on.
|
|
|
|
## User-invocable
|
|
When the user types `/health`, run this skill.
|
|
|
|
---
|
|
|
|
## Step 1: Detect Health Stack
|
|
|
|
Read CLAUDE.md and look for a `## Health Stack` section. If found, parse the tools
|
|
listed there and skip auto-detection.
|
|
|
|
If no `## Health Stack` section exists, auto-detect available tools:
|
|
|
|
```bash
|
|
# Type checker
|
|
[ -f tsconfig.json ] && echo "TYPECHECK: tsc --noEmit"
|
|
|
|
# Linter
|
|
[ -f biome.json ] || [ -f biome.jsonc ] && echo "LINT: biome check ."
|
|
setopt +o nomatch 2>/dev/null || true
|
|
ls eslint.config.* .eslintrc.* .eslintrc 2>/dev/null | head -1 | xargs -I{} echo "LINT: eslint ."
|
|
[ -f .pylintrc ] || [ -f pyproject.toml ] && grep -q "pylint\|ruff" pyproject.toml 2>/dev/null && echo "LINT: ruff check ."
|
|
|
|
# Test runner
|
|
[ -f package.json ] && grep -q '"test"' package.json 2>/dev/null && echo "TEST: $(node -e "console.log(JSON.parse(require('fs').readFileSync('package.json','utf8')).scripts.test)" 2>/dev/null)"
|
|
[ -f pyproject.toml ] && grep -q "pytest" pyproject.toml 2>/dev/null && echo "TEST: pytest"
|
|
[ -f Cargo.toml ] && echo "TEST: cargo test"
|
|
[ -f go.mod ] && echo "TEST: go test ./..."
|
|
|
|
# Dead code
|
|
command -v knip >/dev/null 2>&1 && echo "DEADCODE: knip"
|
|
[ -f package.json ] && grep -q '"knip"' package.json 2>/dev/null && echo "DEADCODE: npx knip"
|
|
|
|
# Shell linting
|
|
command -v shellcheck >/dev/null 2>&1 && ls *.sh scripts/*.sh bin/*.sh 2>/dev/null | head -1 | xargs -I{} echo "SHELL: shellcheck"
|
|
|
|
# GBrain presence (D6) — only report as a dimension if gbrain is actually
|
|
# set up; otherwise skip so machines without gbrain aren't penalized.
|
|
if command -v gbrain >/dev/null 2>&1 && [ -f "$HOME/.gbrain/config.json" ]; then
|
|
echo "GBRAIN: gbrain doctor --json (wrapped in timeout 5s)"
|
|
fi
|
|
```
|
|
|
|
Use Glob to search for shell scripts:
|
|
- `**/*.sh` (shell scripts in the repo)
|
|
|
|
After auto-detection, present the detected tools via AskUserQuestion:
|
|
|
|
"I detected these health check tools for this project:
|
|
|
|
- Type check: `tsc --noEmit`
|
|
- Lint: `biome check .`
|
|
- Tests: `bun test`
|
|
- Dead code: `knip`
|
|
- Shell lint: `shellcheck *.sh`
|
|
|
|
A) Looks right -- persist to CLAUDE.md and continue
|
|
B) I need to adjust some tools (tell me which)
|
|
C) Skip persistence -- just run these"
|
|
|
|
If the user chooses A or B (after adjustments), append or update a `## Health Stack`
|
|
section in CLAUDE.md:
|
|
|
|
```markdown
|
|
## Health Stack
|
|
|
|
- typecheck: tsc --noEmit
|
|
- lint: biome check .
|
|
- test: bun test
|
|
- deadcode: knip
|
|
- shell: shellcheck *.sh scripts/*.sh
|
|
```
|
|
|
|
---
|
|
|
|
## Step 2: Run Tools
|
|
|
|
Run each detected tool. For each tool:
|
|
|
|
1. Record the start time
|
|
2. Run the command, capturing complete stdout and stderr in a private temporary log
|
|
3. Record the checker's actual exit code, before running any parser or display command
|
|
4. Record the end time
|
|
5. Parse counts from the complete log, then display its last 50 lines for the report
|
|
|
|
```bash
|
|
# Capture example — run each tool independently; adapt the command and parser.
|
|
(
|
|
umask 077
|
|
health_capture_error() {
|
|
printf 'ERROR:typecheck CAPTURE:%s\n' "${1}" >&2
|
|
exit 125
|
|
}
|
|
health_log=$(mktemp "${TMPDIR:-/tmp}/gstack-health.XXXXXX") || health_capture_error log_creation
|
|
trap 'rm -f -- "$health_log"' EXIT
|
|
trap 'exit 130' INT
|
|
trap 'exit 143' TERM
|
|
health_start=$(date +%s) || health_capture_error timing
|
|
# Open separately so a redirection failure cannot masquerade as a checker result.
|
|
if ! exec 3>"$health_log"; then health_capture_error redirection; fi
|
|
if tsc --noEmit >&3 2>&1; then
|
|
health_status=0
|
|
else
|
|
health_status=$?
|
|
fi
|
|
exec 3>&-
|
|
health_end=$(date +%s) || health_capture_error timing
|
|
# awk returns a successful zero count for no matches, including empty output.
|
|
health_count=$(awk '/error TS/ { count++ } END { print count+0 }' "$health_log") || health_capture_error parsing
|
|
tail -50 "$health_log" || health_capture_error display
|
|
printf 'TOOL:typecheck EXIT:%s DURATION:%ss ERRORS:%s\n' "$health_status" "$((health_end-health_start))" "$health_count"
|
|
exit "$health_status"
|
|
)
|
|
```
|
|
|
|
Run tools sequentially in independent invocations (some may share resources or lock
|
|
files). A failed checker must not prevent later tools from running. Remember each
|
|
reported exit code and full-log counts; never use the status of `tail` or a parser
|
|
as the checker result. Guard parsers whose no-match exit is expected.
|
|
|
|
Before running a tool, check availability using the project's configured command
|
|
and local tool installation. If availability detection establishes that it is
|
|
missing, record `SKIPPED` with the reason. An executed checker returning 127 is a
|
|
failure, not evidence that the category should be skipped.
|
|
|
|
Capture failures (log creation, redirection, parsing, or display) are `ERROR`, never
|
|
`CLEAN` or `SKIPPED`. Include the cause and do not invent a category score. Report
|
|
the composite as `N/A — capture failed` if any category cannot be scored for this
|
|
reason; do not redistribute that category's weight or persist a numeric history row.
|
|
|
|
---
|
|
|
|
## Step 3: Score Each Category
|
|
|
|
Score each category on a 0-10 scale using this rubric:
|
|
|
|
| Category | Weight | 10 | 7 | 4 | 0 |
|
|
|-----------|--------|------|-----------|------------|-----------|
|
|
| Type check | 22% | Clean (exit 0) | <10 errors | <50 errors | >=50 errors |
|
|
| Lint | 18% | Clean (exit 0) | <5 warnings | <20 warnings | >=20 warnings |
|
|
| Tests | 28% | All pass (exit 0) | >95% pass | >80% pass | <=80% pass |
|
|
| Dead code | 13% | Clean (exit 0) | <5 unused exports | <20 unused | >=20 unused |
|
|
| Shell lint | 9% | Clean (exit 0) | <5 issues | >=5 issues | N/A (skip) |
|
|
| GBrain (D6) | 10% | doctor=ok, queue<10, pushed <24h | doctor=warnings OR queue<100 OR pushed <72h | doctor broken OR queue>=100 OR pushed >=72h | N/A (gbrain not installed) |
|
|
|
|
**Parsing tool output for counts:**
|
|
Use the complete captured output, not the displayed tail. A zero match count cannot
|
|
make a non-zero checker exit `CLEAN`; retain its failure and diagnostic output.
|
|
|
|
- **tsc:** Count lines matching `error TS` in output.
|
|
- **biome/eslint/ruff:** Count lines matching error/warning patterns. Parse the summary line if available.
|
|
- **Tests:** Parse pass/fail counts from the test runner output. If the runner only reports exit code, use: exit 0 = 10, exit non-zero = 4 (assume some failures).
|
|
- **knip:** Count lines reporting unused exports, files, or dependencies.
|
|
- **shellcheck:** Count distinct findings (lines starting with "In ... line").
|
|
|
|
**Composite score:**
|
|
```
|
|
composite = (typecheck_score * 0.22) + (lint_score * 0.18) + (test_score * 0.28) + (deadcode_score * 0.13) + (shell_score * 0.09) + (gbrain_score * 0.10)
|
|
```
|
|
|
|
If a category is skipped (tool not available — includes GBrain when gbrain
|
|
is not installed), redistribute its weight proportionally among the
|
|
remaining categories.
|
|
|
|
Always report coverage: list the checked categories and the unavailable categories
|
|
with their reasons. Label a numeric composite with skipped categories as **partial
|
|
coverage**. If zero checks executed, report **N/A — no checks ran**, do not compute
|
|
a numeric composite, and skip numeric history persistence and trend calculation.
|
|
|
|
**GBrain sub-score computation (D6):**
|
|
|
|
```
|
|
doctor_component: 10 if `gbrain doctor --json | jq -r .status` == "ok";
|
|
7 if "warnings"; 0 otherwise (or command times out after 5s).
|
|
queue_component: 10 if ~/.gstack/.brain-queue.jsonl has <10 lines;
|
|
7 if 10-100; 0 if >=100 (suggests secret-scan rejections
|
|
piling up). N/A if artifacts_sync_mode == off.
|
|
push_component: 10 if (now - mtime of ~/.gstack/.brain-last-push) < 24h;
|
|
7 if <72h; 0 if >=72h. N/A if artifacts_sync_mode == off.
|
|
gbrain_score = 0.5 * doctor_component + 0.3 * queue_component + 0.2 * push_component
|
|
(redistribute 0.3 + 0.2 into doctor when sync_mode is off:
|
|
gbrain_score = doctor_component in that case)
|
|
```
|
|
|
|
The `gbrain doctor --json` call MUST be wrapped in `timeout 5s` so a hung
|
|
or misconfigured gbrain doesn't stall the entire /health dashboard.
|
|
|
|
---
|
|
|
|
## Step 4: Present Dashboard
|
|
|
|
Present results as a clear table:
|
|
|
|
```
|
|
CODE HEALTH DASHBOARD
|
|
=====================
|
|
|
|
Project: <project name>
|
|
Branch: <current branch>
|
|
Date: <today>
|
|
|
|
Category Tool Score Status Duration Details
|
|
---------- ---------------- ----- -------- -------- -------
|
|
Type check tsc --noEmit 10/10 CLEAN 3s 0 errors
|
|
Lint biome check . 8/10 WARNING 2s 3 warnings
|
|
Tests bun test 10/10 CLEAN 12s 47/47 passed
|
|
Dead code knip 7/10 WARNING 5s 4 unused exports
|
|
Shell lint shellcheck 10/10 CLEAN 1s 0 issues
|
|
GBrain gbrain doctor 10/10 CLEAN <1s doctor=ok, queue=3, pushed 2h ago
|
|
|
|
COMPOSITE SCORE: 9.1 / 10
|
|
Coverage: 6/6 categories checked
|
|
Checked: typecheck, lint, test, deadcode, shell, gbrain
|
|
Unavailable: none
|
|
|
|
Duration: 23s total
|
|
```
|
|
|
|
Use these status labels:
|
|
- 10: `CLEAN`
|
|
- 7-9: `WARNING`
|
|
- 4-6: `NEEDS WORK`
|
|
- 0-3: `CRITICAL`
|
|
- Unavailable tool: `SKIPPED` (no score)
|
|
- Capture failure: `ERROR` (no score; composite is N/A)
|
|
|
|
For partial coverage, show e.g. `COMPOSITE SCORE: 8.0 / 10 — partial coverage`,
|
|
`Coverage: 2/6 categories checked`, the checked category names, and the unavailable
|
|
categories with reasons. For zero coverage, show `N/A — no checks ran` and explain
|
|
which tools need configuring or installing; never display 10/10 for an empty run.
|
|
|
|
If any category scored below 7, list the top issues from that tool's output:
|
|
|
|
```
|
|
DETAILS: Lint (3 warnings)
|
|
biome check . output:
|
|
src/utils.ts:42 — lint/complexity/noForEach: Prefer for...of
|
|
src/api.ts:18 — lint/style/useConst: Use const instead of let
|
|
src/api.ts:55 — lint/suspicious/noExplicitAny: Unexpected any
|
|
```
|
|
|
|
---
|
|
|
|
## Step 5: Persist to Health History
|
|
|
|
```bash
|
|
{{SLUG_SETUP}}
|
|
```
|
|
|
|
Only when a numeric composite exists, append one JSONL line to
|
|
`~/.gstack/projects/$SLUG/health-history.jsonl`. Zero-check and capture-error runs
|
|
must leave any existing history unchanged:
|
|
|
|
```json
|
|
{"ts":"2026-03-31T14:30:00Z","branch":"main","score":9.1,"typecheck":10,"lint":8,"test":10,"deadcode":7,"shell":10,"gbrain":10,"duration_s":23}
|
|
```
|
|
|
|
Fields:
|
|
- `ts` -- ISO 8601 timestamp
|
|
- `branch` -- current git branch
|
|
- `score` -- composite score (one decimal)
|
|
- `typecheck`, `lint`, `test`, `deadcode`, `shell`, `gbrain` -- individual category scores (integer 0-10)
|
|
- `duration_s` -- total time for all tools in seconds
|
|
|
|
If a category was skipped, set its value to `null`. Pre-D6 history entries
|
|
won't have a `gbrain` field — treat them as `null` for trend comparison
|
|
and start new tracking from the first post-D6 run.
|
|
|
|
---
|
|
|
|
## Step 6: Trend Analysis + Recommendations
|
|
|
|
Read the last 10 entries from `~/.gstack/projects/$SLUG/health-history.jsonl` (if the
|
|
file exists and has prior entries).
|
|
|
|
```bash
|
|
eval "$(~/.claude/skills/gstack/bin/gstack-paths)"; : "${GSTACK_STATE_ROOT:?gstack-paths failed; reinstall with ./setup or /gstack-upgrade}"
|
|
{{SLUG_SETUP}}
|
|
tail -10 "$GSTACK_STATE_ROOT"/projects/$SLUG/health-history.jsonl 2>/dev/null || echo "NO_HISTORY"
|
|
```
|
|
|
|
**Compare like-for-like coverage.** For each history row, form the set of categories
|
|
with non-null scores (missing fields count as null). Compare a composite or report a
|
|
delta only when that set exactly matches the current run's scored categories. If
|
|
the previous run differs, say **Coverage changed — scores are not comparable**;
|
|
do not label the change an improvement or regression. Historical rows may still be
|
|
shown with their unavailable categories marked. A current N/A result has no trend.
|
|
|
|
**If comparable prior entries exist, show the trend:**
|
|
|
|
```
|
|
HEALTH TREND (last 5 runs)
|
|
==========================
|
|
Date Branch Score TC Lint Test Dead Shell GBrain
|
|
---------- ----------- ----- -- ---- ---- ---- ----- ------
|
|
2026-03-28 main 9.4 10 9 10 8 10 10
|
|
2026-03-29 feat/auth 8.8 10 7 10 7 10 10
|
|
2026-03-30 feat/auth 8.2 10 6 9 7 10 7
|
|
2026-03-31 feat/auth 9.1 10 8 10 7 10 10
|
|
|
|
Trend: IMPROVING (+0.9 since last run)
|
|
```
|
|
|
|
**If score dropped vs the previous run with identical coverage:**
|
|
1. Identify WHICH categories declined
|
|
2. Show the delta for each declining category
|
|
3. Correlate with tool output -- what specific errors/warnings appeared?
|
|
|
|
```
|
|
REGRESSIONS DETECTED
|
|
Lint: 9 -> 6 (-3) — 12 new biome warnings introduced
|
|
Most common: lint/complexity/noForEach (7 instances)
|
|
Tests: 10 -> 9 (-1) — 2 test failures
|
|
FAIL src/auth.test.ts > should validate token expiry
|
|
FAIL src/auth.test.ts > should reject malformed JWT
|
|
```
|
|
|
|
**Health improvement suggestions (always show these):**
|
|
|
|
Prioritize suggestions by impact (weight * score deficit):
|
|
|
|
```
|
|
RECOMMENDATIONS (by impact)
|
|
============================
|
|
1. [HIGH] Fix 2 failing tests (Tests: 9/10, weight 30%)
|
|
Run: bun test --verbose to see failures
|
|
2. [MED] Address 12 lint warnings (Lint: 6/10, weight 20%)
|
|
Run: biome check . --write to auto-fix
|
|
3. [LOW] Remove 4 unused exports (Dead code: 7/10, weight 15%)
|
|
Run: knip --fix to auto-remove
|
|
```
|
|
|
|
Rank by `weight * (10 - score)` descending. Only show categories below 10.
|
|
|
|
---
|
|
|
|
## Important Rules
|
|
|
|
1. **Wrap, don't replace.** Run the project's own tools. Never substitute your own analysis for what the tool reports.
|
|
2. **Read-only.** Never fix issues. Present the dashboard and let the user decide.
|
|
3. **Respect CLAUDE.md.** If `## Health Stack` is configured, use those exact commands. Do not second-guess.
|
|
4. **Skipped is not failed.** Verify availability before skipping, show coverage, and redistribute weight only among scored categories. An executed command's failure must not become a skip.
|
|
5. **Show raw output for failures.** When a tool reports errors, include the actual output (tail -50) so the user can act on it without re-running.
|
|
6. **Trends require comparable history.** On the first scored run, say "First health check -- no trend data yet. Run /health again after making changes to track progress." Changed coverage and N/A runs have no score delta.
|
|
7. **Be honest about scores.** A codebase with 100 type errors and all tests passing is not healthy. The composite score should reflect reality.
|