Replace the single 747-line /gsd-help reference with a progressive-disclosure dispatcher (#2551 pattern). Newcomers get a one-page tour; returning users get a 10-line refresher with --brief; the complete reference stays available behind --full; /gsd-help <topic> emits one section; and /gsd-help --brief <topic> is a compact scoped lookup (signature + one-line summary). - workflows/help.md becomes a small dispatcher routing on $ARGUMENTS - workflows/help/modes/{brief,default,full,topic}.md hold the tier bodies - commands/gsd/help.md passes $ARGUMENTS through, advertises composable form - docs/COMMANDS.md documents the new flags and topic form - existing tests that read help.md repointed at help/modes/full.md (bug-2836, bug-2950, bug-2954, cursor-reviewer, execute-phase-wave) - new feat-3039-help-tiered test enforces structure, size budgets, dispatcher routing, shim arg passthrough, topic→section coverage, orphan-heading detection, conflict-resolution rules, routing preamble, and compact-scope rule Trek-e review fixes (PR #3040): - topic.md output rules split into 5a/5b/5c — explicit handling for single sections, multi-section "plus" joins, and bold-line sub-block anchors; each rule also takes scope (full vs compact) into account - explicit resolved-routing preamble line emitted by topic.md before content ("**Topic:** `<alias>` → `<heading>` *(scope: full | compact)*") so the user sees which alias matched at which scope (review finding #3) - composable `--brief <topic>` invokes topic.md in compact scope: heading + first `**/gsd:*`** signature line + one-line summary. Dispatcher and topic.md cooperate via $ARGUMENTS pass-through (review finding #4) - full.md capped at LARGE-tier budget (FULL_BUDGET = 1500); the non-recursive workflow-size-budget test does not reach modes/ subdirs - structural <progressive_disclosure> table parse (5-row assertion) replaces substring-soup regex matching — 5 rows = 4 base tiers + composable scope - forward /gsd:* sub-block token coverage + reverse orphan-heading allowlist catch alias-table drift in both directions - four conflict-resolution tests guard dispatcher promises (--brief+--full without topic → --full; --brief <topic> → compact; --full <topic> or bare → full; dispatcher retains --brief when delegating to topic.md) - hardcoded topic lists removed from docs/COMMANDS.md and full.md (drift surfaces reduced from 5 to 2) - topic.md alias bloat trimmed (~75 → ~25 rows); cleanup/update split into distinct sub-block rows under ### Utility Commands - comment-rot ("~750 lines") removed from default.md and full.md - dispatcher size guard tightened from < 100 to <= 40 lines - commands/gsd/help.md <process> block trimmed to one line - MD040 fence languages added to all plain code blocks across mode files Main-merge conflict resolution: - workflows/help.md kept as dispatcher (body lives in help/modes/full.md) - /gsd-<cmd> → /gsd:<cmd> rename from #3452 reapplied to the mode files (full.md, default.md, brief.md, topic.md) — the six namespace routers (/gsd-context, /gsd-ideate, /gsd-manage, /gsd-project, /gsd-quality, /gsd-workflow) and wildcards (/gsd-*) preserved in hyphen form per main's convention - bug-2950 test combines branch's path repointing with main's namespaced replacement strings
229 lines
7.0 KiB
JavaScript
229 lines
7.0 KiB
JavaScript
// allow-test-rule: pending-migration-to-typed-ir [#2974]
|
|
// Tracked in #2974 for migration to typed-IR assertions per CONTRIBUTING.md
|
|
// "Prohibited: Raw Text Matching on Test Outputs". Per-file review may
|
|
// reclassify some entries as source-text-is-the-product during migration.
|
|
|
|
/**
|
|
* Cursor CLI Reviewer Tests (#1960)
|
|
*
|
|
* Verifies that /gsd-review includes Cursor CLI as a peer reviewer:
|
|
* - review.md workflow contains cursor detection, flag parsing, self-detection, invocation
|
|
* - commands/gsd/review.md command file mentions --cursor flag
|
|
* - help.md lists --cursor in the /gsd-review signature
|
|
* - docs/COMMANDS.md has --cursor flag row
|
|
* - docs/FEATURES.md has Cursor in the review section
|
|
* - i18n docs mirror the same content
|
|
* - REVIEWS.md template includes Cursor Review section
|
|
*/
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const ROOT = path.join(__dirname, '..');
|
|
|
|
describe('Cursor CLI reviewer in /gsd-review (#1960)', () => {
|
|
|
|
// --- review.md workflow ---
|
|
|
|
describe('review.md workflow', () => {
|
|
const reviewPath = path.join(ROOT, 'get-shit-done', 'workflows', 'review.md');
|
|
let content;
|
|
|
|
test('review.md exists', () => {
|
|
assert.ok(fs.existsSync(reviewPath), 'review.md should exist');
|
|
content = fs.readFileSync(reviewPath, 'utf-8');
|
|
});
|
|
|
|
test('contains cursor CLI detection via command -v', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('command -v cursor'),
|
|
'review.md should detect cursor CLI via "command -v cursor"'
|
|
);
|
|
});
|
|
|
|
test('contains --cursor flag parsing', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'review.md should parse --cursor flag'
|
|
);
|
|
});
|
|
|
|
test('contains CURSOR_SESSION_ID self-detection', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('CURSOR_SESSION_ID'),
|
|
'review.md should detect self-CLI via CURSOR_SESSION_ID env var'
|
|
);
|
|
});
|
|
|
|
test('contains cursor agent invocation command', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('cursor agent -p --mode ask --trust'),
|
|
'review.md should invoke cursor via "cursor agent -p --mode ask --trust"'
|
|
);
|
|
});
|
|
|
|
test('contains Cursor Review section in REVIEWS.md template', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('Cursor Review'),
|
|
'review.md should include a "Cursor Review" section in the REVIEWS.md template'
|
|
);
|
|
});
|
|
|
|
test('lists cursor in the reviewers frontmatter array', () => {
|
|
const c = fs.readFileSync(reviewPath, 'utf-8');
|
|
assert.ok(
|
|
/reviewers:.*cursor/.test(c),
|
|
'review.md should list cursor in the reviewers array'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- commands/gsd/review.md ---
|
|
|
|
describe('commands/gsd/review.md', () => {
|
|
const cmdPath = path.join(ROOT, 'commands', 'gsd', 'review.md');
|
|
|
|
test('mentions --cursor flag', () => {
|
|
const c = fs.readFileSync(cmdPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'commands/gsd/review.md should mention --cursor flag'
|
|
);
|
|
});
|
|
|
|
test('mentions Cursor in objective or context', () => {
|
|
const c = fs.readFileSync(cmdPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('Cursor'),
|
|
'commands/gsd/review.md should mention Cursor'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- help.md ---
|
|
|
|
describe('help.md', () => {
|
|
// After #3039, help content moved into help/modes/full.md.
|
|
const helpPath = path.join(ROOT, 'get-shit-done', 'workflows', 'help', 'modes', 'full.md');
|
|
|
|
test('lists --cursor in /gsd-review signature', () => {
|
|
const c = fs.readFileSync(helpPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'help.md should list --cursor in the /gsd-review command signature'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- docs/COMMANDS.md ---
|
|
|
|
describe('docs/COMMANDS.md', () => {
|
|
const docsPath = path.join(ROOT, 'docs', 'COMMANDS.md');
|
|
|
|
test('has --cursor flag row', () => {
|
|
const c = fs.readFileSync(docsPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/COMMANDS.md should have a --cursor flag row'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- docs/FEATURES.md ---
|
|
|
|
describe('docs/FEATURES.md', () => {
|
|
const featPath = path.join(ROOT, 'docs', 'FEATURES.md');
|
|
|
|
test('has --cursor in review command signature', () => {
|
|
const c = fs.readFileSync(featPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/FEATURES.md should include --cursor in the review command signature'
|
|
);
|
|
});
|
|
|
|
test('mentions Cursor in the review purpose', () => {
|
|
const c = fs.readFileSync(featPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('Cursor'),
|
|
'docs/FEATURES.md should mention Cursor in the review section'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- i18n: ja-JP ---
|
|
|
|
describe('docs/ja-JP/COMMANDS.md', () => {
|
|
const jaPath = path.join(ROOT, 'docs', 'ja-JP', 'COMMANDS.md');
|
|
|
|
test('has --cursor flag row', () => {
|
|
const c = fs.readFileSync(jaPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/ja-JP/COMMANDS.md should have a --cursor flag row'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('docs/ja-JP/FEATURES.md', () => {
|
|
const jaPath = path.join(ROOT, 'docs', 'ja-JP', 'FEATURES.md');
|
|
|
|
test('has --cursor in review command signature', () => {
|
|
const c = fs.readFileSync(jaPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/ja-JP/FEATURES.md should include --cursor in the review command signature'
|
|
);
|
|
});
|
|
|
|
test('mentions Cursor in the review section', () => {
|
|
const c = fs.readFileSync(jaPath, 'utf-8');
|
|
assert.ok(
|
|
/Cursor/i.test(fs.readFileSync(jaPath, 'utf-8')),
|
|
'docs/ja-JP/FEATURES.md should mention Cursor in the review section'
|
|
);
|
|
});
|
|
});
|
|
|
|
// --- i18n: ko-KR ---
|
|
|
|
describe('docs/ko-KR/COMMANDS.md', () => {
|
|
const koPath = path.join(ROOT, 'docs', 'ko-KR', 'COMMANDS.md');
|
|
|
|
test('has --cursor flag row', () => {
|
|
const c = fs.readFileSync(koPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/ko-KR/COMMANDS.md should have a --cursor flag row'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('docs/ko-KR/FEATURES.md', () => {
|
|
const koPath = path.join(ROOT, 'docs', 'ko-KR', 'FEATURES.md');
|
|
|
|
test('has --cursor in review command signature', () => {
|
|
const c = fs.readFileSync(koPath, 'utf-8');
|
|
assert.ok(
|
|
c.includes('--cursor'),
|
|
'docs/ko-KR/FEATURES.md should include --cursor in the review command signature'
|
|
);
|
|
});
|
|
|
|
test('mentions Cursor in the review section', () => {
|
|
const c = fs.readFileSync(koPath, 'utf-8');
|
|
assert.ok(
|
|
/Cursor/i.test(fs.readFileSync(koPath, 'utf-8')),
|
|
'docs/ko-KR/FEATURES.md should mention Cursor in the review section'
|
|
);
|
|
});
|
|
});
|
|
});
|