918f987a19
* 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
109 lines
4.7 KiB
JavaScript
109 lines
4.7 KiB
JavaScript
'use strict';
|
|
|
|
// allow-test-rule: source-text-is-the-product
|
|
// Reads .md/.json/.yml product files whose deployed text IS what the
|
|
// runtime loads — testing text content tests the deployed contract.
|
|
|
|
/**
|
|
* Tests for claude_md_assembly "link" mode (#2415).
|
|
* Verifies that generate-claude-md writes @-references instead of inlined
|
|
* content when claude_md_assembly.mode is "link".
|
|
*/
|
|
|
|
const { test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const os = require('node:os');
|
|
|
|
const { cmdGenerateClaudeMd } = require('../get-shit-done/bin/lib/profile-output.cjs');
|
|
|
|
function makeTempProject(files = {}) {
|
|
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-2415-'));
|
|
fs.mkdirSync(path.join(dir, '.planning', 'codebase'), { recursive: true });
|
|
for (const [rel, content] of Object.entries(files)) {
|
|
const abs = path.join(dir, rel);
|
|
fs.mkdirSync(path.dirname(abs), { recursive: true });
|
|
fs.writeFileSync(abs, content, 'utf-8');
|
|
}
|
|
return dir;
|
|
}
|
|
|
|
test('link mode writes @-reference for architecture section', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/codebase/ARCHITECTURE.md': '# Architecture\n\n- layered\n',
|
|
'.planning/config.json': JSON.stringify({ claude_md_assembly: { mode: 'link' } }),
|
|
});
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
assert.ok(content.includes('@.planning/codebase/ARCHITECTURE.md'), 'should contain @-reference');
|
|
assert.ok(!content.includes('- layered'), 'should not inline architecture content');
|
|
});
|
|
|
|
test('link mode writes @-reference for project section', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/PROJECT.md': '# My Project\n\n## What This Is\n\nA great app.\n',
|
|
'.planning/config.json': JSON.stringify({ claude_md_assembly: { mode: 'link' } }),
|
|
});
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
assert.ok(content.includes('@.planning/PROJECT.md'), 'should contain @-reference for project');
|
|
assert.ok(!content.includes('A great app.'), 'should not inline project content');
|
|
});
|
|
|
|
test('embed mode (default) inlines content as before', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/codebase/ARCHITECTURE.md': '# Architecture\n\n- monolith\n',
|
|
});
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
assert.ok(content.includes('- monolith'), 'embed mode should inline content');
|
|
assert.ok(!content.includes('@.planning/codebase/ARCHITECTURE.md'), 'embed mode should not write @-reference');
|
|
});
|
|
|
|
test('per-block override: link only architecture, embed others', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/PROJECT.md': '# Proj\n\n## What This Is\n\nApp.\n',
|
|
'.planning/codebase/ARCHITECTURE.md': '# Arch\n\n- layers\n',
|
|
'.planning/config.json': JSON.stringify({ claude_md_assembly: { mode: 'embed', blocks: { architecture: 'link' } } }),
|
|
});
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
assert.ok(content.includes('@.planning/codebase/ARCHITECTURE.md'), 'architecture should use link');
|
|
assert.ok(!content.includes('@.planning/PROJECT.md'), 'project should use embed');
|
|
assert.ok(content.includes('App.'), 'project content should be inlined');
|
|
});
|
|
|
|
test('link mode falls back to embed for workflow section (no linkable source)', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/config.json': JSON.stringify({ claude_md_assembly: { mode: 'link' } }),
|
|
});
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
// workflow section should still be inlined (it has no linkPath)
|
|
assert.ok(!content.includes('@GSD defaults'), 'workflow should not write @GSD defaults');
|
|
assert.ok(content.includes('GSD Workflow Enforcement'), 'workflow content should be embedded inline');
|
|
});
|
|
|
|
test('link mode falls back to embed when source file is missing (hasFallback)', () => {
|
|
const dir = makeTempProject({
|
|
'.planning/config.json': JSON.stringify({ claude_md_assembly: { mode: 'link' } }),
|
|
});
|
|
// No .planning/codebase/ARCHITECTURE.md — generator will use fallback
|
|
|
|
cmdGenerateClaudeMd(dir, { output: path.join(dir, 'CLAUDE.md') }, false);
|
|
|
|
const content = fs.readFileSync(path.join(dir, 'CLAUDE.md'), 'utf-8');
|
|
assert.ok(!content.includes('@.planning/codebase/ARCHITECTURE.md'), 'fallback section should not write @-reference');
|
|
});
|