Files
msd-core/tests/anti-pattern-enforcement.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

182 lines
7.3 KiB
JavaScript

'use strict';
// 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.
/**
* Anti-Pattern Enforcement Tests (#1491)
*
* Validates that the handoff/resume system structurally enforces critical
* anti-patterns via severity levels and mandatory understanding checks.
*/
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const PAUSE_WORK = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'pause-work.md');
const DISCUSS_PHASE = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase.md');
const EXECUTE_PHASE = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'execute-phase.md');
describe('pause-work.md — severity column in Critical Anti-Patterns template', () => {
test('template includes a Severity column header in the anti-patterns table', () => {
const content = fs.readFileSync(PAUSE_WORK, 'utf-8');
assert.ok(
content.includes('Severity') || content.includes('severity'),
'pause-work.md template must include a Severity column in the anti-patterns table'
);
});
test('template documents "blocking" as a valid severity value', () => {
const content = fs.readFileSync(PAUSE_WORK, 'utf-8');
assert.ok(
content.includes('blocking'),
'pause-work.md must document "blocking" as a valid severity value'
);
});
test('template documents "advisory" as a valid severity value', () => {
const content = fs.readFileSync(PAUSE_WORK, 'utf-8');
assert.ok(
content.includes('advisory'),
'pause-work.md must document "advisory" as a valid severity value'
);
});
test('template explains that blocking anti-patterns trigger understanding check at resume', () => {
const content = fs.readFileSync(PAUSE_WORK, 'utf-8');
const hasExplanation =
(content.includes('blocking') && content.includes('understanding check')) ||
(content.includes('blocking') && content.includes('resume')) ||
(content.includes('blocking') && content.includes('understanding'));
assert.ok(
hasExplanation,
'pause-work.md must explain that blocking anti-patterns trigger an understanding check at resume'
);
});
});
describe('discuss-phase.md — blocking anti-pattern understanding check', () => {
test('workflow checks for .continue-here.md with blocking anti-patterns', () => {
const content = fs.readFileSync(DISCUSS_PHASE, 'utf-8');
const hasCheck =
content.includes('.continue-here.md') &&
(content.includes('blocking') || content.includes('anti-pattern'));
assert.ok(
hasCheck,
'discuss-phase.md must check for .continue-here.md blocking anti-patterns before proceeding'
);
});
test('workflow includes mandatory understanding verification for blocking anti-patterns', () => {
const content = fs.readFileSync(DISCUSS_PHASE, 'utf-8');
const hasVerification =
content.includes('understanding') ||
content.includes('understanding check') ||
content.includes('demonstrate understanding');
assert.ok(
hasVerification,
'discuss-phase.md must include a mandatory understanding verification step for blocking anti-patterns'
);
});
test('workflow specifies the three understanding check questions', () => {
const content = fs.readFileSync(DISCUSS_PHASE, 'utf-8');
// The three questions required by the issue
const hasWhatIs =
content.includes('What is this anti-pattern') ||
content.includes('what is this anti-pattern') ||
content.includes('What is the anti-pattern');
const hasHowManifest =
content.includes('How did it manifest') ||
content.includes('how did it manifest') ||
content.includes('manifest');
const hasPreventMechanism =
content.includes('structural mechanism') ||
content.includes('prevention') ||
content.includes('Prevention');
assert.ok(
hasWhatIs && hasHowManifest && hasPreventMechanism,
'discuss-phase.md must include the three understanding check questions: ' +
'"What is this anti-pattern?", "How did it manifest?", "What structural mechanism prevents it?"'
);
});
test('understanding check cannot be skipped (must be mandatory)', () => {
const content = fs.readFileSync(DISCUSS_PHASE, 'utf-8');
const hasMandatory =
content.includes('cannot be skipped') ||
content.includes('must not be skipped') ||
content.includes('mandatory') ||
content.includes('MANDATORY') ||
content.includes('required before');
assert.ok(
hasMandatory,
'discuss-phase.md must indicate that the blocking anti-pattern understanding check cannot be skipped'
);
});
});
describe('execute-phase.md — blocking anti-pattern understanding check', () => {
test('workflow checks for .continue-here.md with blocking anti-patterns', () => {
const content = fs.readFileSync(EXECUTE_PHASE, 'utf-8');
const hasCheck =
content.includes('.continue-here.md') &&
(content.includes('blocking') || content.includes('anti-pattern'));
assert.ok(
hasCheck,
'execute-phase.md must check for .continue-here.md blocking anti-patterns before proceeding'
);
});
test('workflow includes mandatory understanding verification for blocking anti-patterns', () => {
const content = fs.readFileSync(EXECUTE_PHASE, 'utf-8');
const hasVerification =
content.includes('understanding') ||
content.includes('understanding check') ||
content.includes('demonstrate understanding');
assert.ok(
hasVerification,
'execute-phase.md must include a mandatory understanding verification step for blocking anti-patterns'
);
});
test('workflow specifies the three understanding check questions', () => {
const content = fs.readFileSync(EXECUTE_PHASE, 'utf-8');
const hasWhatIs =
content.includes('What is this anti-pattern') ||
content.includes('what is this anti-pattern') ||
content.includes('What is the anti-pattern');
const hasHowManifest =
content.includes('How did it manifest') ||
content.includes('how did it manifest') ||
content.includes('manifest');
const hasPreventMechanism =
content.includes('structural mechanism') ||
content.includes('prevention') ||
content.includes('Prevention');
assert.ok(
hasWhatIs && hasHowManifest && hasPreventMechanism,
'execute-phase.md must include the three understanding check questions: ' +
'"What is this anti-pattern?", "How did it manifest?", "What structural mechanism prevents it?"'
);
});
test('understanding check cannot be skipped (must be mandatory)', () => {
const content = fs.readFileSync(EXECUTE_PHASE, 'utf-8');
const hasMandatory =
content.includes('cannot be skipped') ||
content.includes('must not be skipped') ||
content.includes('mandatory') ||
content.includes('MANDATORY') ||
content.includes('required before');
assert.ok(
hasMandatory,
'execute-phase.md must indicate that the blocking anti-pattern understanding check cannot be skipped'
);
});
});