Files
msd-core/tests/cursor-reviewer.test.cjs
Tom Boucher 918f987a19 feat(#2982): extend no-source-grep lint to catch var-binding readFileSync.includes() (#2985)
* feat(#2982): extend no-source-grep lint to catch var-binding readFileSync.includes()

The base lint (scripts/lint-no-source-grep.cjs) only catches
readFileSync(...).<text-method>() chained directly. The much more
common var-binding form escapes it:

  const src = fs.readFileSync(p, 'utf8');
  // 50 lines later
  if (src.includes('foo')) {}        // ← still grep, lint missed it

Scan of the test suite found ~141 files using this pattern.

Implementation built TDD per #2982 with structured-IR assertions:

  scripts/lint-no-source-grep-extras.cjs
    - detectVarBindingViolations(src) — pure detector, two passes:
      pass 1 collects vars bound from readFileSync, pass 2 finds any
      <var>.<includes|startsWith|endsWith|match|search>( on those vars.
    - detectWrappedAssertOkMatch(src) — flags
      assert.ok(<expr>.match(...)) which escapes the assert.match rule.
    - VIOLATION enum exposes stable codes for tests to assert on.

  scripts/lint-no-source-grep.cjs
    - Wires the new detectors into the existing per-file check; one
      additional violation row per file with the first 3 sample tokens.

  tests/bug-2982-lint-var-binding.test.cjs
    - 13 tests, all assertions on typed VIOLATION enum / structured
      records. Covers all 5 text-match methods, multi-var, no-bind,
      string literal (must NOT trigger), wrapped assert.ok(.match),
      and assert.match (must NOT double-flag).

Migration backlog (#2974 expanded scope):

  - 42 files annotated `// allow-test-rule: source-text-is-the-product`
    (legitimate — they read .md/.json/.yml files whose deployed text
    IS the product)
  - 3 files annotated `// allow-test-rule: pending-migration-to-typed-ir [#2974]`
    (read .cjs/.js source — clear migration debt)
  - 95 files annotated `pending-migration-to-typed-ir [#2974]` with
    `Per-file review may reclassify as source-text-is-the-product
    during migration` (mixed — manual review under #2974)

After this lands the lint reports 0 violations on main; new
violations in PRs surface immediately.

Closes #2982
Refs #2974

* test(#2982): fix truncated test name per CR

The label ended with a bare '(' from a copy-paste mishap. Now reads
'does NOT flag .matchAll(...) — matchAll is not match, so
assert.ok(.matchAll(...)) is not flagged'.

* chore(#2982): add changeset fragment for PR #2985

* chore(#2982): add changeset fragment for PR #2985
2026-05-01 19:50:10 -04:00

228 lines
6.9 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', () => {
const helpPath = path.join(ROOT, 'get-shit-done', 'workflows', 'help.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'
);
});
});
});