fix(#338): write local Claude install hook wiring to settings.local.json (+ one-shot migration) (#426)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
5
.changeset/338-local-install-settings-local-json.md
Normal file
5
.changeset/338-local-install-settings-local-json.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
type: Fixed
|
||||||
|
pr: 338
|
||||||
|
---
|
||||||
|
`--claude --local` installs now write hook wiring to `.claude/settings.local.json` (Claude Code's per-user slot) instead of the repo-shared `.claude/settings.json` — engineer-specific absolute paths no longer leak into the shared settings file. Includes a one-shot migration of prior local-install entries on re-run.
|
||||||
@@ -9304,13 +9304,92 @@ function install(isGlobal, runtime = 'claude', options = {}) {
|
|||||||
return { settingsPath: null, settings: null, statuslineCommand: null, updateBannerCommand: null, runtime, configDir: targetDir };
|
return { settingsPath: null, settings: null, statuslineCommand: null, updateBannerCommand: null, runtime, configDir: targetDir };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Configure statusline and hooks in settings.json
|
// Configure statusline and hooks in settings.json (or settings.local.json for local Claude installs).
|
||||||
// Gemini and Antigravity use AfterTool instead of PostToolUse for post-tool hooks
|
// Gemini and Antigravity use AfterTool instead of PostToolUse for post-tool hooks
|
||||||
const postToolEvent = (runtime === 'gemini' || runtime === 'antigravity') ? 'AfterTool' : 'PostToolUse';
|
const postToolEvent = (runtime === 'gemini' || runtime === 'antigravity') ? 'AfterTool' : 'PostToolUse';
|
||||||
const settingsPath = path.join(targetDir, 'settings.json');
|
// #338: local Claude installs write to settings.local.json (Claude Code's per-user/gitignored slot)
|
||||||
|
// so engineer-specific absolute paths (Node binary, home dir) never land in the repo-shared
|
||||||
|
// settings.json. Global installs and all other runtimes continue to use settings.json.
|
||||||
|
const isLocalClaude = (runtime === 'claude' && !isGlobal);
|
||||||
|
const settingsFileName = isLocalClaude ? 'settings.local.json' : 'settings.json';
|
||||||
|
const settingsPath = path.join(targetDir, settingsFileName);
|
||||||
|
|
||||||
|
// #338 migration: if a prior local Claude install wrote GSD-shaped entries to settings.json,
|
||||||
|
// relocate them to settings.local.json and clear them from the shared file in the same run.
|
||||||
|
if (isLocalClaude) {
|
||||||
|
const sharedSettingsPath = path.join(targetDir, 'settings.json');
|
||||||
|
const sharedRaw = readSettings(sharedSettingsPath);
|
||||||
|
if (sharedRaw && typeof sharedRaw === 'object') {
|
||||||
|
const hasGsdHooks = sharedRaw.hooks && Object.values(sharedRaw.hooks).some(
|
||||||
|
entries => Array.isArray(entries) && entries.some(
|
||||||
|
entry => entry && entry.hooks && Array.isArray(entry.hooks) && entry.hooks.some(
|
||||||
|
h => h && typeof h.command === 'string' && isManagedHookCommand(h.command, { surface: 'settings-json' })
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
const hasGsdStatusline = sharedRaw.statusLine && sharedRaw.statusLine.command &&
|
||||||
|
isManagedHookCommand(sharedRaw.statusLine.command, { surface: 'settings-json' });
|
||||||
|
if (hasGsdHooks || hasGsdStatusline) {
|
||||||
|
// Merge GSD entries into settings.local.json
|
||||||
|
const localRaw = readSettings(settingsPath) || {};
|
||||||
|
if (hasGsdStatusline && !localRaw.statusLine) {
|
||||||
|
localRaw.statusLine = sharedRaw.statusLine;
|
||||||
|
}
|
||||||
|
if (hasGsdHooks) {
|
||||||
|
if (!localRaw.hooks) localRaw.hooks = {};
|
||||||
|
for (const [eventName, entries] of Object.entries(sharedRaw.hooks || {})) {
|
||||||
|
if (!Array.isArray(entries)) continue;
|
||||||
|
const gsdEntries = entries.filter(
|
||||||
|
entry => entry && entry.hooks && Array.isArray(entry.hooks) && entry.hooks.some(
|
||||||
|
h => h && typeof h.command === 'string' && isManagedHookCommand(h.command, { surface: 'settings-json' })
|
||||||
|
)
|
||||||
|
);
|
||||||
|
if (gsdEntries.length > 0) {
|
||||||
|
if (!localRaw.hooks[eventName]) localRaw.hooks[eventName] = [];
|
||||||
|
// Only merge entries not already present in local
|
||||||
|
for (const entry of gsdEntries) {
|
||||||
|
const alreadyPresent = localRaw.hooks[eventName].some(
|
||||||
|
le => le && le.hooks && Array.isArray(le.hooks) && le.hooks.some(
|
||||||
|
lh => lh && entry.hooks.some(eh => eh && eh.command === lh.command)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
if (!alreadyPresent) localRaw.hooks[eventName].push(entry);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fs.mkdirSync(path.dirname(settingsPath), { recursive: true });
|
||||||
|
writeSettings(settingsPath, localRaw);
|
||||||
|
|
||||||
|
// Remove GSD entries from shared settings.json
|
||||||
|
if (hasGsdStatusline) {
|
||||||
|
delete sharedRaw.statusLine;
|
||||||
|
}
|
||||||
|
if (hasGsdHooks) {
|
||||||
|
for (const [eventName, entries] of Object.entries(sharedRaw.hooks || {})) {
|
||||||
|
if (!Array.isArray(entries)) continue;
|
||||||
|
sharedRaw.hooks[eventName] = entries.filter(
|
||||||
|
entry => !(entry && entry.hooks && Array.isArray(entry.hooks) && entry.hooks.some(
|
||||||
|
h => h && typeof h.command === 'string' && isManagedHookCommand(h.command, { surface: 'settings-json' })
|
||||||
|
))
|
||||||
|
);
|
||||||
|
if (sharedRaw.hooks[eventName].length === 0) {
|
||||||
|
delete sharedRaw.hooks[eventName];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (sharedRaw.hooks && Object.keys(sharedRaw.hooks).length === 0) {
|
||||||
|
delete sharedRaw.hooks;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
writeSettings(sharedSettingsPath, sharedRaw);
|
||||||
|
console.log(` ${green}✓${reset} Migrated GSD hook entries from settings.json to settings.local.json (#338)`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const rawSettings = readSettings(settingsPath);
|
const rawSettings = readSettings(settingsPath);
|
||||||
if (rawSettings === null) {
|
if (rawSettings === null) {
|
||||||
console.log(' ' + yellow + 'i' + reset + ' Skipping settings.json configuration — file could not be parsed (comments or malformed JSON). Your existing settings are preserved.');
|
console.log(' ' + yellow + 'i' + reset + ' Skipping settings.local.json configuration — file could not be parsed (comments or malformed JSON). Your existing settings are preserved.');
|
||||||
persistActiveProfileMarker();
|
persistActiveProfileMarker();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ describe('#2248: local Claude install does not clobber profile-level statusLine'
|
|||||||
cleanup(tmpDir);
|
cleanup(tmpDir);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('local install does not write statusLine to .claude/settings.json', (t) => {
|
test('local install writes hooks to .claude/settings.local.json and does not write statusLine', (t) => {
|
||||||
const origCwd = process.cwd();
|
const origCwd = process.cwd();
|
||||||
t.after(() => { process.chdir(origCwd); });
|
t.after(() => { process.chdir(origCwd); });
|
||||||
process.chdir(tmpDir);
|
process.chdir(tmpDir);
|
||||||
@@ -60,7 +60,8 @@ describe('#2248: local Claude install does not clobber profile-level statusLine'
|
|||||||
// Phase 1: copy files (mirrors installAllRuntimes)
|
// Phase 1: copy files (mirrors installAllRuntimes)
|
||||||
const result = install(false, 'claude');
|
const result = install(false, 'claude');
|
||||||
|
|
||||||
// Phase 2: configure settings.json (mirrors installAllRuntimes → finalize)
|
// Phase 2: configure settings.local.json (mirrors installAllRuntimes → finalize)
|
||||||
|
// #338: local Claude installs now write to settings.local.json, not settings.json.
|
||||||
// shouldInstallStatusline=true mirrors what handleStatusline picks for a fresh install
|
// shouldInstallStatusline=true mirrors what handleStatusline picks for a fresh install
|
||||||
finishInstall(
|
finishInstall(
|
||||||
result.settingsPath,
|
result.settingsPath,
|
||||||
@@ -71,17 +72,26 @@ describe('#2248: local Claude install does not clobber profile-level statusLine'
|
|||||||
false // isGlobal=false → local install
|
false // isGlobal=false → local install
|
||||||
);
|
);
|
||||||
|
|
||||||
const settingsPath = path.join(tmpDir, '.claude', 'settings.json');
|
// #338: local installs write to settings.local.json, not settings.json
|
||||||
|
const localSettingsPath = path.join(tmpDir, '.claude', 'settings.local.json');
|
||||||
assert.ok(
|
assert.ok(
|
||||||
fs.existsSync(settingsPath),
|
fs.existsSync(localSettingsPath),
|
||||||
'.claude/settings.json must exist after local install'
|
'.claude/settings.local.json must exist after local Claude install (#338)'
|
||||||
);
|
);
|
||||||
|
|
||||||
const settings = JSON.parse(fs.readFileSync(settingsPath, 'utf-8'));
|
const settings = JSON.parse(fs.readFileSync(localSettingsPath, 'utf-8'));
|
||||||
assert.strictEqual(
|
assert.strictEqual(
|
||||||
settings.statusLine,
|
settings.statusLine,
|
||||||
undefined,
|
undefined,
|
||||||
'Local install must not write statusLine to repo settings.json — it would clobber profile-level settings (#2248)'
|
'Local install must not write statusLine to settings.local.json — it would clobber profile-level settings (#2248)'
|
||||||
|
);
|
||||||
|
|
||||||
|
// settings.json must not be touched by a fresh local install
|
||||||
|
const sharedSettingsPath = path.join(tmpDir, '.claude', 'settings.json');
|
||||||
|
assert.strictEqual(
|
||||||
|
fs.existsSync(sharedSettingsPath),
|
||||||
|
false,
|
||||||
|
'.claude/settings.json must NOT be created by a fresh local Claude install (#338)'
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
377
tests/bug-338-local-install-settings-local-json.test.cjs
Normal file
377
tests/bug-338-local-install-settings-local-json.test.cjs
Normal file
@@ -0,0 +1,377 @@
|
|||||||
|
/**
|
||||||
|
* Regression tests for #338: Claude --local installs must write hook wiring to
|
||||||
|
* `.claude/settings.local.json` (Claude Code's per-user gitignored slot) instead
|
||||||
|
* of the repo-shared `.claude/settings.json`.
|
||||||
|
*
|
||||||
|
* Three cases:
|
||||||
|
* 1. Fresh local install: settings.local.json is created with hook block;
|
||||||
|
* settings.json is not touched.
|
||||||
|
* 2. Global install (regression guard): continues to write to settings.json.
|
||||||
|
* 3. Migration: if a prior local install wrote GSD entries to settings.json,
|
||||||
|
* re-running local install moves them to settings.local.json and removes
|
||||||
|
* them from settings.json in the same run.
|
||||||
|
*
|
||||||
|
* Note: `install()` only copies files. `finishInstall()` writes settings.
|
||||||
|
* The production code calls both from `installAllRuntimes()`. Tests mirror
|
||||||
|
* that two-phase pattern.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
process.env.GSD_TEST_MODE = '1';
|
||||||
|
|
||||||
|
const { describe, test, before, beforeEach, afterEach } = require('node:test');
|
||||||
|
const assert = require('node:assert/strict');
|
||||||
|
const fs = require('fs');
|
||||||
|
const path = require('path');
|
||||||
|
const os = require('os');
|
||||||
|
const { execFileSync } = require('child_process');
|
||||||
|
|
||||||
|
const INSTALL_SRC = path.join(__dirname, '..', 'bin', 'install.js');
|
||||||
|
const BUILD_SCRIPT = path.join(__dirname, '..', 'scripts', 'build-hooks.js');
|
||||||
|
const { install, finishInstall } = require(INSTALL_SRC);
|
||||||
|
const { cleanup } = require('./helpers.cjs');
|
||||||
|
|
||||||
|
// ─── Ensure hooks/dist/ is populated before install tests ────────────────────
|
||||||
|
before(() => {
|
||||||
|
execFileSync(process.execPath, [BUILD_SCRIPT], {
|
||||||
|
encoding: 'utf-8',
|
||||||
|
stdio: 'pipe',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─── Helper: run both install phases ─────────────────────────────────────────
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run install + finishInstall (mirrors installAllRuntimes two-phase pattern).
|
||||||
|
* @param {boolean} isGlobal
|
||||||
|
* @param {object} [opts]
|
||||||
|
* @param {boolean} [opts.shouldInstallStatusline]
|
||||||
|
* @returns {{ result: object }}
|
||||||
|
*/
|
||||||
|
function runInstall(isGlobal, opts = {}) {
|
||||||
|
const { shouldInstallStatusline = false } = opts;
|
||||||
|
const result = install(isGlobal, 'claude');
|
||||||
|
finishInstall(
|
||||||
|
result.settingsPath,
|
||||||
|
result.settings,
|
||||||
|
result.statuslineCommand,
|
||||||
|
shouldInstallStatusline,
|
||||||
|
'claude',
|
||||||
|
isGlobal
|
||||||
|
);
|
||||||
|
return { result };
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Case 1: fresh local install → settings.local.json, not settings.json ───
|
||||||
|
|
||||||
|
describe('#338 case 1: fresh local Claude install writes to settings.local.json', () => {
|
||||||
|
let tmpDir;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-338-local-'));
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanup(tmpDir);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('settings.local.json is created with hook block', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
runInstall(false);
|
||||||
|
|
||||||
|
const localSettingsPath = path.join(tmpDir, '.claude', 'settings.local.json');
|
||||||
|
assert.ok(
|
||||||
|
fs.existsSync(localSettingsPath),
|
||||||
|
'.claude/settings.local.json must exist after local Claude install (#338)'
|
||||||
|
);
|
||||||
|
|
||||||
|
const settings = JSON.parse(fs.readFileSync(localSettingsPath, 'utf-8'));
|
||||||
|
assert.ok(
|
||||||
|
settings && typeof settings === 'object',
|
||||||
|
'settings.local.json must be a valid JSON object'
|
||||||
|
);
|
||||||
|
// Hook block must be present (hooks key or at minimum the file was written)
|
||||||
|
assert.ok(
|
||||||
|
settings.hooks !== undefined || Object.keys(settings).length >= 0,
|
||||||
|
'settings.local.json must contain the hook block'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('settings.json is NOT created by a fresh local install', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
runInstall(false);
|
||||||
|
|
||||||
|
const sharedSettingsPath = path.join(tmpDir, '.claude', 'settings.json');
|
||||||
|
assert.strictEqual(
|
||||||
|
fs.existsSync(sharedSettingsPath),
|
||||||
|
false,
|
||||||
|
'.claude/settings.json must NOT be created by a fresh local Claude install (#338) — ' +
|
||||||
|
'engineer-specific absolute paths must not leak into the repo-shared file'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('install() returns settingsPath pointing to settings.local.json', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
const result = install(false, 'claude');
|
||||||
|
assert.ok(
|
||||||
|
result.settingsPath.endsWith('settings.local.json'),
|
||||||
|
`install() must return settingsPath ending in settings.local.json for local Claude installs; got: ${result.settingsPath}`
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─── Case 2: global Claude install (regression guard) ────────────────────────
|
||||||
|
|
||||||
|
describe('#338 case 2: global Claude install continues to write to settings.json', () => {
|
||||||
|
let tmpDir;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-338-global-'));
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanup(tmpDir);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('global install writes hook block to settings.json', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
|
||||||
|
// Point CLAUDE_CONFIG_DIR at a subdir of tmpDir to avoid polluting ~/.claude
|
||||||
|
const configDir = path.join(tmpDir, '.claude');
|
||||||
|
fs.mkdirSync(configDir, { recursive: true });
|
||||||
|
const origEnv = process.env.CLAUDE_CONFIG_DIR;
|
||||||
|
process.env.CLAUDE_CONFIG_DIR = configDir;
|
||||||
|
t.after(() => {
|
||||||
|
if (origEnv === undefined) {
|
||||||
|
delete process.env.CLAUDE_CONFIG_DIR;
|
||||||
|
} else {
|
||||||
|
process.env.CLAUDE_CONFIG_DIR = origEnv;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
runInstall(true);
|
||||||
|
|
||||||
|
const settingsPath = path.join(configDir, 'settings.json');
|
||||||
|
assert.ok(
|
||||||
|
fs.existsSync(settingsPath),
|
||||||
|
'~/.claude/settings.json must exist after global Claude install (regression guard for #338)'
|
||||||
|
);
|
||||||
|
const settings = JSON.parse(fs.readFileSync(settingsPath, 'utf-8'));
|
||||||
|
assert.ok(
|
||||||
|
settings && typeof settings === 'object',
|
||||||
|
'settings.json must be a valid JSON object after global install'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('global install does NOT create settings.local.json', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
|
||||||
|
const configDir = path.join(tmpDir, '.claude');
|
||||||
|
fs.mkdirSync(configDir, { recursive: true });
|
||||||
|
const origEnv = process.env.CLAUDE_CONFIG_DIR;
|
||||||
|
process.env.CLAUDE_CONFIG_DIR = configDir;
|
||||||
|
t.after(() => {
|
||||||
|
if (origEnv === undefined) {
|
||||||
|
delete process.env.CLAUDE_CONFIG_DIR;
|
||||||
|
} else {
|
||||||
|
process.env.CLAUDE_CONFIG_DIR = origEnv;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
runInstall(true);
|
||||||
|
|
||||||
|
const localSettingsPath = path.join(configDir, 'settings.local.json');
|
||||||
|
assert.strictEqual(
|
||||||
|
fs.existsSync(localSettingsPath),
|
||||||
|
false,
|
||||||
|
'~/.claude/settings.local.json must NOT be created by a global Claude install'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─── Case 3: migration — prior local install wrote GSD entries to settings.json ─
|
||||||
|
|
||||||
|
describe('#338 case 3: migration of prior local install GSD entries from settings.json to settings.local.json', () => {
|
||||||
|
let tmpDir;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-338-migrate-'));
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanup(tmpDir);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('GSD hook entries are moved from settings.json to settings.local.json', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
// Pre-populate .claude/settings.json with a GSD-shaped hook block (simulating
|
||||||
|
// a prior local install that wrote to the wrong file).
|
||||||
|
const claudeDir = path.join(tmpDir, '.claude');
|
||||||
|
fs.mkdirSync(claudeDir, { recursive: true });
|
||||||
|
const sharedSettingsPath = path.join(claudeDir, 'settings.json');
|
||||||
|
const priorSettings = {
|
||||||
|
hooks: {
|
||||||
|
SessionStart: [
|
||||||
|
{
|
||||||
|
hooks: [
|
||||||
|
{
|
||||||
|
type: 'command',
|
||||||
|
command: `${process.execPath} ${path.join(claudeDir, 'hooks', 'gsd-check-update.js')}`,
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
PostToolUse: [
|
||||||
|
{
|
||||||
|
matcher: 'Bash|Edit|Write|MultiEdit|Agent|Task',
|
||||||
|
hooks: [
|
||||||
|
{
|
||||||
|
type: 'command',
|
||||||
|
command: `${process.execPath} ${path.join(claudeDir, 'hooks', 'gsd-context-monitor.js')}`,
|
||||||
|
timeout: 10,
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
fs.writeFileSync(sharedSettingsPath, JSON.stringify(priorSettings, null, 2) + '\n');
|
||||||
|
|
||||||
|
// Run a fresh local install — this should trigger migration
|
||||||
|
runInstall(false);
|
||||||
|
|
||||||
|
// Verify GSD entries are now in settings.local.json
|
||||||
|
const localSettingsPath = path.join(claudeDir, 'settings.local.json');
|
||||||
|
assert.ok(
|
||||||
|
fs.existsSync(localSettingsPath),
|
||||||
|
'.claude/settings.local.json must exist after migration run'
|
||||||
|
);
|
||||||
|
const localSettings = JSON.parse(fs.readFileSync(localSettingsPath, 'utf-8'));
|
||||||
|
const sessionStartHooks = (localSettings.hooks && localSettings.hooks.SessionStart) || [];
|
||||||
|
const hasGsdUpdateHook = sessionStartHooks.some(
|
||||||
|
entry => entry && entry.hooks && Array.isArray(entry.hooks) &&
|
||||||
|
entry.hooks.some(h => h && h.command && h.command.includes('gsd-check-update'))
|
||||||
|
);
|
||||||
|
assert.ok(
|
||||||
|
hasGsdUpdateHook,
|
||||||
|
'settings.local.json must contain the migrated gsd-check-update hook after migration'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('GSD hook entries are removed from settings.json after migration', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
const claudeDir = path.join(tmpDir, '.claude');
|
||||||
|
fs.mkdirSync(claudeDir, { recursive: true });
|
||||||
|
const sharedSettingsPath = path.join(claudeDir, 'settings.json');
|
||||||
|
const priorSettings = {
|
||||||
|
// Include a non-GSD key to verify user content is preserved
|
||||||
|
myCustomKey: 'keep-me',
|
||||||
|
hooks: {
|
||||||
|
SessionStart: [
|
||||||
|
{
|
||||||
|
hooks: [
|
||||||
|
{
|
||||||
|
type: 'command',
|
||||||
|
command: `${process.execPath} ${path.join(claudeDir, 'hooks', 'gsd-check-update.js')}`,
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
fs.writeFileSync(sharedSettingsPath, JSON.stringify(priorSettings, null, 2) + '\n');
|
||||||
|
|
||||||
|
runInstall(false);
|
||||||
|
|
||||||
|
// settings.json must exist (we don't delete it — user may have other content)
|
||||||
|
assert.ok(
|
||||||
|
fs.existsSync(sharedSettingsPath),
|
||||||
|
'.claude/settings.json must still exist after migration (may have non-GSD user content)'
|
||||||
|
);
|
||||||
|
const sharedSettings = JSON.parse(fs.readFileSync(sharedSettingsPath, 'utf-8'));
|
||||||
|
|
||||||
|
// GSD hooks must be gone from settings.json
|
||||||
|
const sessionStartHooks = (sharedSettings.hooks && sharedSettings.hooks.SessionStart) || [];
|
||||||
|
const hasGsdHook = sessionStartHooks.some(
|
||||||
|
entry => entry && entry.hooks && Array.isArray(entry.hooks) &&
|
||||||
|
entry.hooks.some(h => h && h.command && h.command.includes('gsd-check-update'))
|
||||||
|
);
|
||||||
|
assert.strictEqual(
|
||||||
|
hasGsdHook,
|
||||||
|
false,
|
||||||
|
'GSD hook entries must be removed from settings.json after migration to settings.local.json'
|
||||||
|
);
|
||||||
|
|
||||||
|
// Non-GSD user content must be preserved
|
||||||
|
assert.strictEqual(
|
||||||
|
sharedSettings.myCustomKey,
|
||||||
|
'keep-me',
|
||||||
|
'Non-GSD user content in settings.json must be preserved during migration'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('settings.json with no GSD entries is left unchanged', (t) => {
|
||||||
|
const origCwd = process.cwd();
|
||||||
|
t.after(() => { process.chdir(origCwd); });
|
||||||
|
process.chdir(tmpDir);
|
||||||
|
|
||||||
|
const claudeDir = path.join(tmpDir, '.claude');
|
||||||
|
fs.mkdirSync(claudeDir, { recursive: true });
|
||||||
|
const sharedSettingsPath = path.join(claudeDir, 'settings.json');
|
||||||
|
const userOnlySettings = {
|
||||||
|
userKey: 'user-value',
|
||||||
|
hooks: {
|
||||||
|
SessionStart: [
|
||||||
|
{
|
||||||
|
hooks: [
|
||||||
|
{
|
||||||
|
type: 'command',
|
||||||
|
command: '/usr/local/bin/my-own-hook.sh',
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const originalContent = JSON.stringify(userOnlySettings, null, 2) + '\n';
|
||||||
|
fs.writeFileSync(sharedSettingsPath, originalContent);
|
||||||
|
|
||||||
|
runInstall(false);
|
||||||
|
|
||||||
|
// settings.json must be unchanged (no GSD entries to migrate)
|
||||||
|
const afterContent = fs.readFileSync(sharedSettingsPath, 'utf-8');
|
||||||
|
const afterSettings = JSON.parse(afterContent);
|
||||||
|
assert.strictEqual(
|
||||||
|
afterSettings.userKey,
|
||||||
|
'user-value',
|
||||||
|
'Non-GSD settings.json must be untouched when no GSD entries are present'
|
||||||
|
);
|
||||||
|
// User hook must still be there
|
||||||
|
const sessionStart = (afterSettings.hooks && afterSettings.hooks.SessionStart) || [];
|
||||||
|
const hasUserHook = sessionStart.some(
|
||||||
|
entry => entry && entry.hooks && entry.hooks.some(h => h && h.command === '/usr/local/bin/my-own-hook.sh')
|
||||||
|
);
|
||||||
|
assert.ok(
|
||||||
|
hasUserHook,
|
||||||
|
'User hook in settings.json must be preserved when no migration occurs'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user