@pugi/cli 0.1.0-beta.10 → 0.1.0-beta.101

package/dist/core/codegraph/install.js

@@ -0,0 +1,134 @@
+/**
+ * Codegraph MCP install helper — .
+ *
+ * Writes the codegraph MCP server config к `.pugi/mcp.json` so the
+ * registry loader picks it up on the next dispatch. Mirrors the
+ * Phase 1 example config at `apps/pugi-cli/docs/examples/codegraph.mcp.json`
+ * — same `codegraph serve --mcp` command + `pending` trust state. The
+ * operator still has to run `pugi mcp trust codegraph` before tools
+ * actually surface; the install path NEVER auto-trusts, by design.
+ *
+ * Idempotent: re-running on a workspace that already has a `codegraph`
+ * entry is a no-op + returns `{ status: 'already-installed' }`. Other
+ * MCP servers in the same file are preserved.
+ *
+ * The function is intentionally NOT bundled into core/mcp/ to keep
+ * the codegraph product (install copy, decision store, language gate)
+ * one cohesive module. The MCP registry is a generic surface; the
+ * codegraph adoption is a feature on top of it.
+ */
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+/**
+ * Canonical config shape we write into `.pugi/mcp.json` under the
+ * `codegraph` key. Matches `mcpServerConfigSchema` (Zod) in
+ * core/mcp/client.ts and the published example at docs/examples/
+ * codegraph.mcp.json. Drift here MUST land alongside a registry
+ * schema change OR the next dispatch crashes with a validation error.
+ */
+export const CODEGRAPH_MCP_ENTRY = Object.freeze({
+    command: 'codegraph',
+    args: Object.freeze(['serve', '--mcp']),
+    env: Object.freeze({}),
+    trust: 'pending',
+});
+/**
+ * Documentation URL surfaced after a successful install so the operator
+ * knows how to actually run codegraph index commands. Single source of
+ * truth — both the init flow and the /codegraph-status command pull
+ * from this constant.
+ */
+export const CODEGRAPH_DOCS_URL = 'https://github.com/colbymchenry/codegraph';
+/**
+ * Merge the codegraph entry into `.pugi/mcp.json`. Creates the file
+ * (with `{ schema: 1, servers: { codegraph: ... } }`) when it does not
+ * exist. Preserves every other server entry on disk.
+ *
+ * @param workspaceRoot absolute path to the project root that owns the
+ *                     `.pugi/` directory. The caller is responsible for
+ *                     ensuring `.pugi/` exists (the install helper
+ *                     creates it as a defensive fallback).
+ */
+export function installCodegraphMcpEntry(workspaceRoot) {
+    const pugiDir = resolve(workspaceRoot, '.pugi');
+    const configPath = resolve(pugiDir, 'mcp.json');
+    try {
+        if (!existsSync(pugiDir)) {
+            mkdirSync(pugiDir, { recursive: true });
+        }
+        let existing = {};
+        if (existsSync(configPath)) {
+            try {
+                const raw = readFileSync(configPath, 'utf8');
+                if (raw.trim().length > 0) {
+                    const parsed = JSON.parse(raw);
+                    if (parsed && typeof parsed === 'object') {
+                        existing = parsed;
+                    }
+                }
+            }
+            catch (error) {
+                return {
+                    status: 'failed',
+                    reason: `cannot parse existing .pugi/mcp.json: ${error.message}`,
+                };
+            }
+        }
+        const servers = (existing.servers && typeof existing.servers === 'object')
+            ? { ...existing.servers }
+            : {};
+        if (servers['codegraph']) {
+            return { status: 'already-installed', configPath };
+        }
+        servers['codegraph'] = {
+            command: CODEGRAPH_MCP_ENTRY.command,
+            args: [...CODEGRAPH_MCP_ENTRY.args],
+            env: { ...CODEGRAPH_MCP_ENTRY.env },
+            trust: CODEGRAPH_MCP_ENTRY.trust,
+        };
+        const out = {
+            schema: typeof existing.schema === 'number' ? existing.schema : 1,
+            servers,
+        };
+        writeFileSync(configPath, `${JSON.stringify(out, null, 2)}\n`, { mode: 0o600 });
+        return { status: 'installed', configPath };
+    }
+    catch (error) {
+        return { status: 'failed', reason: error.message };
+    }
+}
+/**
+ * Check whether `.pugi/mcp.json` already declares the `codegraph`
+ * server. Pure best-effort — a malformed file returns false (we err
+ * on the side of "not installed" so the operator can re-trigger the
+ * install path instead of being silently locked out).
+ *
+ * Returns the parsed `trust` state when present so callers can render
+ * the right status copy ("declared, awaiting trust" vs "active").
+ */
+export function detectCodegraphInstalled(workspaceRoot) {
+    const configPath = resolve(workspaceRoot, '.pugi/mcp.json');
+    if (!existsSync(configPath)) {
+        return { installed: false, trust: null, configPath };
+    }
+    try {
+        const raw = readFileSync(configPath, 'utf8');
+        if (raw.trim().length === 0) {
+            return { installed: false, trust: null, configPath };
+        }
+        const parsed = JSON.parse(raw);
+        const codegraph = parsed.servers?.['codegraph'];
+        if (!codegraph) {
+            return { installed: false, trust: null, configPath };
+        }
+        return {
+            installed: true,
+            trust: codegraph.trust === 'trusted' || codegraph.trust === 'denied' ? codegraph.trust : 'pending',
+            configPath,
+        };
+    }
+    catch {
+        return { installed: false, trust: null, configPath };
+    }
+}
+//# sourceMappingURL=install.js.map

package/dist/core/codegraph/offer-hook.js

@@ -0,0 +1,220 @@
+/**
+ * Codegraph offer hook — .
+ *
+ * Single integration point used by both `pugi init` (standalone CLI
+ * entry) AND the REPL's `/init` slash so the decision logic + telemetry
+ * fan-out stays single-sourced. The hook is split into two halves:
+ *
+ *  1. `evaluateOffer({ workspaceRoot, nowIso })` — pure: decides if
+ *     we should prompt, returns the detection result + suggested copy
+ *     so the UI layer can render it however it likes (Y/n prompt in
+ *     a TTY, JSON envelope in --no-tty mode, system pane line in the
+ *     REPL).
+ *  2. `applyOfferDecision({ workspaceRoot, accepted, … })` — side-
+ *     effectful: persists the operator's verdict + runs the install
+ *     if accepted + emits the right telemetry event.
+ *
+ * Telemetry events emitted (when consent allows):
+ *  - `codegraph.offer.shown` — every time we surface the prompt
+ *  - `codegraph.offer.accepted` — operator said yes
+ *  - `codegraph.offer.declined` — operator said no
+ *  - `codegraph.install.success` — mcp.json merge succeeded
+ *  - `codegraph.install.failed` — mcp.json merge failed (rare)
+ *  - `codegraph.reminder.shown` — cold-start nudge surfaced
+ *  - `codegraph.stale-index.shown` — index > STALE_INDEX_DAYS
+ *
+ * All telemetry is best-effort fire-and-forget; emit() never throws.
+ *
+ * The hook NEVER prompts directly — it has no TTY contract. The
+ * caller MUST resolve the operator's verdict OR call `applyOfferDecision`
+ * with `accepted: false` to record a decline.
+ */
+import { detectRepo, buildOfferCopy } from './detect-repo.js';
+import { shouldOfferOnInit, recordDecision, readDecision, shouldNudgeStaleIndex, indexAgeDays, } from './decision-store.js';
+import { installCodegraphMcpEntry, detectCodegraphInstalled, CODEGRAPH_DOCS_URL, } from './install.js';
+import { emit } from '../telemetry/emitter.js';
+/**
+ * Pure evaluation. Reads detection + decision store. NEVER writes.
+ * Reads NEVER throw — corrupt JSON returns "first-run". Tests rely on
+ * this so they can drive `evaluateOffer` repeatedly without setup.
+ */
+export function evaluateOffer(input) {
+    const detection = detectRepo(input.workspaceRoot);
+    if (!detection.isRepo) {
+        return { shouldPrompt: false, reason: detection.reason, detection };
+    }
+    if (!detection.offerCodegraph) {
+        return { shouldPrompt: false, reason: 'size-or-language-gate', detection };
+    }
+    // If codegraph is already declared в mcp.json, skip — the operator
+    // already adopted it (maybe via Phase 1 manual install). Cold-start
+    // hook covers the stale-index nudge separately.
+    const installed = detectCodegraphInstalled(input.workspaceRoot);
+    if (installed.installed) {
+        return { shouldPrompt: false, reason: 'already-installed', detection };
+    }
+    if (!input.ignorePriorDecision) {
+        const cadence = shouldOfferOnInit(input.workspaceRoot, input.nowIso);
+        if (!cadence.shouldOffer) {
+            return { shouldPrompt: false, reason: cadence.reason, detection };
+        }
+    }
+    return {
+        shouldPrompt: true,
+        detection: detection,
+        promptCopy: buildOfferCopy(detection),
+        docsUrl: CODEGRAPH_DOCS_URL,
+        reason: 'first-run',
+    };
+}
+export function applyOfferDecision(input) {
+    const decision = recordDecision(input.workspaceRoot, {
+        accepted: input.accepted,
+        ...(input.nowIso ? { nowIso: input.nowIso } : {}),
+    });
+    emitOfferTelemetry(input.accepted ? 'codegraph.offer.accepted' : 'codegraph.offer.declined', {
+        sizeCategory: input.detection.sizeCategory,
+        primaryLanguage: input.detection.languages[0] ?? 'unknown',
+        primarySymbolCount: input.detection.primarySymbolCount,
+    });
+    if (!input.accepted) {
+        return { kind: 'declined', decision };
+    }
+    const install = installCodegraphMcpEntry(input.workspaceRoot);
+    if (install.status === 'failed') {
+        emitOfferTelemetry('codegraph.install.failed', {
+            reason: install.reason.slice(0, 64),
+        });
+        return { kind: 'accepted-install-failed', decision, install };
+    }
+    emitOfferTelemetry('codegraph.install.success', {
+        sizeCategory: input.detection.sizeCategory,
+        primaryLanguage: input.detection.languages[0] ?? 'unknown',
+        alreadyInstalled: install.status === 'already-installed',
+    });
+    return {
+        kind: 'accepted-installed',
+        decision,
+        install,
+        docsUrl: CODEGRAPH_DOCS_URL,
+        trustCommand: 'pugi mcp trust codegraph',
+    };
+}
+/**
+ * Surface the offer telemetry "shown" event. Called by the init flow
+ * once it has decided to actually render the prompt (so a `--no-tty`
+ * invocation that skipped the prompt does not count as a shown event).
+ */
+export function emitOfferShown(detection) {
+    emitOfferTelemetry('codegraph.offer.shown', {
+        sizeCategory: detection.sizeCategory,
+        primaryLanguage: detection.languages[0] ?? 'unknown',
+        primarySymbolCount: detection.primarySymbolCount,
+    });
+}
+/**
+ * Compute the cold-start nudge. Pure read — never writes. The session
+ * module decides whether to render the message AND whether to call
+ * `markReindexChecked(...)` after the operator dismisses it (so the
+ * once-per-day throttle on `shouldNudgeStaleIndex` works).
+ */
+export function evaluateColdStart(input) {
+    const detection = detectRepo(input.workspaceRoot);
+    if (!detection.isRepo) {
+        return { kind: 'silent', reason: detection.reason };
+    }
+    const decision = readDecision(input.workspaceRoot);
+    // Stale-index path takes priority — an accepted operator should be
+    // nudged about freshness before a never-asked operator is nudged
+    // about installation.
+    if (decision && decision.accepted) {
+        if (shouldNudgeStaleIndex(decision, input.nowIso)) {
+            const age = indexAgeDays(decision, input.nowIso) ?? 0;
+            emitOfferTelemetry('codegraph.stale-index.shown', { ageDays: age });
+            return {
+                kind: 'stale-index',
+                ageDays: age,
+                message: `Codegraph index is ${age} day${age === 1 ? '' : 's'} old. Run /codegraph-status to refresh.`,
+            };
+        }
+        return { kind: 'silent', reason: 'fresh-index' };
+    }
+    if (!detection.offerCodegraph) {
+        return { kind: 'silent', reason: 'size-or-language-gate' };
+    }
+    const cadence = shouldOfferOnInit(input.workspaceRoot, input.nowIso);
+    if (!cadence.shouldOffer) {
+        return { kind: 'silent', reason: cadence.reason };
+    }
+    if (cadence.reason !== 'reminder-due') {
+        // Cold-start path is strictly the "reminder" cadence — first-run
+        // offers land through `pugi init`, not the cold-start hook. The
+        // separation prevents double-prompting in the common "run pugi
+        // init + then pugi code" flow.
+        return { kind: 'silent', reason: 'first-run-handled-by-init' };
+    }
+    emitOfferTelemetry('codegraph.reminder.shown', {
+        sizeCategory: detection.sizeCategory,
+        primaryLanguage: detection.languages[0] ?? 'unknown',
+    });
+    return {
+        kind: 'remind',
+        detection,
+        message: `${buildOfferCopy(detection)} (last declined ${humanAge(decision?.offeredAt, input.nowIso)} ago)`,
+    };
+}
+/**
+ * Fire one telemetry event. Telemetry meta is keyed by the canonical
+ * allowlist (`flagsHash`, `parentCommand`, etc.); we re-purpose
+ * `parentCommand` to carry the offer reason since the codegraph
+ * event-kind taxonomy is not (yet) in the server-side allowlist.
+ *
+ * Best-effort: emit() drops events when consent is off and never
+ * throws.
+ */
+function emitOfferTelemetry(command, meta) {
+    const stringMeta = {};
+    for (const [k, v] of Object.entries(meta)) {
+        // Promote everything через the canonical `parentCommand` slot OR
+        // safe-numeric counters (retryCount). Unknown keys would be
+        // dropped by the emitter's META_ALLOWLIST guard, but routing
+        // through `parentCommand: "<key>=<value>"` keeps the signal
+        // visible на the dashboard.
+        if (typeof v === 'number') {
+            stringMeta.retryCount = v;
+        }
+        else if (typeof v === 'boolean') {
+            stringMeta.cacheHit = v;
+        }
+        else {
+            stringMeta.parentCommand = `${k}=${String(v).slice(0, 32)}`;
+        }
+    }
+    emit({
+        command,
+        kind: 'tool-call',
+        success: true,
+        meta: stringMeta,
+    });
+}
+/**
+ * Format the elapsed time since `priorIso` in human-readable units
+ * (days / weeks). Pure — exposed for spec parity. Falls back to
+ * "earlier" when prior is missing OR unparseable.
+ */
+function humanAge(priorIso, nowIso) {
+    if (!priorIso)
+        return 'earlier';
+    const now = nowIso ? Date.parse(nowIso) : Date.now();
+    const prior = Date.parse(priorIso);
+    if (!Number.isFinite(prior))
+        return 'earlier';
+    const days = Math.max(0, Math.floor((now - prior) / (24 * 60 * 60 * 1000)));
+    if (days < 1)
+        return 'today';
+    if (days < 7)
+        return `${days} day${days === 1 ? '' : 's'}`;
+    const weeks = Math.floor(days / 7);
+    return `${weeks} week${weeks === 1 ? '' : 's'}`;
+}
+//# sourceMappingURL=offer-hook.js.map