Files
msd-core/tests/phase-researcher-flow-diagram.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

110 lines
3.8 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.
/**
* Phase Researcher Flow Diagram Tests (#2139)
*
* Validates that gsd-phase-researcher enforces data-flow architecture
* diagrams instead of file-listing diagrams. Also validates that the
* research template includes the matching directive.
*/
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const AGENTS_DIR = path.join(__dirname, '..', 'agents');
const TEMPLATES_DIR = path.join(__dirname, '..', 'get-shit-done', 'templates');
// ─── Phase Researcher: System Architecture Diagram Directive ─────────────────
describe('phase-researcher: System Architecture Diagram directive', () => {
const researcherPath = path.join(AGENTS_DIR, 'gsd-phase-researcher.md');
const content = fs.readFileSync(researcherPath, 'utf-8');
test('contains System Architecture Diagram section', () => {
assert.ok(
content.includes('### System Architecture Diagram'),
'gsd-phase-researcher.md must contain "### System Architecture Diagram"'
);
});
test('requires data flow through conceptual components', () => {
assert.ok(
content.includes('data flow through conceptual components'),
'Directive must require "data flow through conceptual components"'
);
});
test('explicitly prohibits file listings in diagrams', () => {
assert.ok(
content.includes('not file listings'),
'Directive must explicitly state "not file listings"'
);
});
test('includes key requirements for flow diagrams', () => {
const requirements = [
'entry points',
'processing stages',
'decision points',
'external dependencies',
'arrows',
];
for (const req of requirements) {
assert.ok(
content.toLowerCase().includes(req),
`Directive must mention "${req}"`
);
}
});
test('directs file-to-implementation mapping to Component Responsibilities table', () => {
assert.ok(
content.includes('Component Responsibilities table'),
'Directive must redirect file mapping to Component Responsibilities table'
);
});
test('diagram section comes before Recommended Project Structure', () => {
const diagramPos = content.indexOf('### System Architecture Diagram');
const structurePos = content.indexOf('### Recommended Project Structure');
assert.ok(diagramPos !== -1, 'System Architecture Diagram section must exist');
assert.ok(structurePos !== -1, 'Recommended Project Structure section must exist');
assert.ok(
diagramPos < structurePos,
'System Architecture Diagram must come before Recommended Project Structure'
);
});
});
// ─── Research Template: System Architecture Diagram Section ───────────────────
describe('research template: System Architecture Diagram section', () => {
const templatePath = path.join(TEMPLATES_DIR, 'research.md');
const content = fs.readFileSync(templatePath, 'utf-8');
test('contains System Architecture Diagram section', () => {
assert.ok(
content.includes('### System Architecture Diagram'),
'Research template must contain "### System Architecture Diagram"'
);
});
test('includes flow diagram requirements', () => {
assert.ok(
content.includes('data flow through conceptual components'),
'Research template must include flow diagram directive'
);
assert.ok(
content.includes('not file listings'),
'Research template must prohibit file listings in diagrams'
);
});
});