@hivehub/rulebook 5.5.1 → 5.7.0

package/dist/core/ide/multi-tool-generator.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Multi-Tool Config Generator
+ *
+ * Generates IDE/AI-tool configuration files for detected tools:
+ * - GEMINI.md for Gemini CLI
+ * - .continue/rules/RULEBOOK.md for Continue.dev
+ * - .windsurfrules for Windsurf IDE
+ * - .github/copilot-instructions.md for GitHub Copilot
+ *
+ * Each generator is idempotent: if the file already contains the
+ * RULEBOOK marker it gets updated; if it exists without the marker
+ * (user-owned file) it is skipped.
+ */
+import type { DetectionResult } from '../../types.js';
+/** Result of multi-tool config generation. Each field is the path written, or undefined if skipped. */
+export interface MultiToolGeneratorResult {
+    geminiMd?: string;
+    continueRules?: string;
+    windsurfRules?: string;
+    copilotInstructions?: string;
+}
+/**
+ * Generate GEMINI.md in the project root for Gemini CLI.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export declare function generateGeminiMd(projectRoot: string): Promise<string | null>;
+/**
+ * Generate .continue/rules/RULEBOOK.md for the Continue.dev IDE extension.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export declare function generateContinueRules(projectRoot: string): Promise<string | null>;
+/**
+ * Generate .windsurfrules in the project root for Windsurf IDE.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export declare function generateWindsurfRules(projectRoot: string): Promise<string | null>;
+/**
+ * Generate .github/copilot-instructions.md for GitHub Copilot.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export declare function generateCopilotInstructions(projectRoot: string): Promise<string | null>;
+/**
+ * Generate configuration files for all detected AI tools.
+ * Only generates files for tools that are actually detected in the project.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @param detection - The project detection result containing tool detection flags.
+ * @returns An object with paths of all generated files (undefined for skipped tools).
+ */
+export declare function generateMultiToolConfigs(projectRoot: string, detection: DetectionResult): Promise<MultiToolGeneratorResult>;
+//# sourceMappingURL=multi-tool-generator.d.ts.map

package/dist/core/ide/multi-tool-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-tool-generator.d.ts","sourceRoot":"","sources":["../../../src/core/ide/multi-tool-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAOH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAQtD,uGAAuG;AACvG,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAiDD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQlF;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQvF;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQvF;AAED;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQ7F;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,eAAe,GACzB,OAAO,CAAC,wBAAwB,CAAC,CAgCnC"}

package/dist/core/ide/multi-tool-generator.js

@@ -0,0 +1,157 @@
+/**
+ * Multi-Tool Config Generator
+ *
+ * Generates IDE/AI-tool configuration files for detected tools:
+ * - GEMINI.md for Gemini CLI
+ * - .continue/rules/RULEBOOK.md for Continue.dev
+ * - .windsurfrules for Windsurf IDE
+ * - .github/copilot-instructions.md for GitHub Copilot
+ *
+ * Each generator is idempotent: if the file already contains the
+ * RULEBOOK marker it gets updated; if it exists without the marker
+ * (user-owned file) it is skipped.
+ */
+import path from 'path';
+import { existsSync } from 'fs';
+import { readFile, writeFile, mkdir } from 'fs/promises';
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+/** Marker used to identify rulebook-managed content in generated files. */
+const RULEBOOK_MARKER = '<!-- RULEBOOK:START -->';
+/**
+ * Resolve the templates/ides/ directory relative to the compiled dist/ output.
+ * Uses the same __dirname strategy as cursor-mdc-generator.ts.
+ */
+function getTemplatesDir() {
+    return path.join(__dirname, '..', '..', '..', 'templates', 'ides');
+}
+/**
+ * Read a template file from templates/ides/.
+ * Returns the template content or null if the template does not exist.
+ */
+async function readTemplate(templateName) {
+    const templatePath = path.join(getTemplatesDir(), templateName);
+    if (!existsSync(templatePath)) {
+        return null;
+    }
+    return readFile(templatePath, 'utf-8');
+}
+/**
+ * Write content to a destination file following the idempotent pattern:
+ * - If the file does not exist, create it with the template content.
+ * - If the file exists and contains the RULEBOOK marker, update it.
+ * - If the file exists without the marker (user-owned), skip and return null.
+ *
+ * Returns the absolute path written, or null if skipped.
+ */
+async function writeIdempotent(destPath, content) {
+    if (existsSync(destPath)) {
+        const existing = await readFile(destPath, 'utf-8');
+        if (!existing.includes(RULEBOOK_MARKER)) {
+            // User-owned file — do not overwrite
+            return null;
+        }
+    }
+    // Ensure the parent directory exists
+    const parentDir = path.dirname(destPath);
+    if (!existsSync(parentDir)) {
+        await mkdir(parentDir, { recursive: true });
+    }
+    await writeFile(destPath, content, 'utf-8');
+    return destPath;
+}
+/**
+ * Generate GEMINI.md in the project root for Gemini CLI.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export async function generateGeminiMd(projectRoot) {
+    const template = await readTemplate('GEMINI_RULES.md');
+    if (!template) {
+        return null;
+    }
+    const destPath = path.join(projectRoot, 'GEMINI.md');
+    return writeIdempotent(destPath, template);
+}
+/**
+ * Generate .continue/rules/RULEBOOK.md for the Continue.dev IDE extension.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export async function generateContinueRules(projectRoot) {
+    const template = await readTemplate('CONTINUE_RULES.md');
+    if (!template) {
+        return null;
+    }
+    const destPath = path.join(projectRoot, '.continue', 'rules', 'RULEBOOK.md');
+    return writeIdempotent(destPath, template);
+}
+/**
+ * Generate .windsurfrules in the project root for Windsurf IDE.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export async function generateWindsurfRules(projectRoot) {
+    const template = await readTemplate('WINDSURF_RULES.md');
+    if (!template) {
+        return null;
+    }
+    const destPath = path.join(projectRoot, '.windsurfrules');
+    return writeIdempotent(destPath, template);
+}
+/**
+ * Generate .github/copilot-instructions.md for GitHub Copilot.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @returns The path written, or null if skipped.
+ */
+export async function generateCopilotInstructions(projectRoot) {
+    const template = await readTemplate('COPILOT_INSTRUCTIONS.md');
+    if (!template) {
+        return null;
+    }
+    const destPath = path.join(projectRoot, '.github', 'copilot-instructions.md');
+    return writeIdempotent(destPath, template);
+}
+/**
+ * Generate configuration files for all detected AI tools.
+ * Only generates files for tools that are actually detected in the project.
+ *
+ * @param projectRoot - Absolute path to the project root.
+ * @param detection - The project detection result containing tool detection flags.
+ * @returns An object with paths of all generated files (undefined for skipped tools).
+ */
+export async function generateMultiToolConfigs(projectRoot, detection) {
+    const result = {};
+    if (detection.geminiCli?.detected) {
+        const written = await generateGeminiMd(projectRoot);
+        if (written) {
+            result.geminiMd = written;
+        }
+    }
+    if (detection.continueDev?.detected) {
+        const written = await generateContinueRules(projectRoot);
+        if (written) {
+            result.continueRules = written;
+        }
+    }
+    if (detection.windsurf?.detected) {
+        const written = await generateWindsurfRules(projectRoot);
+        if (written) {
+            result.windsurfRules = written;
+        }
+    }
+    if (detection.githubCopilot?.detected) {
+        const written = await generateCopilotInstructions(projectRoot);
+        if (written) {
+            result.copilotInstructions = written;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=multi-tool-generator.js.map

package/dist/core/ide/multi-tool-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-tool-generator.js","sourceRoot":"","sources":["../../../src/core/ide/multi-tool-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG/B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEtC,2EAA2E;AAC3E,MAAM,eAAe,GAAG,yBAAyB,CAAC;AAUlD;;;GAGG;AACH,SAAS,eAAe;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;AACrE,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,YAAY,CAAC,YAAoB;IAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,YAAY,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,QAAgB,EAAE,OAAe;IAC9D,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,qCAAqC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,qCAAqC;IACrC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACxD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACrD,OAAO,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,WAAmB;IAC7D,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;IAC7E,OAAO,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,WAAmB;IAC7D,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;IAC1D,OAAO,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,WAAmB;IACnE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,CAAC;IAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC;IAC9E,OAAO,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,WAAmB,EACnB,SAA0B;IAE1B,MAAM,MAAM,GAA6B,EAAE,CAAC;IAE5C,IAAI,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,IAAI,SAAS,CAAC,WAAW,EAAE,QAAQ,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAI,SAAS,CAAC,aAAa,EAAE,QAAQ,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,2BAA2B,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,mBAAmB,GAAG,OAAO,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/core/ide/opencode-generator.d.ts

@@ -0,0 +1,72 @@
+/**
+ * OpenCode Integration Generator
+ *
+ * Generates the OpenCode-specific surface area for a Rulebook-managed project:
+ *  - opencode.json with $schema, mcp.rulebook, and instructions
+ *  - .opencode/commands/<name>.md mirroring user-invocable Rulebook slash commands
+ *  - .opencode/agents/<role>.md mirroring Rulebook role agents
+ *  - .opencode/skills/<name>/SKILL.md normalized to OpenCode's frontmatter schema
+ *  - .opencode/.rulebook-managed.json listing managed keys for safe future updates
+ *
+ * Idempotency: every generator preserves user-owned files. A managed file is
+ * identified by either the `<!-- RULEBOOK:START -->` marker (markdown) or by
+ * the `_rulebook_managed: true` JSON key (managed-keys file).
+ */
+import type { DetectionResult } from '../../types.js';
+export interface OpencodeGenerationResult {
+    configPath?: string;
+    managedKeysPath?: string;
+    commands: string[];
+    agents: string[];
+    skills: string[];
+    preserved: string[];
+}
+/**
+ * Generate or update opencode.json with $schema, mcp.rulebook, and
+ * instructions. Preserves all unrelated user keys. Writes a sibling
+ * .opencode/.rulebook-managed.json listing the managed keys so future runs
+ * know what may be safely refreshed.
+ */
+export declare function generateOpencodeConfig(projectRoot: string, _detection?: DetectionResult): Promise<{
+    configPath: string;
+    managedKeysPath: string;
+}>;
+/**
+ * Generate .opencode/commands/<name>.md from each user-invocable Rulebook
+ * slash-command template under templates/commands/.
+ */
+export declare function generateOpencodeCommands(projectRoot: string): Promise<{
+    written: string[];
+    preserved: string[];
+}>;
+/**
+ * Generate .opencode/agents/<role>.md from each Rulebook role agent.
+ * Sources are templates/agents/<role>.md; we emit one OpenCode agent per
+ * source role.
+ */
+export declare function generateOpencodeAgents(projectRoot: string): Promise<{
+    written: string[];
+    preserved: string[];
+}>;
+/**
+ * Normalize a skill name to OpenCode's regex `[a-z0-9](-[a-z0-9])*` with a
+ * 64-char limit. Sequences of non-alphanumerics collapse into single hyphens
+ * and any leading/trailing hyphens are stripped.
+ */
+export declare function normalizeOpencodeSkillName(raw: string): string;
+/**
+ * Generate .opencode/skills/<normalized-name>/SKILL.md for every dev skill
+ * under templates/skills/dev/. Throws on a name collision so two source
+ * skills never silently overwrite each other.
+ */
+export declare function generateOpencodeSkills(projectRoot: string): Promise<{
+    written: string[];
+    preserved: string[];
+    orphaned: string[];
+}>;
+/**
+ * Run all four OpenCode generators in sequence and aggregate the results.
+ * This is the entry point used by `init` and `update`.
+ */
+export declare function generateOpencodeIntegration(projectRoot: string, detection?: DetectionResult): Promise<OpencodeGenerationResult>;
+//# sourceMappingURL=opencode-generator.d.ts.map

package/dist/core/ide/opencode-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opencode-generator.d.ts","sourceRoot":"","sources":["../../../src/core/ide/opencode-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAoDtD,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AA8FD;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,eAAe,GAC3B,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,CAAA;CAAE,CAAC,CAwC1D;AAyFD;;;GAGG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAoCrD;AA4BD;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAgCrD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK9D;AAWD;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAkEzE;AAED;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,WAAW,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,eAAe,GAC1B,OAAO,CAAC,wBAAwB,CAAC,CAyBnC"}