mirror of
https://github.com/glittercowboy/get-shit-done
synced 2026-05-15 11:36:37 +02:00
* 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
155 lines
5.6 KiB
JavaScript
155 lines
5.6 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 #2831: OpenCode @file references contain literal `$HOME`
|
|
* which OpenCode does not expand — `@$HOME/.config/opencode/...` is resolved
|
|
* as a path relative to the config command/ dir, producing
|
|
* `command/$HOME/.config/opencode/...` (file not found).
|
|
*
|
|
* Root cause: install.js pathPrefix used `$HOME`-relative paths for OpenCode on
|
|
* non-Windows hosts (only Windows was guarded by #2376). OpenCode's `@file`
|
|
* include syntax does NOT shell-expand `$HOME` on any platform.
|
|
*
|
|
* Fix: pathPrefix must use the absolute path for OpenCode on all platforms.
|
|
*
|
|
* Tests exercise install.js's exported `computePathPrefix` directly (no source
|
|
* grepping) and additionally simulate the `copyFlattenedCommands` substitution
|
|
* pipeline on a temp tree to verify no `$HOME` literal leaks into emitted files.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const { describe, test, before, after } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const os = require('os');
|
|
|
|
let computePathPrefix;
|
|
|
|
before(() => {
|
|
process.env.GSD_TEST_MODE = '1';
|
|
delete require.cache[require.resolve('../bin/install.js')];
|
|
({ computePathPrefix } = require('../bin/install.js'));
|
|
});
|
|
|
|
after(() => {
|
|
delete process.env.GSD_TEST_MODE;
|
|
});
|
|
|
|
describe('bug-2831: OpenCode pathPrefix uses absolute path on all platforms', () => {
|
|
test('computePathPrefix is exported by install.js', () => {
|
|
assert.equal(typeof computePathPrefix, 'function');
|
|
});
|
|
|
|
test('OpenCode on macOS: pathPrefix is absolute (no $HOME)', () => {
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: true,
|
|
isOpencode: true,
|
|
isWindowsHost: false,
|
|
homeDir: '/Users/alice',
|
|
resolvedTarget: '/Users/alice/.config/opencode',
|
|
});
|
|
assert.strictEqual(pathPrefix, '/Users/alice/.config/opencode/');
|
|
assert.ok(!pathPrefix.includes('$HOME'));
|
|
});
|
|
|
|
test('OpenCode on Linux: pathPrefix is absolute (no $HOME)', () => {
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: true,
|
|
isOpencode: true,
|
|
isWindowsHost: false,
|
|
homeDir: '/home/bob',
|
|
resolvedTarget: '/home/bob/.config/opencode',
|
|
});
|
|
assert.strictEqual(pathPrefix, '/home/bob/.config/opencode/');
|
|
assert.ok(!pathPrefix.includes('$HOME'));
|
|
});
|
|
|
|
test('OpenCode on Windows: pathPrefix is absolute (preserves #2376)', () => {
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: true,
|
|
isOpencode: true,
|
|
isWindowsHost: true,
|
|
homeDir: 'C:/Users/carol',
|
|
resolvedTarget: 'C:/Users/carol/.config/opencode',
|
|
});
|
|
assert.strictEqual(pathPrefix, 'C:/Users/carol/.config/opencode/');
|
|
});
|
|
|
|
test('Claude Code on macOS: pathPrefix still uses $HOME (unaffected)', () => {
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: true,
|
|
isOpencode: false,
|
|
isWindowsHost: false,
|
|
homeDir: '/Users/alice',
|
|
resolvedTarget: '/Users/alice/.claude',
|
|
});
|
|
assert.strictEqual(pathPrefix, '$HOME/.claude/');
|
|
});
|
|
|
|
test('Local install (non-global): pathPrefix uses absolute path regardless of runtime', () => {
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: false,
|
|
isOpencode: false,
|
|
isWindowsHost: false,
|
|
homeDir: '/Users/alice',
|
|
resolvedTarget: '/Users/alice/projects/foo/.claude',
|
|
});
|
|
assert.strictEqual(pathPrefix, '/Users/alice/projects/foo/.claude/');
|
|
});
|
|
|
|
test('Substitution pipeline simulation: OpenCode emits no @$HOME literal', () => {
|
|
// This validates the same regex substitution pipeline used by
|
|
// copyFlattenedCommands when writing OpenCode command files. We invoke the
|
|
// real exported computePathPrefix; the regex passes mirror the install.js
|
|
// call sites (globalClaudeRegex / globalClaudeHomeRegex).
|
|
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-2831-'));
|
|
try {
|
|
const srcRoot = path.join(tmp, 'src');
|
|
const targetRoot = path.join(tmp, 'home', '.config', 'opencode');
|
|
const srcCmdDir = path.join(srcRoot, 'commands', 'gsd');
|
|
fs.mkdirSync(srcCmdDir, { recursive: true });
|
|
fs.mkdirSync(targetRoot, { recursive: true });
|
|
|
|
const srcFile = path.join(srcCmdDir, 'autonomous.md');
|
|
fs.writeFileSync(
|
|
srcFile,
|
|
'---\nname: autonomous\n---\n<execution_context>\n@~/.claude/get-shit-done/workflows/autonomous.md\n@$HOME/.claude/get-shit-done/references/ui-brand.md\n</execution_context>\n'
|
|
);
|
|
|
|
const homeDir = path.join(tmp, 'home').replace(/\\/g, '/');
|
|
const resolvedTarget = targetRoot.replace(/\\/g, '/');
|
|
const pathPrefix = computePathPrefix({
|
|
isGlobal: true,
|
|
isOpencode: true,
|
|
isWindowsHost: false,
|
|
homeDir,
|
|
resolvedTarget,
|
|
});
|
|
|
|
let content = fs.readFileSync(srcFile, 'utf8');
|
|
content = content.replace(/~\/\.claude\//g, pathPrefix);
|
|
content = content.replace(/\$HOME\/\.claude\//g, pathPrefix);
|
|
|
|
assert.ok(
|
|
!/@\$HOME\b/.test(content),
|
|
`output must not contain @$HOME literal; got:\n${content}`
|
|
);
|
|
assert.ok(
|
|
!/\$HOME\b/.test(content),
|
|
`output must not contain $HOME literal; got:\n${content}`
|
|
);
|
|
assert.ok(
|
|
content.includes(`@${resolvedTarget}/`),
|
|
`output should include absolute path with @ prefix; got:\n${content}`
|
|
);
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|