* 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
112 lines
3.9 KiB
JavaScript
112 lines
3.9 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". Do not copy this pattern.
|
|
|
|
/**
|
|
* Bug #2524: gsd-sdk query --ws <name> silently ignores the workstream flag.
|
|
* Tests that --ws is forwarded through the call chain:
|
|
* cli.ts -> registry.dispatch() -> planningPaths()
|
|
*
|
|
* Uses static source-file text assertions (no sdk/dist/ build required in CI).
|
|
*/
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
|
|
const helpersTs = fs.readFileSync(
|
|
path.join(__dirname, '../sdk/src/query/helpers.ts'),
|
|
'utf-8',
|
|
);
|
|
const registryTs = fs.readFileSync(
|
|
path.join(__dirname, '../sdk/src/query/registry.ts'),
|
|
'utf-8',
|
|
);
|
|
const cliTs = fs.readFileSync(
|
|
path.join(__dirname, '../sdk/src/cli.ts'),
|
|
'utf-8',
|
|
);
|
|
|
|
// ─── Layer 3: planningPaths() accepts workstream ───────────────────────────
|
|
|
|
describe('planningPaths() workstream support', () => {
|
|
test('planningPaths signature includes optional workstream parameter', () => {
|
|
assert.ok(
|
|
helpersTs.includes('planningPaths(projectDir: string, workstream?: string)'),
|
|
'planningPaths must accept an optional workstream parameter',
|
|
);
|
|
});
|
|
|
|
test('planningPaths uses relPlanningPath(workstream) to compute the base path', () => {
|
|
assert.ok(
|
|
helpersTs.includes('relPlanningPath(workstream)'),
|
|
'planningPaths must call relPlanningPath(workstream) to scope the base path',
|
|
);
|
|
});
|
|
|
|
test('planningPaths imports relPlanningPath from workstream-utils', () => {
|
|
assert.ok(
|
|
helpersTs.includes('relPlanningPath'),
|
|
'helpers.ts must import/use relPlanningPath from workstream-utils',
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Layer 2: QueryRegistry.dispatch() accepts workstream ─────────────────
|
|
|
|
describe('QueryRegistry.dispatch() workstream threading', () => {
|
|
test('dispatch method signature includes workstream parameter', () => {
|
|
assert.ok(
|
|
registryTs.includes('workstream?: string'),
|
|
'dispatch() must accept an optional workstream parameter',
|
|
);
|
|
});
|
|
|
|
test('dispatch forwards workstream to the handler as third argument', () => {
|
|
assert.ok(
|
|
registryTs.includes('handler(args, projectDir, workstream)'),
|
|
'dispatch() must pass workstream as the third argument to the handler',
|
|
);
|
|
});
|
|
|
|
test('QueryHandler type accepts a third workstream argument', () => {
|
|
// QueryHandler type is defined in utils.ts, but registry.ts imports and uses it
|
|
const utilsTs = fs.readFileSync(
|
|
path.join(__dirname, '../sdk/src/query/utils.ts'),
|
|
'utf-8',
|
|
);
|
|
assert.ok(
|
|
utilsTs.includes('workstream?: string') && utilsTs.includes('QueryHandler'),
|
|
'QueryHandler type must include an optional workstream parameter',
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Layer 1: CLI forwards args.ws to registry.dispatch() ─────────────────
|
|
|
|
describe('CLI forwards --ws to registry.dispatch()', () => {
|
|
test('cli.ts passes args.ws as the workstream argument to registry.dispatch()', () => {
|
|
assert.ok(
|
|
cliTs.includes('registry.dispatch(matched.cmd, matched.args, args.projectDir, args.ws)'),
|
|
'cli.ts must forward args.ws to registry.dispatch() as the workstream argument',
|
|
);
|
|
});
|
|
|
|
test('cli.ts defines a ws field in ParsedCliArgs', () => {
|
|
assert.ok(
|
|
cliTs.includes('ws: string | undefined'),
|
|
'ParsedCliArgs must have a ws field typed as string | undefined',
|
|
);
|
|
});
|
|
|
|
test('cli.ts parses --ws flag from query argv', () => {
|
|
assert.ok(
|
|
cliTs.includes("if (a === '--ws' && argv[i + 1])"),
|
|
'cli.ts query permissive parser must handle the --ws flag',
|
|
);
|
|
});
|
|
});
|