* 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
104 lines
3.8 KiB
JavaScript
104 lines
3.8 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.
|
|
|
|
/**
|
|
* Regression test for #2431: quick.md and execute-phase.md worktree teardown
|
|
* silently accumulates locked worktrees via `2>/dev/null || true`.
|
|
*
|
|
* Fix: replace the silent-fail pattern with a lock-aware block that surfaces
|
|
* the error and provides a user-visible recovery message.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const QUICK_PATH = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'quick.md');
|
|
const EXECUTE_PHASE_PATH = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'execute-phase.md');
|
|
|
|
function assertNoSilentWorktreeRemove(filePath, label) {
|
|
const content = fs.readFileSync(filePath, 'utf-8');
|
|
// The old pattern: git worktree remove "$WT" --force 2>/dev/null || true
|
|
const silentRemovePattern = /git worktree remove[^\n]*--force\s+2>\/dev\/null\s*\|\|\s*true/;
|
|
assert.ok(
|
|
!silentRemovePattern.test(content),
|
|
`${label}: must not contain "git worktree remove --force 2>/dev/null || true" (silently swallows errors)`
|
|
);
|
|
}
|
|
|
|
function assertHasLockAwareBlock(filePath, label) {
|
|
const content = fs.readFileSync(filePath, 'utf-8');
|
|
// Fix must include: lock-aware detection (checking .git/worktrees/*/locked)
|
|
const hasLockCheck = content.includes('.git/worktrees/') && content.includes('locked');
|
|
assert.ok(
|
|
hasLockCheck,
|
|
`${label}: must include lock-aware detection (.git/worktrees/.../locked check)`
|
|
);
|
|
}
|
|
|
|
function assertHasWorktreeUnlock(filePath, label) {
|
|
const content = fs.readFileSync(filePath, 'utf-8');
|
|
// Fix must include a git worktree unlock attempt
|
|
assert.ok(
|
|
content.includes('git worktree unlock'),
|
|
`${label}: must include "git worktree unlock" retry attempt`
|
|
);
|
|
}
|
|
|
|
function assertHasUserVisibleWarning(filePath, label) {
|
|
const content = fs.readFileSync(filePath, 'utf-8');
|
|
// Fix must print a user-visible warning on residual worktree failure
|
|
const hasWarning = content.includes('Residual worktree') || content.includes('manual cleanup');
|
|
assert.ok(
|
|
hasWarning,
|
|
`${label}: must include user-visible warning when worktree removal fails`
|
|
);
|
|
}
|
|
|
|
describe('bug-2431: worktree teardown must surface locked-worktree errors', () => {
|
|
test('quick.md exists', () => {
|
|
assert.ok(fs.existsSync(QUICK_PATH), 'quick.md should exist');
|
|
});
|
|
|
|
test('execute-phase.md exists', () => {
|
|
assert.ok(fs.existsSync(EXECUTE_PHASE_PATH), 'execute-phase.md should exist');
|
|
});
|
|
|
|
test('quick.md: no silent worktree remove pattern', () => {
|
|
assertNoSilentWorktreeRemove(QUICK_PATH, 'quick.md');
|
|
});
|
|
|
|
test('execute-phase.md: no silent worktree remove pattern', () => {
|
|
assertNoSilentWorktreeRemove(EXECUTE_PHASE_PATH, 'execute-phase.md');
|
|
});
|
|
|
|
test('quick.md: has lock-aware detection block', () => {
|
|
assertHasLockAwareBlock(QUICK_PATH, 'quick.md');
|
|
});
|
|
|
|
test('execute-phase.md: has lock-aware detection block', () => {
|
|
assertHasLockAwareBlock(EXECUTE_PHASE_PATH, 'execute-phase.md');
|
|
});
|
|
|
|
test('quick.md: has git worktree unlock retry', () => {
|
|
assertHasWorktreeUnlock(QUICK_PATH, 'quick.md');
|
|
});
|
|
|
|
test('execute-phase.md: has git worktree unlock retry', () => {
|
|
assertHasWorktreeUnlock(EXECUTE_PHASE_PATH, 'execute-phase.md');
|
|
});
|
|
|
|
test('quick.md: has user-visible warning on residual worktree', () => {
|
|
assertHasUserVisibleWarning(QUICK_PATH, 'quick.md');
|
|
});
|
|
|
|
test('execute-phase.md: has user-visible warning on residual worktree', () => {
|
|
assertHasUserVisibleWarning(EXECUTE_PHASE_PATH, 'execute-phase.md');
|
|
});
|
|
});
|