Files
get-shit-done/tests/scan-command.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

58 lines
2.7 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.
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
// #2790: scan.md was consolidated into map-codebase.md as the --fast flag.
// The underlying workflow (workflows/scan.md) remains functional.
describe('scan command', () => {
test('scan is now a --fast flag on map-codebase.md (#2790)', () => {
const p = path.join(__dirname, '..', 'commands', 'gsd', 'map-codebase.md');
assert.ok(fs.existsSync(p), 'commands/gsd/map-codebase.md should exist');
const content = fs.readFileSync(p, 'utf-8');
assert.ok(content.includes('--fast'), 'map-codebase.md must document --fast flag (absorbed scan)');
assert.ok(content.includes('description:'), 'Command must have description frontmatter');
});
test('workflow file exists', () => {
const p = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'scan.md');
assert.ok(fs.existsSync(p), 'get-shit-done/workflows/scan.md should exist');
});
test('workflow has focus-to-document mapping table', () => {
const p = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'scan.md');
const content = fs.readFileSync(p, 'utf-8');
assert.ok(content.includes('Focus-to-Document Mapping') || content.includes('Focus | Documents'),
'Workflow should contain a focus-to-document mapping table');
});
test('all 5 focus areas are documented', () => {
const p = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'scan.md');
const content = fs.readFileSync(p, 'utf-8');
const focusAreas = ['tech', 'arch', 'quality', 'concerns', 'tech+arch'];
for (const area of focusAreas) {
assert.ok(content.includes(`\`${area}\``),
`Workflow should document the "${area}" focus area`);
}
});
test('overwrite prompt is mentioned', () => {
const p = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'scan.md');
const content = fs.readFileSync(p, 'utf-8');
assert.ok(content.includes('Overwrite') || content.includes('overwrite'),
'Workflow should mention overwrite prompt for existing documents');
});
test('workflow references gsd-codebase-mapper', () => {
const p = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'scan.md');
const content = fs.readFileSync(p, 'utf-8');
assert.ok(content.includes('gsd-codebase-mapper'),
'Workflow should reference the gsd-codebase-mapper agent');
});
});