Fix: ignore review and questions dirs in README gitignore (#677)

Fixes #669.\n\nAI-assisted change: reviewed and merged by Codex under maintainer direction.
This commit is contained in:
Abdul Wahab
2026-08-31 18:20:58 -04:00
committed by GitHub
parent e92bf2b774
commit 2b1804deaa
3 changed files with 45 additions and 0 deletions
+2
View File
@@ -321,6 +321,8 @@ As you run commands, Impeccable writes working files under `.impeccable/`: criti
.impeccable/hook.cache.json
.impeccable/hook.pending.json
.impeccable/*.png
.impeccable/review/
.impeccable/questions/
.impeccable/live/server.json
.impeccable/live/sessions/
.impeccable/live/previews/
+1
View File
@@ -73,6 +73,7 @@ export const SUITES = {
'tests/doctor.test.mjs',
'tests/staleness.test.mjs',
'tests/skill-reference.test.mjs',
'tests/readme-gitignore.test.mjs',
'tests/target-args.test.mjs',
'tests/surface-brief.test.mjs',
'tests/template-extensions.test.mjs',
+42
View File
@@ -0,0 +1,42 @@
import { describe, it, after } from 'node:test';
import assert from 'node:assert/strict';
import { readFileSync, writeFileSync, mkdtempSync, rmSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { execFileSync, spawnSync } from 'node:child_process';
import { fileURLToPath } from 'node:url';
const ROOT = fileURLToPath(new URL('..', import.meta.url));
describe('README gitignore block', () => {
let tmp;
after(() => {
if (tmp) rmSync(tmp, { recursive: true, force: true });
});
it('ignores ephemeral review and questions dirs while keeping shared artifacts tracked', () => {
const readme = readFileSync(join(ROOT, 'README.md'), 'utf-8').replace(/\r\n?/g, '\n');
const match = readme.match(/```gitignore\n([\s\S]*?)```/);
assert.ok(match, 'README.md should contain a fenced gitignore block');
const block = match[1];
assert.match(block, /# impeccable-ignore-start/);
tmp = mkdtempSync(join(tmpdir(), 'impeccable-readme-gitignore-'));
writeFileSync(join(tmp, '.gitignore'), block);
execFileSync('git', ['init'], { cwd: tmp });
const ignored = execFileSync('git', [
'check-ignore',
'.impeccable/review/desktop.png',
'.impeccable/questions/fb63f8a6.log',
], { cwd: tmp, encoding: 'utf-8' });
assert.match(ignored, /\.impeccable\/review\/desktop\.png/);
assert.match(ignored, /\.impeccable\/questions\/fb63f8a6\.log/);
for (const rel of ['.impeccable/config.json', '.impeccable/critique/report.md']) {
const result = spawnSync('git', ['check-ignore', rel], { cwd: tmp });
assert.notEqual(result.status, 0, `${rel} should not be ignored`);
}
});
});