* 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
141 lines
6.5 KiB
JavaScript
141 lines
6.5 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.
|
|
|
|
/**
|
|
* Tests for modular decomposition of agents/gsd-planner.md
|
|
*
|
|
* Verifies that:
|
|
* 1. gsd-planner.md stays under the 100K agent file threshold
|
|
* 2. gsd-planner.md is under 45K chars (proving the three mode sections were extracted)
|
|
* 3. The three reference files exist
|
|
* 4. gsd-planner.md contains reference pointers to each extracted file
|
|
* 5. Each reference file contains key content from the original mode section
|
|
*/
|
|
'use strict';
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const PROJECT_ROOT = path.join(__dirname, '..');
|
|
|
|
// ─── Size thresholds ─────────────────────────────────────────────────────────
|
|
|
|
const AGENT_FILE_SIZE_LIMIT = 100 * 1024; // 100K — appropriate for version-controlled source
|
|
const PLANNER_EXTRACTED_LIMIT = 48 * 1024; // 48K — proves extraction happened
|
|
|
|
// ─── File paths ──────────────────────────────────────────────────────────────
|
|
|
|
const PLANNER_PATH = path.join(PROJECT_ROOT, 'agents', 'gsd-planner.md');
|
|
const GAP_CLOSURE_REF = path.join(PROJECT_ROOT, 'get-shit-done', 'references', 'planner-gap-closure.md');
|
|
const REVISION_REF = path.join(PROJECT_ROOT, 'get-shit-done', 'references', 'planner-revision.md');
|
|
const REVIEWS_REF = path.join(PROJECT_ROOT, 'get-shit-done', 'references', 'planner-reviews.md');
|
|
|
|
// ─── gsd-planner.md size ─────────────────────────────────────────────────────
|
|
|
|
describe('gsd-planner.md size constraints', () => {
|
|
test('planner file exists', () => {
|
|
assert.ok(fs.existsSync(PLANNER_PATH), `Missing: ${PLANNER_PATH}`);
|
|
});
|
|
|
|
test('planner is under 100K chars (agent file threshold)', () => {
|
|
const raw = fs.readFileSync(PLANNER_PATH, 'utf-8');
|
|
// Normalize CRLF → LF before measuring — Windows checkouts inflate length by ~1 char/line
|
|
const content = raw.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
|
|
assert.ok(
|
|
content.length < AGENT_FILE_SIZE_LIMIT,
|
|
`gsd-planner.md is ${content.length} chars, exceeds 100K agent threshold`
|
|
);
|
|
});
|
|
|
|
test('planner is under 45K chars (proves mode sections were extracted)', () => {
|
|
const raw = fs.readFileSync(PLANNER_PATH, 'utf-8');
|
|
// Normalize CRLF → LF before measuring — Windows checkouts inflate length by ~1 char/line
|
|
const content = raw.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
|
|
assert.ok(
|
|
content.length < PLANNER_EXTRACTED_LIMIT,
|
|
`gsd-planner.md is ${content.length} chars, expected < 45K after extracting mode sections`
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Reference files exist ───────────────────────────────────────────────────
|
|
|
|
describe('extracted reference files exist', () => {
|
|
test('planner-gap-closure.md exists', () => {
|
|
assert.ok(fs.existsSync(GAP_CLOSURE_REF), `Missing: ${GAP_CLOSURE_REF}`);
|
|
});
|
|
|
|
test('planner-revision.md exists', () => {
|
|
assert.ok(fs.existsSync(REVISION_REF), `Missing: ${REVISION_REF}`);
|
|
});
|
|
|
|
test('planner-reviews.md exists', () => {
|
|
assert.ok(fs.existsSync(REVIEWS_REF), `Missing: ${REVIEWS_REF}`);
|
|
});
|
|
});
|
|
|
|
// ─── gsd-planner.md contains reference pointers ──────────────────────────────
|
|
|
|
describe('gsd-planner.md contains reference pointers to extracted files', () => {
|
|
let plannerContent;
|
|
|
|
test('planner references planner-gap-closure.md', () => {
|
|
plannerContent = plannerContent || fs.readFileSync(PLANNER_PATH, 'utf-8');
|
|
assert.ok(
|
|
plannerContent.includes('planner-gap-closure.md'),
|
|
'gsd-planner.md must reference planner-gap-closure.md'
|
|
);
|
|
});
|
|
|
|
test('planner references planner-revision.md', () => {
|
|
plannerContent = plannerContent || fs.readFileSync(PLANNER_PATH, 'utf-8');
|
|
assert.ok(
|
|
plannerContent.includes('planner-revision.md'),
|
|
'gsd-planner.md must reference planner-revision.md'
|
|
);
|
|
});
|
|
|
|
test('planner references planner-reviews.md', () => {
|
|
plannerContent = plannerContent || fs.readFileSync(PLANNER_PATH, 'utf-8');
|
|
assert.ok(
|
|
plannerContent.includes('planner-reviews.md'),
|
|
'gsd-planner.md must reference planner-reviews.md'
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Reference files contain key content ────────────────────────────────────
|
|
|
|
describe('reference files contain key content from original mode sections', () => {
|
|
test('planner-gap-closure.md contains gap closure content', () => {
|
|
const content = fs.readFileSync(GAP_CLOSURE_REF, 'utf-8');
|
|
const hasGapContent = content.toLowerCase().includes('gap_closure') ||
|
|
content.toLowerCase().includes('gap closure') ||
|
|
content.includes('GAP CLOSURE') ||
|
|
content.includes('--gaps');
|
|
assert.ok(hasGapContent, 'planner-gap-closure.md must contain gap closure mode content');
|
|
});
|
|
|
|
test('planner-revision.md contains revision content', () => {
|
|
const content = fs.readFileSync(REVISION_REF, 'utf-8');
|
|
const hasRevisionContent = content.includes('revision') ||
|
|
content.includes('Revision') ||
|
|
content.includes('REVISION') ||
|
|
content.includes('revision_context');
|
|
assert.ok(hasRevisionContent, 'planner-revision.md must contain revision mode content');
|
|
});
|
|
|
|
test('planner-reviews.md contains reviews content', () => {
|
|
const content = fs.readFileSync(REVIEWS_REF, 'utf-8');
|
|
const hasReviewsContent = content.includes('reviews') ||
|
|
content.includes('Reviews') ||
|
|
content.includes('REVIEWS') ||
|
|
content.includes('REVIEWS.md');
|
|
assert.ok(hasReviewsContent, 'planner-reviews.md must contain reviews mode content');
|
|
});
|
|
});
|