openspec-playwright 0.3.73 → 0.3.75

package/dist/commands/editors/types.js

@@ -0,0 +1,41 @@
+/**
+ * Core types and the `defineAdapter` factory for the editor adapter
+ * layer. Zero internal dependencies — every other editors/* module may
+ * import from this file.
+ */
+import { join } from "path";
+/** Build the command metadata for the /opsx:e2e command. */
+export function buildCommandMeta(body) {
+    return {
+        id: "e2e",
+        name: "OPSX: E2E",
+        description: "Run Playwright E2E verification for an OpenSpec change",
+        category: "OpenSpec",
+        tags: ["openspec", "playwright", "e2e", "testing"],
+        body,
+    };
+}
+const noop = () => { };
+const alwaysFalse = () => false;
+/**
+ * Build an `EditorAdapter` from a partial init object. Fills in
+ * defaults so each adapter only declares what's actually different.
+ */
+export function defineAdapter(init) {
+    return {
+        id: init.id,
+        label: init.label,
+        displayName: init.displayName,
+        detect: init.detect,
+        commandFilePath: init.commandFilePath,
+        formatCommand: init.formatCommand,
+        supportsMcp: init.supportsMcp ?? true,
+        projectRulesPath: init.projectRulesPath ?? ((root) => join(root, "AGENTS.md")),
+        isMcpInstalled: init.isMcpInstalled ?? alwaysFalse,
+        installMcp: init.installMcp ?? noop,
+        removeMcp: init.removeMcp ?? noop,
+        registerInstructions: init.registerInstructions,
+        extraArtifacts: init.extraArtifacts,
+    };
+}
+//# sourceMappingURL=types.js.map

package/dist/commands/editors/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/commands/editors/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAa5B,4DAA4D;AAC5D,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO;QACL,EAAE,EAAE,KAAK;QACT,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,wDAAwD;QACrE,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,CAAC;QAClD,IAAI;KACL,CAAC;AACJ,CAAC;AAkFD,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AACtB,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAuB;IACnD,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI;QACrC,gBAAgB,EACd,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9D,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,WAAW;QAClD,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI;QACnC,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI;QACjC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;QAC/C,cAAc,EAAE,IAAI,CAAC,cAAc;KACpC,CAAC;AACJ,CAAC"}

package/dist/commands/editors.d.ts

@@ -1,310 +1,33 @@
-/** Escape a value for safe inclusion in a YAML frontmatter scalar. */
-export declare function escapeYamlValue(value: string): string;
-/** Format tags as a YAML inline array. */
-export declare function formatTagsArray(tags: string[]): string;
 /**
- * OpenCode slash-command names are hyphenated (`/opsx-e2e`), Claude's are
- * colon-prefixed (`/opsx:e2e`). Rewrite all `/opsx:` references in a
- * command body for OpenCode installation.
- */
-export declare function transformToHyphenCommands(text: string): string;
-export interface CommandMeta {
-    id: string;
-    name: string;
-    description: string;
-    category: string;
-    tags: string[];
-    body: string;
-}
-/** Build the command metadata for the /opsx:e2e command. */
-export declare function buildCommandMeta(body: string): CommandMeta;
-export type EditorId = "claude" | "opencode" | "cline" | "cursor" | "pi" | "omp" | "dsh";
-export interface ExtraArtifact {
-    relativePath: string;
-    contents: string;
-}
-export interface EditorAdapter {
-    id: EditorId;
-    /** Short label used in log messages. */
-    label: string;
-    /** Human-readable name used in user-facing messages. */
-    displayName: string;
-    /**
-     * True if this editor's config dir is present in the project.
-     * Some adapters (Pi, Oh My Pi) also treat a global config dir in the
-     * user's home as a detection signal — `homeDir` lets tests inject a
-     * fake home so detection stays hermetic.
-     */
-    detect(projectRoot: string, homeDir?: string): boolean;
-    /**
-     * True when this editor has an MCP client to configure. False skips all
-     * MCP install/check/remove phases (Pi has no MCP client).
-     */
-    supportsMcp?: boolean;
-    /** Relative path of the command file inside the project. */
-    commandFilePath(id: string): string;
-    /** Format command file contents (frontmatter + body). */
-    formatCommand(meta: CommandMeta): string;
-    /** Absolute path of the project rules file. */
-    projectRulesPath(projectRoot: string): string;
-    /** True if MCP server `serverName` is already configured. */
-    isMcpInstalled(projectRoot: string, serverName: string): boolean;
-    /** Install MCP server config in this editor. */
-    installMcp(projectRoot: string, serverName: string, command: string[]): void;
-    /** Remove MCP server config from this editor. */
-    removeMcp(projectRoot: string, serverName: string): void;
-    /** Optional: register project rules file path in editor config. */
-    registerInstructions?(projectRoot: string, instructions: string[]): void;
-    /** Optional: secondary files written alongside commandFilePath (Cursor skill). */
-    extraArtifacts?(meta: CommandMeta): ExtraArtifact[];
-}
-/**
- * Input shape for `defineAdapter` — declares the contract for an editor
- * adapter with sensible defaults for the no-MCP-client case (Pi, dsh).
- * All required-by-behavior fields are still required; optional ones
- * (supportsMcp, projectRulesPath, isMcpInstalled, installMcp, removeMcp)
- * fall back to defaults.
- */
-export interface EditorAdapterInit {
-    id: EditorId;
-    label: string;
-    displayName: string;
-    detect: EditorAdapter["detect"];
-    commandFilePath: EditorAdapter["commandFilePath"];
-    formatCommand: EditorAdapter["formatCommand"];
-    /** Optional: true by default; set false for editors without an MCP client. */
-    supportsMcp?: boolean;
-    /** Optional: defaults to `<root>/AGENTS.md`. Override for Claude (CLAUDE.md). */
-    projectRulesPath?: EditorAdapter["projectRulesPath"];
-    /** Required when supportsMcp !== false. Defaults to `() => false`. */
-    isMcpInstalled?: EditorAdapter["isMcpInstalled"];
-    /** Required when supportsMcp !== false. Defaults to a no-op. */
-    installMcp?: EditorAdapter["installMcp"];
-    /** Required when supportsMcp !== false. Defaults to a no-op. */
-    removeMcp?: EditorAdapter["removeMcp"];
-    registerInstructions?: EditorAdapter["registerInstructions"];
-    extraArtifacts?: EditorAdapter["extraArtifacts"];
-}
-/**
- * Build an `EditorAdapter` from a partial init object. Fills in
- * defaults so each adapter only declares what's actually different.
- */
-export declare function defineAdapter(init: EditorAdapterInit): EditorAdapter;
-export declare function formatClaudeCommand(meta: CommandMeta): string;
-export declare function getClaudeCommandPath(id: string): string;
-export declare function hasClaudeCode(projectRoot: string): boolean;
-export declare function formatOpenCodeCommand(meta: CommandMeta): string;
-export declare function getOpenCodeCommandPath(id: string): string;
-export declare function hasOpenCode(projectRoot: string): boolean;
-/**
- * Cline stores project-level config in `.cline/` (skills/, rules/, mcp.json).
- * `.clinerules/` is the legacy rules-only directory, still auto-detected.
- *
- * Conventions follow the Cline documentation (2026):
- *   - Skills:   `.cline/skills/<name>/SKILL.md` with YAML frontmatter
- *                (name + description). Triggered via `/<name>` slash command.
- *   - MCP:      `.cline/mcp.json` with `{ "mcpServers": { ... } }` structure.
- *   - Rules:    Cline auto-detects `AGENTS.md` — no wrapper file needed.
- */
-export declare function formatClineCommand(meta: CommandMeta): string;
-export declare function getClineCommandPath(id: string): string;
-export declare function hasCline(projectRoot: string): boolean;
-export interface McpStdioServer {
-    command: string;
-    args: string[];
-}
-export type McpServersFile = Record<string, unknown> & {
-    mcpServers: Record<string, McpStdioServer>;
-};
-/**
- * Read an MCP config file with a top-level `mcpServers` map, or null if
- * missing/unparseable. Preserves unknown top-level fields.
- */
-export declare function readMcpServersFile(configPath: string): McpServersFile | null;
-/** Write an MCP config file, creating parent directories if needed. */
-export declare function writeMcpServersFile(configPath: string, config: McpServersFile): void;
-export declare function isMcpServerInFile(configPath: string, serverName: string): boolean;
-export declare function installMcpServerInFile(configPath: string, serverName: string, command: string[]): void;
-export declare function removeMcpServerFromFile(configPath: string, serverName: string): void;
-/**
- * Cursor slash commands are plain markdown (no frontmatter); the filename
- * is the command name. `$1` is the change-name argument.
- */
-export declare function formatCursorCommand(meta: CommandMeta): string;
-export declare function getCursorCommandPath(id: string): string;
-export declare function getCursorSkillPath(id: string): string;
-/**
- * Cursor Agent Skill — explicit invocation only (`disable-model-invocation`).
- * No `$1` placeholders (those belong to the slash command file).
- */
-export declare function formatCursorSkill(meta: CommandMeta): string;
-export declare function hasCursor(projectRoot: string): boolean;
-/**
- * Pi stores project resources in `.pi/` (skills/, prompts/, extensions/).
- * Prompt templates are Markdown with optional YAML frontmatter; the
- * filename becomes the slash command name (`opsx-e2e.md` → `/opsx-e2e`),
- * `description` feeds autocomplete, and `argument-hint` shows expected
- * arguments. `$1` / `$ARGUMENTS` placeholders expand at prompt time.
- *
- * Conventions follow the Pi docs (packages/coding-agent/docs):
- *   - Prompts:   `.pi/prompts/*.md`, invoked via `/name`.
- *   - Skills:    `.pi/skills/` (root `.md` files or `SKILL.md` dirs),
- *                invoked via `/skill:name`.
- *   - Rules:     Pi loads `AGENTS.md` (or `CLAUDE.md`) walking up from cwd
- *                natively — no wrapper file needed.
- *   - MCP:       Pi has NO MCP client (built-in tools only). The adapter
- *                still implements the interface with no-ops and declares
- *                `supportsMcp: false` so shared MCP phases skip it.
- */
-export declare function formatPiCommand(meta: CommandMeta): string;
-export declare function getPiCommandPath(id: string): string;
-/**
- * True when Pi is in use: a project `.pi/` dir, or a global Pi config dir
- * (`~/.pi/agent/`, created by Pi on first run). The home signal lets
- * `openspec-pw init` detect Pi in a fresh project that has no `.pi/` yet.
- */
-export declare function hasPi(projectRoot: string, homeDir?: string): boolean;
-/**
- * Oh My Pi (omp) stores project slash commands in `.omp/commands/*.md`
- * (non-recursive scan, project before user). Native commands are parsed
- * with FATAL frontmatter parsing, so the YAML must be valid; `name`
- * overrides the filename and `description` feeds autocomplete. `$1` /
- * `$ARGUMENTS` placeholders expand at prompt time.
- *
- * Conventions follow the omp docs (docs/slash-command-internals.md,
- * docs/mcp-config.md):
- *   - Commands:  `.omp/commands/*.md`, invoked via `/name`.
- *   - MCP:       `.omp/mcp.json` with `{ "mcpServers": { ... } }` — same
- *                shape as Cline/Cursor. omp also inherits `.claude/` /
- *                `.cursor/` / opencode MCP configs when present.
- *   - Rules:     omp reads `AGENTS.md` natively — no wrapper file needed.
- */
-export declare function formatOmpCommand(meta: CommandMeta): string;
-export declare function getOmpCommandPath(id: string): string;
-/**
- * True when Oh My Pi is in use: a project `.omp/` dir, or a global omp
- * config dir (`~/.omp/agent/`, created by omp on first run).
- */
-export declare function hasOmp(projectRoot: string, homeDir?: string): boolean;
-/**
- * DeepSeek Harness (dsh) stores project skills in `.dsh/skills/` — the
- * `project-dsh` local provider root, rank 100 (highest local priority).
- * Skills are directory bundles (`<name>/SKILL.md`) with YAML frontmatter
- * (name + description); the kebab-case name becomes the model-invocable
- * skill name (`opsx-e2e`).
- *
- * Conventions follow the dsh skills subsystem (docs/subsystems/skills.md):
- *   - Skills:   `.dsh/skills/<name>/SKILL.md`, invoked via the `skill` tool.
- *   - Rules:    dsh reads `AGENTS.md` / `CLAUDE.md` natively (default
- *               instructionFileCandidates) — no wrapper file needed.
- *   - MCP:      dsh configures MCP via `cordis.yml` plugin config
- *               (@deepseek-ai/dsh-mcp-client), not a simple mcpServers file —
- *               the adapter declares `supportsMcp: false` so shared MCP phases
- *               skip it (configure Playwright MCP manually in cordis.yml).
- *   - Detected via `.dsh/` or the global `~/.dsh/` (DSH_HOME).
- */
-export declare function formatDshCommand(meta: CommandMeta): string;
-export declare function getDshCommandPath(id: string): string;
-/**
- * True when DeepSeek Harness is in use: a project `.dsh/` dir, or the global
- * dsh home (`~/.dsh/`, DSH_HOME). The home signal lets `openspec-pw init`
- * detect dsh in a fresh project that has no `.dsh/` yet.
- */
-export declare function hasDsh(projectRoot: string, homeDir?: string): boolean;
-/**
- * Parse the `--tools` flag value for `openspec-pw init`.
- *
- * Returns the selected editor ids, or `null` when the flag was not provided.
- * Mirrors the upstream OpenSpec `openspec init --tools` semantics:
- *   - "all" → every registered editor
- *   - "none" → no editors
- *   - comma-separated ids, case-insensitive; "oh-my-pi" aliases "omp"
- *   - mixing "all"/"none" with specific ids, or unknown ids, throw
- *   - duplicate ids are deduplicated preserving first-occurrence order
- */
-export declare function resolveToolsArg(toolsArg: string | undefined): EditorId[] | null;
-export declare function getAdapter(id: EditorId): EditorAdapter | undefined;
-/** All registered editors, regardless of detection. */
-export declare function getAllAdapters(): EditorAdapter[];
-export declare function detectAdapters(projectRoot: string, homeDir?: string): EditorAdapter[];
-/** Slash-command hint for user-facing messages. */
-export declare function slashCommandForAdapter(adapter: EditorAdapter): string;
-/** Relative paths installCommand writes for this adapter + meta. */
-export declare function listCommandArtifactPaths(adapter: EditorAdapter, meta: CommandMeta): string[];
-/** Install the command file (and optional extraArtifacts) for one adapter. */
-export declare function installCommand(adapter: EditorAdapter, meta: CommandMeta, projectRoot: string): void;
-/**
- * Read the OPENSPEC marker block from a rules file, or `null` when the file
- * is missing / has no markers. Used by drift detection and update to decide
- * whether a rules file needs rewriting.
- */
-export declare function readOpenSpecBlock(projectRoot: string, adapter: EditorAdapter): string | null;
-/**
- * Whether a rules file's OPENSPEC block matches the expected content.
- * A missing file or absent/truncated markers counts as "does not match"
- * (the caller will rewrite it), which keeps update idempotent but safe.
- */
-export declare function blockMatchesExpected(projectRoot: string, adapter: EditorAdapter, expected: string): boolean;
-/**
- * Install employee-grade standards into the editor's rules file
- * (CLAUDE.md for Claude, AGENTS.md for OpenCode, Cline, and Cursor). Wraps content in
- * `<!-- OPENSPEC:START -->` / `<!-- OPENSPEC:END -->` markers so future
- * updates can replace the block without touching the rest of the file.
- */
-export declare function installOpenSpecBlock(projectRoot: string, standardsContent: string, adapter?: EditorAdapter): void;
-/**
- * The expected OPENSPEC block content for a thin CLAUDE.md wrapper
- * (CodeGraph-first guidance + workflow hint + `@AGENTS.md` import). Exported
- * so drift detection / update can compare against it.
- *
- * The `@AGENTS.md` line is Claude Code's documented way to reuse AGENTS.md
- * inside CLAUDE.md — AGENTS.md is NOT read by default ("Claude Code reads
- * CLAUDE.md, not AGENTS.md"). Contract per
- * https://code.claude.com/docs/en/memory.md:
- * - Position is irrelevant — the doc says "@ ... anywhere in your CLAUDE.md"
- *   (examples even inline it mid-sentence or in a list item). The one real
- *   constraint: the `@` line must NOT sit inside a code span (backticks) or
- *   a fenced code block — the resolver skips those. This wrapper keeps the
- *   import at the end of the block as a bare line.
- * - The path resolves relative to the importing CLAUDE.md; import recursion
- *   is capped at 4 hops.
- * - Block-level HTML comments (`<!-- ... -->`) are stripped before context
- *   injection, so the OPENSPEC markers vanish while the live `@AGENTS.md`
- *   line inside them is still honored.
- */
-export declare function claudeWrapperStandardsContent(): string;
-/**
- * Install a thin CLAUDE.md that imports AGENTS.md.
- *
- * Uses the same OPENSPEC:START/END markers as the full standards block so
- * `cleanProjectRules` can remove it uniformly. The CodeGraph-first block is
- * written directly into CLAUDE.md (before the @AGENTS.md import) so Claude
- * Code picks it up without depending on the import.
- *
- * Also handles migration: if CLAUDE.md has an existing OPENSPEC:START block
- * (old format that wrote standards directly to CLAUDE.md), calling
- * `installOpenSpecBlock` replaces the content with the CodeGraph block +
- * `@AGENTS.md` import.
- */
-export declare function installClaudeWrapper(projectRoot: string): void;
-/**
- * Route employee-grade standards into project rules files.
- *
- * AGENTS.md is always the single source of truth, regardless of which
- * editors are detected. If Claude is in use, a thin CLAUDE.md wrapper
- * with `@AGENTS.md` import is created so Claude loads AGENTS.md as
- * its project rules. Cline and Cursor auto-detect AGENTS.md natively — no
- * wrapper needed.
- */
-export declare function installProjectRules(projectRoot: string, standardsContent: string, detected: EditorAdapter[]): void;
-/** Remove all OpenSpec marker blocks from AGENTS.md (always) and CLAUDE.md (for claude adapter). */
-export declare function cleanProjectRules(adapter: EditorAdapter, projectRoot: string): void;
-/** Read the employee-grade standards source file (empty string if missing). */
-export declare function readEmployeeStandards(srcPath: string): string;
-export declare const claudeAdapter: EditorAdapter;
-export declare const opencodeAdapter: EditorAdapter;
-export declare const clineAdapter: EditorAdapter;
-export declare const cursorAdapter: EditorAdapter;
-export declare const piAdapter: EditorAdapter;
-export declare const ompAdapter: EditorAdapter;
-export declare const dshAdapter: EditorAdapter;
+ * ─────────────────────────────────────────────────────────────────────────
+ *  FACADE FILE — implementation lives in ./editors/*
+ * ─────────────────────────────────────────────────────────────────────────
+ * This file only re-exports the public API of the editor adapter layer so
+ * every existing `import ... from ".../editors.js"` keeps working.
+ *
+ * Why a facade instead of letting callers import "./editors/index.js"?
+ * Node ESM and TypeScript nodenext do NOT resolve directory indexes:
+ * `"./editors.js"` with only `editors/index.ts` on disk fails (TS2307).
+ * Keeping this thin file preserves zero-churn imports for all callers.
+ *
+ * Do NOT add logic here. Add implementations under ./editors/ and
+ * re-export below.
+ *
+ * Re-export order matters for adapter self-registration: importing the
+ * adapter modules loads them, and each calls `registerAdapter()` — the
+ * order below fixes ADAPTERS registration order (claude → opencode →
+ * cline → cursor → pi → omp → dsh), which `resolveToolsArg("all")`, the
+ * interactive prompt order, and tests/editors-tools.test.ts depend on.
+ */
+export { type CommandMeta, buildCommandMeta, type EditorId, type ExtraArtifact, type EditorAdapter, type EditorAdapterInit, defineAdapter, } from "./editors/types.js";
+export { escapeYamlValue, formatTagsArray, transformToHyphenCommands, type McpStdioServer, type McpServersFile, readMcpServersFile, writeMcpServersFile, isMcpServerInFile, installMcpServerInFile, removeMcpServerFromFile, } from "./editors/shared.js";
+export { registerAdapter, getAdapter, getAllAdapters, detectAdapters, slashCommandForAdapter, listCommandArtifactPaths, installCommand, } from "./editors/registry.js";
+export { formatClaudeCommand, getClaudeCommandPath, hasClaudeCode, claudeAdapter, } from "./editors/adapters/claude.js";
+export { formatOpenCodeCommand, getOpenCodeCommandPath, hasOpenCode, opencodeAdapter, readOpenCodeInstructions, } from "./editors/adapters/opencode.js";
+export { formatClineCommand, getClineCommandPath, hasCline, clineAdapter, } from "./editors/adapters/cline.js";
+export { formatCursorCommand, getCursorCommandPath, getCursorSkillPath, formatCursorSkill, hasCursor, cursorAdapter, } from "./editors/adapters/cursor.js";
+export { formatPiCommand, getPiCommandPath, hasPi, piAdapter, } from "./editors/adapters/pi.js";
+export { formatOmpCommand, getOmpCommandPath, hasOmp, ompAdapter, } from "./editors/adapters/omp.js";
+export { formatDshCommand, getDshCommandPath, hasDsh, dshAdapter, } from "./editors/adapters/dsh.js";
+export { resolveToolsArg } from "./editors/tool-selection.js";
+export { readOpenSpecBlock, blockMatchesExpected, installOpenSpecBlock, claudeWrapperStandardsContent, installClaudeWrapper, installProjectRules, cleanProjectRules, readEmployeeStandards, } from "./editors/project-rules.js";