mirror of
https://github.com/garrytan/gstack.git
synced 2026-05-06 05:35:46 +02:00
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
This commit is contained in:
Garry Tan
@@ -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');
|
||||
@@ -0,0 +1,111 @@
|
||||
#!/usr/bin/env bun
|
||||
/**
|
||||
* skill:check — Health summary for all SKILL.md files.
|
||||
*
|
||||
* Reports:
|
||||
* - Command validation (valid/invalid/snapshot errors)
|
||||
* - Template coverage (which SKILL.md files have .tmpl sources)
|
||||
* - Freshness check (generated files match committed files)
|
||||
*/
|
||||
|
||||
import { validateSkill } from '../test/helpers/skill-parser';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
const ROOT = path.resolve(import.meta.dir, '..');
|
||||
|
||||
// Find all SKILL.md files
|
||||
const SKILL_FILES = [
|
||||
'SKILL.md',
|
||||
'browse/SKILL.md',
|
||||
'qa/SKILL.md',
|
||||
'ship/SKILL.md',
|
||||
'review/SKILL.md',
|
||||
'retro/SKILL.md',
|
||||
'plan-ceo-review/SKILL.md',
|
||||
'plan-eng-review/SKILL.md',
|
||||
'setup-browser-cookies/SKILL.md',
|
||||
].filter(f => fs.existsSync(path.join(ROOT, f)));
|
||||
|
||||
let hasErrors = false;
|
||||
|
||||
// ─── Skills ─────────────────────────────────────────────────
|
||||
|
||||
console.log(' Skills:');
|
||||
for (const file of SKILL_FILES) {
|
||||
const fullPath = path.join(ROOT, file);
|
||||
const result = validateSkill(fullPath);
|
||||
|
||||
if (result.warnings.length > 0) {
|
||||
console.log(` \u26a0\ufe0f ${file.padEnd(30)} — ${result.warnings.join(', ')}`);
|
||||
continue;
|
||||
}
|
||||
|
||||
const totalValid = result.valid.length;
|
||||
const totalInvalid = result.invalid.length;
|
||||
const totalSnapErrors = result.snapshotFlagErrors.length;
|
||||
|
||||
if (totalInvalid > 0 || totalSnapErrors > 0) {
|
||||
hasErrors = true;
|
||||
console.log(` \u274c ${file.padEnd(30)} — ${totalValid} valid, ${totalInvalid} invalid, ${totalSnapErrors} snapshot errors`);
|
||||
for (const inv of result.invalid) {
|
||||
console.log(` line ${inv.line}: unknown command '${inv.command}'`);
|
||||
}
|
||||
for (const se of result.snapshotFlagErrors) {
|
||||
console.log(` line ${se.command.line}: ${se.error}`);
|
||||
}
|
||||
} else {
|
||||
console.log(` \u2705 ${file.padEnd(30)} — ${totalValid} commands, all valid`);
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Templates ──────────────────────────────────────────────
|
||||
|
||||
console.log('\n Templates:');
|
||||
const TEMPLATES = [
|
||||
{ tmpl: 'SKILL.md.tmpl', output: 'SKILL.md' },
|
||||
{ tmpl: 'browse/SKILL.md.tmpl', output: 'browse/SKILL.md' },
|
||||
];
|
||||
|
||||
for (const { tmpl, output } of TEMPLATES) {
|
||||
const tmplPath = path.join(ROOT, tmpl);
|
||||
const outPath = path.join(ROOT, output);
|
||||
if (!fs.existsSync(tmplPath)) {
|
||||
console.log(` \u26a0\ufe0f ${output.padEnd(30)} — no template`);
|
||||
continue;
|
||||
}
|
||||
if (!fs.existsSync(outPath)) {
|
||||
hasErrors = true;
|
||||
console.log(` \u274c ${output.padEnd(30)} — generated file missing! Run: bun run gen:skill-docs`);
|
||||
continue;
|
||||
}
|
||||
console.log(` \u2705 ${tmpl.padEnd(30)} \u2192 ${output}`);
|
||||
}
|
||||
|
||||
// Skills without templates
|
||||
for (const file of SKILL_FILES) {
|
||||
const tmplPath = path.join(ROOT, file + '.tmpl');
|
||||
if (!fs.existsSync(tmplPath) && !TEMPLATES.some(t => t.output === file)) {
|
||||
console.log(` \u26a0\ufe0f ${file.padEnd(30)} — no template (OK if no $B commands)`);
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Freshness ──────────────────────────────────────────────
|
||||
|
||||
console.log('\n Freshness:');
|
||||
try {
|
||||
execSync('bun run scripts/gen-skill-docs.ts --dry-run', { cwd: ROOT, stdio: 'pipe' });
|
||||
console.log(' \u2705 All generated files are fresh');
|
||||
} catch (err: any) {
|
||||
hasErrors = true;
|
||||
const output = err.stdout?.toString() || '';
|
||||
console.log(' \u274c Generated files are stale:');
|
||||
for (const line of output.split('\n').filter((l: string) => l.startsWith('STALE'))) {
|
||||
console.log(` ${line}`);
|
||||
}
|
||||
console.log(' Run: bun run gen:skill-docs');
|
||||
}
|
||||
|
||||
console.log('');
|
||||
process.exit(hasErrors ? 1 : 0);
|
||||
Reference in New Issue
Block a user