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
89 lines
3.3 KiB
JavaScript
89 lines
3.3 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 guard for #2012: AskUserQuestion is Claude Code-only — non-Claude
|
|
* runtimes (OpenAI Codex, Gemini, etc.) render it as a markdown code block
|
|
* instead of triggering the interactive TUI, so the session stalls.
|
|
*
|
|
* Every workflow that calls AskUserQuestion MUST include a TEXT_MODE fallback
|
|
* instruction so that, when `workflow.text_mode` is true (or `--text` is
|
|
* passed), all AskUserQuestion calls are replaced with plain-text numbered
|
|
* lists that any runtime can handle.
|
|
*
|
|
* The canonical fallback phrase is:
|
|
* "TEXT_MODE" (or "text_mode") paired with "plain-text" (or "plain text")
|
|
* near the first AskUserQuestion reference in the file.
|
|
*/
|
|
'use strict';
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const ROOT = path.join(__dirname, '..');
|
|
const WORKFLOWS_DIR = path.join(ROOT, 'get-shit-done', 'workflows');
|
|
|
|
/**
|
|
* Return true if the file content contains a TEXT_MODE / text_mode fallback
|
|
* instruction for AskUserQuestion calls.
|
|
*
|
|
* Acceptable forms (case-insensitive on key terms):
|
|
* - "TEXT_MODE" + "plain-text" or "plain text"
|
|
* - "text_mode" + "plain-text" or "plain text"
|
|
* - "text mode" + "plain-text" or "plain text"
|
|
*/
|
|
function hasTextModeFallback(content) {
|
|
const lower = content.toLowerCase();
|
|
const hasTextMode =
|
|
lower.includes('text_mode') ||
|
|
lower.includes('text mode');
|
|
const hasPlainText =
|
|
lower.includes('plain-text') ||
|
|
lower.includes('plain text') ||
|
|
lower.includes('numbered list');
|
|
return hasTextMode && hasPlainText;
|
|
}
|
|
|
|
describe('AskUserQuestion text-mode fallback (#2012)', () => {
|
|
test('every workflow that uses AskUserQuestion includes a TEXT_MODE plain-text fallback', () => {
|
|
const violations = [];
|
|
|
|
const files = fs.readdirSync(WORKFLOWS_DIR).filter(f => f.endsWith('.md'));
|
|
|
|
for (const fname of files) {
|
|
const fpath = path.join(WORKFLOWS_DIR, fname);
|
|
const content = fs.readFileSync(fpath, 'utf-8');
|
|
|
|
if (!content.includes('AskUserQuestion')) continue;
|
|
|
|
if (!hasTextModeFallback(content)) {
|
|
violations.push(fname);
|
|
}
|
|
}
|
|
|
|
assert.strictEqual(
|
|
violations.length,
|
|
0,
|
|
[
|
|
'AskUserQuestion is Claude Code-only (issue #2012).',
|
|
'Every workflow that uses AskUserQuestion must include a TEXT_MODE fallback',
|
|
'so non-Claude runtimes (OpenAI Codex, Gemini, etc.) can present questions',
|
|
'as plain-text numbered lists instead of stalling on an unexecuted tool call.',
|
|
'',
|
|
'Add this near the argument-parsing section of each workflow:',
|
|
' Set TEXT_MODE=true if --text is present in $ARGUMENTS OR text_mode from',
|
|
' init JSON is true. When TEXT_MODE is active, replace every AskUserQuestion',
|
|
' call with a plain-text numbered list and ask the user to type their choice',
|
|
' number.',
|
|
'',
|
|
'Workflows missing the fallback:',
|
|
...violations.map(v => ' get-shit-done/workflows/' + v),
|
|
].join('\n')
|
|
);
|
|
});
|
|
});
|