@specship/specship 0.11.0

package/dist/installer/targets/claude.d.ts

@@ -0,0 +1,146 @@
+/**
+ * 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 { AgentTarget, Location, WriteResult } from './types';
+/**
+ * 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 declare function writeMcpEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Remove stale **pre-0.8** specship auto-sync hooks
+ * (`specship mark-dirty` / `specship sync-if-dirty`) from Claude
+ * `settings.json`. Safe to call from both `install` (self-heal on
+ * upgrade) and `uninstall`. Exported so it can be unit-tested directly.
+ */
+export declare function cleanupLegacyHooks(loc: Location): WriteResult['files'][number];
+/**
+ * Remove the current-release auto-sync hooks (`specship sync --quiet`)
+ * written by `writeHooksEntry`. Uninstall-only — install would
+ * destroy its own write if this ran there.
+ */
+export declare function cleanupCurrentHooks(loc: Location): WriteResult['files'][number];
+export declare function writePermissionsEntry(loc: Location): WriteResult['files'][number];
+/**
+ * What status line is configured at this location, from SpecShip's point of
+ * view (REQ-STATUSLINE-006): `none` (free to write), `ours` (a marked entry we
+ * wrote — safe to re-assert), or `foreign` (a status line the user owns — must
+ * never be clobbered). Drives the installer's offer-vs-snippet decision.
+ */
+export declare function statusLineState(loc: Location): 'none' | 'ours' | 'foreign';
+/** The one-line snippet a user composes into their own status-line script. */
+export declare function getStatusLineSnippet(): string;
+/**
+ * Write SpecShip's status-line entry into `settings.json`
+ * (REQ-STATUSLINE-006). Refuses to overwrite a status line the user already
+ * configured: returns `kept` when a foreign `statusLine` is present, so the
+ * caller can surface the composable snippet instead. Idempotent — re-asserting
+ * our own marked entry byte-for-byte returns `unchanged`.
+ */
+export declare function writeStatusLineEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Inverse of `writeStatusLineEntry`: remove the `statusLine` entry ONLY when
+ * it is the marked one we wrote (REQ-STATUSLINE-007). A user-authored status
+ * line (no marker) is left exactly as-is; an absent entry is a no-op.
+ */
+export declare function removeStatusLineEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Strip the marker-delimited SpecShip block from CLAUDE.md if a prior
+ * install wrote one. Specship 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 declare function removeInstructionsEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Write specship's auto-sync hooks into Claude `settings.json`. Merges
+ * idempotently into any user-defined hooks: a matcher group sharing our
+ * exact matcher string is reused; sibling matchers / events / events are
+ * untouched. Returns `unchanged` when our two hook commands are already
+ * present byte-for-byte in the right places.
+ *
+ * Gated by `install()` on `autoAllow` — same posture as the permissions
+ * list. The matching uninstall lives in `cleanupLegacyHooks` (whose
+ * matcher predicate covers BOTH the new `specship sync --quiet` form
+ * and the legacy `specship mark-dirty`/`sync-if-dirty` forms).
+ */
+export declare function writeHooksEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Write the spec-driven-development UserPromptSubmit nudge hook into
+ * `settings.json` (SDD-INSTALL-DOC, REQ-SDD-002). Same idempotent merge as
+ * the auto-sync hooks; gated by `install()` on `opts.sdd` rather than
+ * `autoAllow`, since it's part of the SDD steering feature.
+ */
+export declare function writeSddHookEntry(loc: Location): WriteResult['files'][number];
+/** Remove the SDD nudge hook written by `writeSddHookEntry`. Uninstall-only. */
+export declare function cleanupSddHooks(loc: Location): WriteResult['files'][number];
+/**
+ * Write the spec-driven-development steering rule into the project CLAUDE.md
+ * (SDD-INSTALL-DOC, REQ-SDD-001). Idempotent + marker-delimited so the user's
+ * surrounding content is untouched and a re-run reports `unchanged`. Distinct
+ * markers from the legacy #529 block — this is the ordering rule, not the MCP
+ * playbook.
+ */
+export declare function writeSddInstructionsEntry(loc: Location): WriteResult['files'][number];
+/** Inverse of `writeSddInstructionsEntry`: strip the SDD rule block. */
+export declare function removeSddInstructionsEntry(loc: Location): WriteResult['files'][number];
+/**
+ * Copy our shipped slash commands (commands/ss-*.md) into the user's
+ * commands dir (~/.claude/commands/ globally, ./.claude/commands/
+ * locally). Per-file idempotent: a destination with identical bytes is
+ * reported `unchanged`. Sibling user-written .md files in the same dir
+ * are never touched.
+ *
+ * The retrieval tier is always written; the governance tier is written only
+ * when `includeGovernance` is set (INSTALL-WEDGE-DOC, REQ-WEDGE-001/002). A
+ * default install never touches the governance commands — neither writing them
+ * nor (since this only ever writes) removing any a prior opt-in left behind, so
+ * an existing governance install is preserved on upgrade (REQ-WEDGE-002.A4).
+ */
+export declare function writeCommandsEntries(loc: Location, includeGovernance?: boolean): WriteResult['files'];
+/**
+ * Remove legacy `cg-*.md` slash commands left behind by a pre-v0.2
+ * installer. Called from `install()` so an upgrade self-heals (the user
+ * doesn't end up with both prefixes side-by-side cluttering their
+ * autocomplete) and from `uninstall()` so the legacy files don't
+ * persist after specship is removed. Sibling user-written .md files
+ * in the same dir are never touched — only the exact filenames in
+ * LEGACY_SHIPPED_COMMANDS are candidates.
+ */
+export declare function cleanupLegacyCommandsEntries(loc: Location): WriteResult['files'];
+/**
+ * Copy our shipped subagent (agents/specship-explorer.md) into the
+ * user's agents dir. Same idempotency contract as writeCommandsEntries.
+ */
+export declare function writeAgentsEntries(loc: Location): WriteResult['files'];
+/**
+ * Inverse of writeCommandsEntries: delete each cg-*.md we shipped, if
+ * present. A file the user replaced with their own content is still
+ * removed — match the existing uninstall posture for files specship
+ * owns (the user can re-add their version after).
+ */
+export declare function removeCommandsEntries(loc: Location): WriteResult['files'];
+/** Inverse of writeAgentsEntries. */
+export declare function removeAgentsEntries(loc: Location): WriteResult['files'];
+export declare const claudeTarget: AgentTarget;
+//# sourceMappingURL=claude.d.ts.map

package/dist/installer/targets/claude.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"claude.d.ts","sourceRoot":"","sources":["../../../src/installer/targets/claude.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAKH,OAAO,EACL,WAAW,EAGX,QAAQ,EACR,WAAW,EACZ,MAAM,SAAS,CAAC;AA+ZjB;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAsBzE;AAgHD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAE9E;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAE/E;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAoBjF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAI1E;AAED,8EAA8E;AAC9E,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAgBhF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAWjF;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAInF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAE7E;AAqDD,gFAAgF;AAChF,wBAAgB,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAE3E;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAIrF;AAED,wEAAwE;AACxE,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAItF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,UAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAGnG;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAOhF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAEtE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAEzE;AAED,qCAAqC;AACrC,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAEvE;AAsBD,eAAO,MAAM,YAAY,EAAE,WAAoC,CAAC"}