mirror of
https://github.com/garrytan/gstack.git
synced 2026-05-01 19:25:10 +02:00
feat: SKILL.md template system, 3-tier testing, DX tools (v0.3.3) (#41)
* refactor: extract command registry to commands.ts, add SNAPSHOT_FLAGS metadata
- NEW: browse/src/commands.ts — command sets + COMMAND_DESCRIPTIONS + load-time validation (zero side effects)
- server.ts imports from commands.ts instead of declaring sets inline
- snapshot.ts: SNAPSHOT_FLAGS array drives parseSnapshotArgs (metadata-driven, no duplication)
- All 186 existing tests pass
* feat: SKILL.md template system with auto-generated command references
- SKILL.md.tmpl + browse/SKILL.md.tmpl with {{COMMAND_REFERENCE}} and {{SNAPSHOT_FLAGS}} placeholders
- scripts/gen-skill-docs.ts generates SKILL.md from templates (supports --dry-run)
- Build pipeline runs gen:skill-docs before binary compilation
- Generated files have AUTO-GENERATED header, committed to git
* test: Tier 1 static validation — 34 tests for SKILL.md command correctness
- test/helpers/skill-parser.ts: extracts $B commands from code blocks, validates against registry
- test/skill-parser.test.ts: 13 parser/validator unit tests
- test/skill-validation.test.ts: 13 tests validating all SKILL.md files + registry consistency
- test/gen-skill-docs.test.ts: 8 generator tests (categories, sorting, freshness)
* feat: DX tools (skill:check, dev:skill) + Tier 2 E2E test scaffolding
- scripts/skill-check.ts: health summary for all SKILL.md files (commands, templates, freshness)
- scripts/dev-skill.ts: watch mode for template development
- test/helpers/session-runner.ts: Agent SDK wrapper for E2E skill tests
- test/skill-e2e.test.ts: 2 E2E tests + 3 stubs (auto-skip inside Claude Code sessions)
- E2E tests must run from plain terminal: SKILL_E2E=1 bun test test/skill-e2e.test.ts
* ci: SKILL.md freshness check on push/PR + TODO updates
- .github/workflows/skill-docs.yml: fails if generated SKILL.md files are stale
- TODO.md: add E2E cost tracking and model pinning to future ideas
* fix: restore rich descriptions lost in auto-generation
- Snapshot flags: add back value hints (-d <N>, -s <sel>, -o <path>)
- Snapshot flags: restore parenthetical context (@e refs, @c refs, etc.)
- Commands: is → includes valid states enum
- Commands: console → notes --errors filter behavior
- Commands: press → lists common keys (Enter, Tab, Escape)
- Commands: cookie-import-browser → describes picker UI
- Commands: dialog-accept → specifies alert/confirm/prompt
- Tips: restore → arrow (was downgraded to ->)
* test: quality evals for generated SKILL.md descriptions
Catches the exact regressions we shipped and caught in review:
- Snapshot flags must include value hints (-d <N>, -s <sel>, -o <path>)
- is command must list all valid states (visible/hidden/enabled/...)
- press command must list example keys (Enter, Tab, Escape)
- console command must describe --errors behavior
- Snapshot -i must mention @e refs, -C must mention @c refs
- All descriptions must be >= 8 chars (no empty stubs)
- Tips section must use → not ->
* feat: LLM-as-judge evals for SKILL.md documentation quality
4 eval tests using Anthropic API (claude-haiku, ~$0.01-0.03/run):
- Command reference table: clarity/completeness/actionability >= 4/5
- Snapshot flags section: same thresholds
- browse/SKILL.md overall quality
- Regression: generated version must score >= hand-maintained baseline
Requires ANTHROPIC_API_KEY. Auto-skips without it.
Run: bun run test:eval (or ANTHROPIC_API_KEY=sk-... bun test test/skill-llm-eval.test.ts)
* chore: bump version to 0.3.3, update changelog
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: add ARCHITECTURE.md, update CLAUDE.md and CONTRIBUTING.md
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* feat: conductor.json lifecycle hooks + .env propagation across worktrees
bin/dev-setup now copies .env from main worktree so API keys carry
over to Conductor workspaces automatically. conductor.json wires up
setup and archive hooks.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: complete CHANGELOG for v0.3.3 (architecture, conductor, .env)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,82 @@
|
||||
#!/usr/bin/env bun
|
||||
/**
|
||||
* dev:skill — Watch mode for SKILL.md template development.
|
||||
*
|
||||
* Watches .tmpl files, regenerates SKILL.md files on change,
|
||||
* validates all $B commands immediately.
|
||||
*/
|
||||
|
||||
import { validateSkill } from '../test/helpers/skill-parser';
|
||||
import { execSync } from 'child_process';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
const ROOT = path.resolve(import.meta.dir, '..');
|
||||
|
||||
const TEMPLATES = [
|
||||
{ tmpl: path.join(ROOT, 'SKILL.md.tmpl'), output: 'SKILL.md' },
|
||||
{ tmpl: path.join(ROOT, 'browse', 'SKILL.md.tmpl'), output: 'browse/SKILL.md' },
|
||||
];
|
||||
|
||||
function regenerateAndValidate() {
|
||||
// Regenerate
|
||||
try {
|
||||
execSync('bun run scripts/gen-skill-docs.ts', { cwd: ROOT, stdio: 'pipe' });
|
||||
} catch (err: any) {
|
||||
console.log(` [gen] ERROR: ${err.stderr?.toString().trim() || err.message}`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Validate each generated file
|
||||
for (const { output } of TEMPLATES) {
|
||||
const fullPath = path.join(ROOT, output);
|
||||
if (!fs.existsSync(fullPath)) continue;
|
||||
|
||||
const result = validateSkill(fullPath);
|
||||
const totalValid = result.valid.length;
|
||||
const totalInvalid = result.invalid.length;
|
||||
const totalSnapErrors = result.snapshotFlagErrors.length;
|
||||
|
||||
if (totalInvalid > 0 || totalSnapErrors > 0) {
|
||||
console.log(` [check] \u274c ${output} (${totalValid} valid)`);
|
||||
for (const inv of result.invalid) {
|
||||
console.log(` Unknown command: '${inv.command}' at line ${inv.line}`);
|
||||
}
|
||||
for (const se of result.snapshotFlagErrors) {
|
||||
console.log(` ${se.error} at line ${se.command.line}`);
|
||||
}
|
||||
} else {
|
||||
console.log(` [check] \u2705 ${output} — ${totalValid} commands, all valid`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Initial run
|
||||
console.log(' [watch] Watching *.md.tmpl files...');
|
||||
regenerateAndValidate();
|
||||
|
||||
// Watch for changes
|
||||
for (const { tmpl } of TEMPLATES) {
|
||||
if (!fs.existsSync(tmpl)) continue;
|
||||
fs.watch(tmpl, () => {
|
||||
console.log(`\n [watch] ${path.relative(ROOT, tmpl)} changed`);
|
||||
regenerateAndValidate();
|
||||
});
|
||||
}
|
||||
|
||||
// Also watch commands.ts and snapshot.ts (source of truth changes)
|
||||
const SOURCE_FILES = [
|
||||
path.join(ROOT, 'browse', 'src', 'commands.ts'),
|
||||
path.join(ROOT, 'browse', 'src', 'snapshot.ts'),
|
||||
];
|
||||
|
||||
for (const src of SOURCE_FILES) {
|
||||
if (!fs.existsSync(src)) continue;
|
||||
fs.watch(src, () => {
|
||||
console.log(`\n [watch] ${path.relative(ROOT, src)} changed`);
|
||||
regenerateAndValidate();
|
||||
});
|
||||
}
|
||||
|
||||
// Keep alive
|
||||
console.log(' [watch] Press Ctrl+C to stop\n');
|
||||
Reference in New Issue
Block a user