| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454 |
- /**
- * Claude Code target. Writes:
- *
- * - MCP server entry to `~/.claude.json` (global = user scope, loads
- * in every project) or `./.mcp.json` (local = project scope, the
- * file Claude Code actually reads for a single project). See the
- * scope table at https://code.claude.com/docs/en/mcp.
- * - Permissions to `~/.claude/settings.json` (global) or
- * `./.claude/settings.json` (local), gated on `autoAllow`.
- * - Instructions to `~/.claude/CLAUDE.md` (global) or
- * `./.claude/CLAUDE.md` (local).
- *
- * Earlier versions wrote the local MCP entry to `./.claude.json` — a
- * file Claude Code never reads — so the server silently never loaded
- * until the user manually renamed it to `.mcp.json` (issue #207). We
- * now write `./.mcp.json` and migrate any stale `./.claude.json` entry
- * out of the way on install and uninstall.
- */
- import * as fs from 'fs';
- import * as path from 'path';
- import * as os from 'os';
- import {
- AgentTarget,
- DetectionResult,
- InstallOptions,
- Location,
- WriteResult,
- } from './types';
- import {
- getCodeGraphPermissions,
- getMcpServerConfig,
- jsonDeepEqual,
- readJsonFile,
- removeMarkedSection,
- writeJsonFile,
- upsertInstructionsEntry,
- } from './shared';
- import {
- CODEGRAPH_SECTION_END,
- CODEGRAPH_SECTION_START,
- } from '../instructions-template';
- function configDir(loc: Location): string {
- return loc === 'global'
- ? path.join(os.homedir(), '.claude')
- : path.join(process.cwd(), '.claude');
- }
- function mcpJsonPath(loc: Location): string {
- // global → ~/.claude.json (user scope: visible in every project).
- // local → ./.mcp.json (project scope: the ONLY project-level MCP
- // file Claude Code reads — NOT ./.claude.json, which it ignores).
- return loc === 'global'
- ? path.join(os.homedir(), '.claude.json')
- : path.join(process.cwd(), '.mcp.json');
- }
- /**
- * Where pre-#207 installers wrote the local MCP entry. Claude Code
- * never reads a project-level `./.claude.json`, so we migrate the
- * codegraph entry out of it on install and strip it on uninstall.
- * Only the project-local path is legacy — global `~/.claude.json` is
- * the correct user-scope location and is left untouched.
- */
- function legacyLocalMcpPath(): string {
- return path.join(process.cwd(), '.claude.json');
- }
- function settingsJsonPath(loc: Location): string {
- return path.join(configDir(loc), 'settings.json');
- }
- function instructionsPath(loc: Location): string {
- return path.join(configDir(loc), 'CLAUDE.md');
- }
- class ClaudeCodeTarget implements AgentTarget {
- readonly id = 'claude' as const;
- readonly displayName = 'Claude Code';
- readonly docsUrl = 'https://docs.claude.com/en/docs/claude-code';
- supportsLocation(_loc: Location): boolean {
- return true;
- }
- detect(loc: Location): DetectionResult {
- const mcpPath = mcpJsonPath(loc);
- const config = readJsonFile(mcpPath);
- const alreadyConfigured = !!config.mcpServers?.codegraph;
- // For "installed" we infer from the existence of either the dir
- // (global) or the project marker file (local). Cheap and avoids
- // shelling out to `claude --version`.
- const installed = loc === 'global'
- ? fs.existsSync(configDir(loc)) || fs.existsSync(mcpPath)
- : fs.existsSync(mcpPath) || fs.existsSync(configDir(loc));
- return { installed, alreadyConfigured, configPath: mcpPath };
- }
- install(loc: Location, opts: InstallOptions): WriteResult {
- const files: WriteResult['files'] = [];
- // 1. MCP server entry
- files.push(writeMcpEntry(loc));
- // 1b. Migrate away any stale ./.claude.json left by a pre-#207
- // local install, so the project isn't left with two competing
- // (one dead) MCP configs.
- if (loc === 'local') {
- const migrated = cleanupLegacyLocalMcp();
- if (migrated) files.push(migrated);
- }
- // 2. Permissions (only when autoAllow)
- if (opts.autoAllow) {
- files.push(writePermissionsEntry(loc));
- }
- // 2b. Strip stale auto-sync hooks left by a pre-0.8 install. Those
- // versions wrote `codegraph mark-dirty` / `sync-if-dirty` hooks to
- // settings.json; both subcommands are gone from the CLI, so the
- // Stop hook now fails every turn with "unknown command
- // 'sync-if-dirty'". Cleaning up on install makes an upgrade
- // self-healing. Only surfaced when something was actually removed.
- const hookCleanup = cleanupLegacyHooks(loc);
- if (hookCleanup.action === 'removed') files.push(hookCleanup);
- // 2c. Front-load prompt hook (Claude UserPromptSubmit). Opt-in via the
- // installer prompt (default-yes): `promptHook === true` writes it;
- // `=== false` strips any a prior install wrote so opting out round-trips
- // (and an upgrade re-run honors the new choice); `undefined` leaves it
- // untouched for callers that don't manage it.
- if (opts.promptHook === true) {
- files.push(writePromptHookEntry(loc));
- } else if (opts.promptHook === false) {
- const removed = removePromptHookEntry(loc);
- if (removed.action === 'removed') files.push(removed);
- }
- // 3. CLAUDE.md instructions — the short marker-fenced CodeGraph
- // block (#704). The MCP initialize instructions reach only the main
- // agent; CLAUDE.md is what Task-tool subagents (and non-MCP
- // harnesses) actually see, so the block carries the codegraph
- // pointers there. Upsert self-heals a stale pre-#529 long block.
- files.push(upsertInstructionsEntry(instructionsPath(loc)));
- return { files };
- }
- uninstall(loc: Location): WriteResult {
- const files: WriteResult['files'] = [];
- // 1. MCP server entry
- const mcpPath = mcpJsonPath(loc);
- const config = readJsonFile(mcpPath);
- if (config.mcpServers?.codegraph) {
- delete config.mcpServers.codegraph;
- if (Object.keys(config.mcpServers).length === 0) {
- delete config.mcpServers;
- }
- writeJsonFile(mcpPath, config);
- files.push({ path: mcpPath, action: 'removed' });
- } else {
- files.push({ path: mcpPath, action: 'not-found' });
- }
- // 1b. Also strip the codegraph entry from a legacy ./.claude.json
- // so uninstall fully reverses a pre-#207 local install.
- if (loc === 'local') {
- const migrated = cleanupLegacyLocalMcp();
- if (migrated) files.push(migrated);
- }
- // 2. Permissions
- const settingsPath = settingsJsonPath(loc);
- const settings = readJsonFile(settingsPath);
- if (Array.isArray(settings.permissions?.allow)) {
- const before = settings.permissions.allow.length;
- settings.permissions.allow = settings.permissions.allow.filter(
- (p: string) => !p.startsWith('mcp__codegraph__'),
- );
- if (settings.permissions.allow.length !== before) {
- if (settings.permissions.allow.length === 0) {
- delete settings.permissions.allow;
- }
- if (Object.keys(settings.permissions).length === 0) {
- delete settings.permissions;
- }
- writeJsonFile(settingsPath, settings);
- files.push({ path: settingsPath, action: 'removed' });
- } else {
- files.push({ path: settingsPath, action: 'not-found' });
- }
- } else {
- files.push({ path: settingsPath, action: 'not-found' });
- }
- // 2b. Strip any stale auto-sync hooks a pre-0.8 install left in
- // settings.json. The hook-cleanup step was lost when the installer
- // moved to the per-target architecture; restoring it here means
- // uninstall — and the npm `preuninstall` hook that drives it — fully
- // reverses a legacy install.
- const hookCleanup = cleanupLegacyHooks(loc);
- if (hookCleanup.action === 'removed') files.push(hookCleanup);
- // 2c. Remove the front-load prompt hook this installer may have written.
- const promptHookCleanup = removePromptHookEntry(loc);
- if (promptHookCleanup.action === 'removed') files.push(promptHookCleanup);
- // 3. Instructions — strip the legacy CodeGraph block if present.
- files.push(removeInstructionsEntry(loc));
- return { files };
- }
- printConfig(loc: Location): string {
- const target = mcpJsonPath(loc);
- const snippet = JSON.stringify({ mcpServers: { codegraph: getMcpServerConfig() } }, null, 2);
- return `# Add to ${target}\n\n${snippet}\n`;
- }
- describePaths(loc: Location): string[] {
- return [mcpJsonPath(loc), settingsJsonPath(loc), instructionsPath(loc)];
- }
- }
- /**
- * Per-file write helpers, exported so the legacy `config-writer.ts`
- * shim can call only the named operation (writeMcpConfig writes ONLY
- * the MCP entry, etc.) instead of `claudeTarget.install()` which
- * writes all three files. Without this split the shims silently
- * cause side effects callers don't expect.
- */
- export function writeMcpEntry(loc: Location): WriteResult['files'][number] {
- const file = mcpJsonPath(loc);
- const existing = readJsonFile(file);
- const before = existing.mcpServers?.codegraph;
- const after = getMcpServerConfig();
- if (jsonDeepEqual(before, after)) {
- // Already exactly what we'd write — preserve byte-identical file.
- return { path: file, action: 'unchanged' };
- }
- // 'created' here means: the file itself did not exist before this
- // write. A pre-existing MCP JSON file (`~/.claude.json` globally,
- // `./.mcp.json` locally) containing other MCP servers (no
- // `codegraph` key) is 'updated', not 'created' — we're adding an
- // entry to a file that was already there. Codex uses a different
- // idiom (empty-content => 'created') because its config.toml is
- // ours alone to manage.
- const action: 'created' | 'updated' = before ? 'updated' : (fs.existsSync(file) ? 'updated' : 'created');
- if (!existing.mcpServers) existing.mcpServers = {};
- existing.mcpServers.codegraph = after;
- writeJsonFile(file, existing);
- return { path: file, action };
- }
- /**
- * Strip the codegraph entry from a legacy project-local
- * `./.claude.json` (written by pre-#207 installers, which Claude Code
- * never read). Surgical: only our `codegraph` key is removed; sibling
- * MCP servers and any unrelated keys are preserved, and the file is
- * deleted only when removal leaves it completely empty. Returns the
- * file action for reporting, or `null` when there's nothing to migrate.
- */
- function cleanupLegacyLocalMcp(): WriteResult['files'][number] | null {
- const file = legacyLocalMcpPath();
- if (!fs.existsSync(file)) return null;
- const config = readJsonFile(file);
- if (!config.mcpServers?.codegraph) return null;
- delete config.mcpServers.codegraph;
- if (Object.keys(config.mcpServers).length === 0) delete config.mcpServers;
- if (Object.keys(config).length === 0) {
- try { fs.unlinkSync(file); } catch { /* ignore */ }
- } else {
- writeJsonFile(file, config);
- }
- return { path: file, action: 'removed' };
- }
- /**
- * True when a Claude Code hook `command` is one of the auto-sync hooks
- * a pre-0.8 install wrote. Those installers added
- * `PostToolUse(Edit|Write) → codegraph mark-dirty` and
- * `Stop → codegraph sync-if-dirty` (local builds used the
- * `npx @colbymchenry/codegraph …` form, which still contains the
- * `codegraph <subcommand>` substring). Both subcommands were later
- * removed from the CLI, so the Stop hook fails every turn with
- * "unknown command 'sync-if-dirty'". Matching on the codegraph-scoped
- * subcommand keeps unrelated user hooks (e.g. GitKraken's
- * `gk ai hook run`) untouched.
- */
- function isLegacyCodegraphHookCommand(command: unknown): boolean {
- if (typeof command !== 'string') return false;
- return (
- command.includes('codegraph mark-dirty') ||
- command.includes('codegraph sync-if-dirty')
- );
- }
- /**
- * The front-load prompt-hook command the installer writes into Claude's
- * `UserPromptSubmit` (see writePromptHookEntry). Matched by substring so an
- * `npx @colbymchenry/codegraph prompt-hook` form is recognized too.
- */
- const PROMPT_HOOK_COMMAND = 'codegraph prompt-hook';
- function isPromptHookCommand(command: unknown): boolean {
- return typeof command === 'string' && command.includes(PROMPT_HOOK_COMMAND);
- }
- /**
- * Remove stale codegraph auto-sync hooks from Claude `settings.json`.
- *
- * Surgical at the individual-command level: only entries matching
- * `isLegacyCodegraphHookCommand` are dropped, so a sibling hook sharing
- * a matcher group (or the Stop event) with ours survives. We prune a
- * matcher group only once its `hooks` array is empty, an event only
- * once it has no groups left, and `hooks` itself only once every event
- * is gone — and none of that runs unless we actually removed a
- * codegraph command, so a settings.json with no legacy hooks is left
- * byte-for-byte untouched and reported `unchanged`.
- *
- * Exported so it can be unit-tested directly and reused by both
- * `install` (an upgrade self-heals) and `uninstall`.
- */
- function removeHookCommandsMatching(
- loc: Location,
- match: (command: unknown) => boolean,
- ): WriteResult['files'][number] {
- const file = settingsJsonPath(loc);
- if (!fs.existsSync(file)) return { path: file, action: 'not-found' };
- const settings = readJsonFile(file);
- const hooks = settings.hooks;
- if (!hooks || typeof hooks !== 'object' || Array.isArray(hooks)) {
- return { path: file, action: 'unchanged' };
- }
- // Pass 1: drop matching command(s) from inside every matcher group.
- let removedAny = false;
- for (const event of Object.keys(hooks)) {
- const groups = hooks[event];
- if (!Array.isArray(groups)) continue;
- for (const group of groups) {
- if (!group || !Array.isArray(group.hooks)) continue;
- const before = group.hooks.length;
- group.hooks = group.hooks.filter((h: any) => !match(h?.command));
- if (group.hooks.length !== before) removedAny = true;
- }
- }
- if (!removedAny) return { path: file, action: 'unchanged' };
- // Pass 2: prune empty matcher groups, then events with no groups left,
- // then an empty top-level `hooks`. Guarded by `removedAny` so we never
- // restructure a settings.json that had no matching hooks. Sibling hooks
- // (a different command in the group, or a different event) survive.
- for (const event of Object.keys(hooks)) {
- const groups = hooks[event];
- if (!Array.isArray(groups)) continue;
- hooks[event] = groups.filter(
- (g: any) => !(g && Array.isArray(g.hooks) && g.hooks.length === 0),
- );
- if (hooks[event].length === 0) delete hooks[event];
- }
- if (Object.keys(hooks).length === 0) delete settings.hooks;
- writeJsonFile(file, settings);
- return { path: file, action: 'removed' };
- }
- /**
- * Remove stale codegraph auto-sync hooks (`mark-dirty` / `sync-if-dirty`) that a
- * pre-0.8 install wrote. Exported for direct unit-testing; reused by both
- * `install` (an upgrade self-heals) and `uninstall`.
- */
- export function cleanupLegacyHooks(loc: Location): WriteResult['files'][number] {
- return removeHookCommandsMatching(loc, isLegacyCodegraphHookCommand);
- }
- /**
- * Remove the front-load `UserPromptSubmit` hook this installer writes (see
- * writePromptHookEntry). Used by `uninstall`, and by `install` when the user
- * opts out, so the choice round-trips.
- */
- export function removePromptHookEntry(loc: Location): WriteResult['files'][number] {
- return removeHookCommandsMatching(loc, isPromptHookCommand);
- }
- export function writePermissionsEntry(loc: Location): WriteResult['files'][number] {
- const file = settingsJsonPath(loc);
- const settings = readJsonFile(file);
- const created = !fs.existsSync(file);
- if (!settings.permissions) settings.permissions = {};
- if (!Array.isArray(settings.permissions.allow)) settings.permissions.allow = [];
- const want = getCodeGraphPermissions();
- const before = [...settings.permissions.allow];
- for (const perm of want) {
- if (!settings.permissions.allow.includes(perm)) {
- settings.permissions.allow.push(perm);
- }
- }
- if (jsonDeepEqual(before, settings.permissions.allow) && !created) {
- return { path: file, action: 'unchanged' };
- }
- writeJsonFile(file, settings);
- return { path: file, action: created ? 'created' : 'updated' };
- }
- /**
- * Write the front-load `UserPromptSubmit` hook into Claude `settings.json` —
- * a `command` hook that runs `codegraph prompt-hook`, which injects
- * codegraph_explore context for structural prompts so the agent reliably uses
- * the graph. Idempotent: if our command is already wired under UserPromptSubmit
- * the file is left byte-for-byte untouched and reported `unchanged`. Sibling
- * hooks (the user's own, or other events) are preserved. Opt-in — the installer
- * only calls this when the user accepts the prompt (default-yes).
- */
- export function writePromptHookEntry(loc: Location): WriteResult['files'][number] {
- const file = settingsJsonPath(loc);
- const created = !fs.existsSync(file);
- const settings = readJsonFile(file);
- if (!settings.hooks || typeof settings.hooks !== 'object' || Array.isArray(settings.hooks)) {
- settings.hooks = {};
- }
- if (!Array.isArray(settings.hooks.UserPromptSubmit)) settings.hooks.UserPromptSubmit = [];
- const already = settings.hooks.UserPromptSubmit.some(
- (g: any) => g && Array.isArray(g.hooks) && g.hooks.some((h: any) => isPromptHookCommand(h?.command)),
- );
- if (already) return { path: file, action: 'unchanged' };
- settings.hooks.UserPromptSubmit.push({
- hooks: [{ type: 'command', command: PROMPT_HOOK_COMMAND }],
- });
- writeJsonFile(file, settings);
- return { path: file, action: created ? 'created' : 'updated' };
- }
- /**
- * Strip the marker-delimited CodeGraph block from CLAUDE.md if a prior
- * install wrote one. Codegraph no longer maintains an instructions file
- * (issue #529) — the MCP server's `initialize` instructions are the
- * single source of truth — so both install (self-heal on upgrade) and
- * uninstall call this. `removeMarkedSection` returns `not-found`/`kept`
- * when there's nothing to strip; the install caller drops those from
- * the report so a fresh install stays quiet.
- */
- export function removeInstructionsEntry(loc: Location): WriteResult['files'][number] {
- const file = instructionsPath(loc);
- const action = removeMarkedSection(file, CODEGRAPH_SECTION_START, CODEGRAPH_SECTION_END);
- return { path: file, action };
- }
- export const claudeTarget: AgentTarget = new ClaudeCodeTarget();
|