shirokuma-docs 0.1.0-alpha.1

package/dist/commands/typedoc.js

@@ -0,0 +1,192 @@
+/**
+ * typedoc コマンド - TypeDoc API ドキュメント生成
+ *
+ * TypeDoc API を使用して、Server Actions や DB スキーマの
+ * API ドキュメントを生成する。
+ *
+ * - typedoc-plugin-markdown がある場合: Markdown 出力
+ * - ない場合: HTML 出力
+ */
+import { resolve } from "node:path";
+import { loadConfig, getOutputPath, resolvePath } from "../utils/config.js";
+import { ensureDir, fileExists, dirExists } from "../utils/file.js";
+import { createLogger } from "../utils/logger.js";
+import { spawnSync } from "node:child_process";
+/**
+ * TypeDoc がインストールされているか確認 (npx経由)
+ */
+function isTypedocInstalled(projectPath) {
+    const result = spawnSync("npx", ["typedoc", "--version"], {
+        cwd: projectPath,
+        stdio: "pipe",
+        encoding: "utf-8",
+    });
+    return result.status === 0;
+}
+/**
+ * typedoc-plugin-markdown がインストールされているか確認
+ */
+function checkMarkdownPluginInstalled(projectPath, logger) {
+    // pnpm の node_modules 構造に対応
+    const result = spawnSync("npm", ["ls", "typedoc-plugin-markdown", "--json"], {
+        cwd: projectPath,
+        encoding: "utf-8",
+        stdio: "pipe",
+    });
+    if (result.status !== 0 || !result.stdout) {
+        logger.debug("typedoc-plugin-markdown がインストールされていません");
+        return false;
+    }
+    try {
+        const json = JSON.parse(result.stdout);
+        const found = json.dependencies?.["typedoc-plugin-markdown"] !== undefined;
+        if (found) {
+            logger.debug("typedoc-plugin-markdown が見つかりました");
+        }
+        else {
+            logger.debug("typedoc-plugin-markdown がインストールされていません");
+        }
+        return found;
+    }
+    catch {
+        logger.debug("typedoc-plugin-markdown がインストールされていません");
+        return false;
+    }
+}
+/**
+ * TypeDoc を使用してドキュメントを生成 (npx経由)
+ */
+function generateDocs(projectPath, entryPoints, outputDir, tsconfigPath, plugins, exclude, logger) {
+    logger.debug(`エントリーポイント: ${entryPoints.join(", ")}`);
+    logger.debug(`出力先: ${outputDir}`);
+    logger.debug(`プラグイン: ${plugins.length > 0 ? plugins.join(", ") : "なし"}`);
+    // spawnSync 用の引数配列を構築
+    const args = [
+        "typedoc",
+        ...entryPoints,
+        "--out", outputDir,
+        "--tsconfig", tsconfigPath,
+        "--excludePrivate",
+        "--excludeProtected",
+        "--excludeInternal",
+        "--hideGenerator",
+        "--entryPointStrategy", "expand",
+    ];
+    // プラグインを追加
+    for (const plugin of plugins) {
+        args.push("--plugin", plugin);
+    }
+    // 除外パターンを追加
+    for (const pattern of exclude) {
+        args.push("--exclude", pattern);
+    }
+    logger.debug(`実行: npx ${args.join(" ")}`);
+    const result = spawnSync("npx", args, {
+        cwd: projectPath,
+        stdio: "pipe",
+        encoding: "utf-8",
+    });
+    if (result.status === 0) {
+        logger.success(`ドキュメント生成完了: ${outputDir}`);
+        return true;
+    }
+    logger.error(`TypeDoc 生成エラー: ${result.stderr || result.error}`);
+    return false;
+}
+/**
+ * typedoc コマンドハンドラ
+ */
+export async function typedocCommand(options) {
+    const logger = createLogger(options.verbose);
+    const projectPath = resolve(options.project);
+    logger.info("TypeDoc API ドキュメントを生成");
+    // TypeDoc インストール確認
+    if (!isTypedocInstalled(projectPath)) {
+        logger.error("TypeDoc がインストールされていません");
+        logger.info("インストール: pnpm add -D typedoc typedoc-plugin-markdown");
+        throw new Error("TypeDoc not installed");
+    }
+    logger.debug("TypeDoc: インストール確認済み");
+    // 設定読み込み
+    const config = loadConfig(projectPath, options.config);
+    const typedocConfig = config.typedoc;
+    if (!typedocConfig?.entryPoints?.length) {
+        logger.warn("TypeDoc エントリーポイントが設定されていません");
+        logger.info("設定例:");
+        logger.info("  typedoc:");
+        logger.info('    entryPoints: ["./apps/web/lib/actions", "./packages/database/src/schema"]');
+        return;
+    }
+    // エントリーポイントを解決・検証
+    const entryPoints = [];
+    for (const ep of typedocConfig.entryPoints) {
+        const resolvedPath = resolvePath(projectPath, ep);
+        if (fileExists(resolvedPath) || dirExists(resolvedPath)) {
+            entryPoints.push(resolvedPath);
+            logger.debug(`エントリーポイント追加: ${resolvedPath}`);
+        }
+        else {
+            logger.warn(`エントリーポイントが見つかりません: ${resolvedPath}`);
+        }
+    }
+    if (entryPoints.length === 0) {
+        logger.error("有効なエントリーポイントがありません");
+        throw new Error("No valid entry points found");
+    }
+    // 出力ディレクトリを決定
+    // 優先順位: CLI引数 > typedoc.out > output.generated/api
+    let outputDir;
+    if (options.output) {
+        outputDir = resolve(options.output, "api");
+    }
+    else if (typedocConfig.out) {
+        outputDir = resolvePath(projectPath, typedocConfig.out);
+    }
+    else {
+        const generatedDir = getOutputPath(config, projectPath, "generated");
+        outputDir = resolve(generatedDir, "api");
+    }
+    ensureDir(outputDir);
+    // tsconfig パス
+    const tsconfigPath = typedocConfig.tsconfig
+        ? resolvePath(projectPath, typedocConfig.tsconfig)
+        : resolve(projectPath, "tsconfig.json");
+    if (!fileExists(tsconfigPath)) {
+        logger.warn(`tsconfig が見つかりません: ${tsconfigPath}`);
+        logger.info("TypeScript 設定なしで続行します");
+    }
+    // 除外パターン
+    const exclude = typedocConfig.exclude || [
+        "**/node_modules/**",
+        "**/*.test.ts",
+        "**/*.test.tsx",
+        "**/*.spec.ts",
+        "**/*.spec.tsx",
+    ];
+    // プラグインを決定
+    // 設定ファイルで指定されている場合はそれを使用
+    // 指定がない場合は typedoc-plugin-markdown の存在を確認
+    let plugins = [];
+    if (typedocConfig.plugin && typedocConfig.plugin.length > 0) {
+        plugins = typedocConfig.plugin;
+        logger.debug("設定ファイルからプラグインを使用");
+    }
+    else {
+        // typedoc-plugin-markdown が利用可能か確認
+        const hasMarkdownPlugin = checkMarkdownPluginInstalled(projectPath, logger);
+        if (hasMarkdownPlugin) {
+            plugins = ["typedoc-plugin-markdown"];
+            logger.info("Markdown 形式で出力 (typedoc-plugin-markdown)");
+        }
+        else {
+            logger.info("HTML 形式で出力");
+        }
+    }
+    // ドキュメント生成
+    const success = generateDocs(projectPath, entryPoints, outputDir, tsconfigPath, plugins, exclude, logger);
+    if (!success) {
+        throw new Error("TypeDoc generation failed");
+    }
+    logger.success("TypeDoc 生成完了");
+}
+//# sourceMappingURL=typedoc.js.map

package/dist/commands/typedoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc.js","sourceRoot":"","sources":["../../src/commands/typedoc.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAe,MAAM,oBAAoB,CAAC;AAS/D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,SAAS,kBAAkB,CAAC,WAAmB;IAC7C,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE;QACxD,GAAG,EAAE,WAAW;QAChB,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,SAAS,4BAA4B,CACnC,WAAmB,EACnB,MAAc;IAEd,4BAA4B;IAC5B,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,yBAAyB,EAAE,QAAQ,CAAC,EAAE;QAC3E,GAAG,EAAE,WAAW;QAChB,QAAQ,EAAE,OAAO;QACjB,KAAK,EAAE,MAAM;KACd,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACvD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,yBAAyB,CAAC,KAAK,SAAS,CAAC;QAC3E,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACvD,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CACnB,WAAmB,EACnB,WAAqB,EACrB,SAAiB,EACjB,YAAoB,EACpB,OAAiB,EACjB,OAAiB,EACjB,MAAc;IAEd,MAAM,CAAC,KAAK,CAAC,cAAc,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAC,CAAC;IAClC,MAAM,CAAC,KAAK,CACV,UAAU,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAC3D,CAAC;IAEF,sBAAsB;IACtB,MAAM,IAAI,GAAG;QACX,SAAS;QACT,GAAG,WAAW;QACd,OAAO,EAAE,SAAS;QAClB,YAAY,EAAE,YAAY;QAC1B,kBAAkB;QAClB,oBAAoB;QACpB,mBAAmB;QACnB,iBAAiB;QACjB,sBAAsB,EAAE,QAAQ;KACjC,CAAC;IAEF,WAAW;IACX,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,YAAY;IACZ,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAE1C,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE;QACpC,GAAG,EAAE,WAAW;QAChB,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,eAAe,SAAS,EAAE,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB;IAC1D,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAErC,mBAAmB;IACnB,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;QACnE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpC,SAAS;IACT,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC;IAErC,IAAI,CAAC,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;QACF,OAAO;IACT,CAAC;IAED,kBAAkB;IAClB,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,KAAK,MAAM,EAAE,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,YAAY,GAAG,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAElD,IAAI,UAAU,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC/B,MAAM,CAAC,KAAK,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,sBAAsB,YAAY,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,cAAc;IACd,mDAAmD;IACnD,IAAI,SAAiB,CAAC;IACtB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;SAAM,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;QAC7B,SAAS,GAAG,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;SAAM,CAAC;QACN,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QACrE,SAAS,GAAG,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,SAAS,CAAC,SAAS,CAAC,CAAC;IAErB,cAAc;IACd,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ;QACzC,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC;QAClD,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IAE1C,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,sBAAsB,YAAY,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAED,SAAS;IACT,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI;QACvC,oBAAoB;QACpB,cAAc;QACd,eAAe;QACf,cAAc;QACd,eAAe;KAChB,CAAC;IAEF,WAAW;IACX,yBAAyB;IACzB,0CAA0C;IAC1C,IAAI,OAAO,GAAa,EAAE,CAAC;IAE3B,IAAI,aAAa,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnC,CAAC;SAAM,CAAC;QACN,mCAAmC;QACnC,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC5E,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,WAAW;IACX,MAAM,OAAO,GAAG,YAAY,CAC1B,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,OAAO,EACP,OAAO,EACP,MAAM,CACP,CAAC;IAEF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;AACjC,CAAC"}

package/dist/commands/update-skills.d.ts

@@ -0,0 +1,56 @@
+/**
+ * update-skills command - Update installed skills/rules from bundled plugin
+ *
+ * @description Updates installed skills and rules to the version bundled
+ * in the shirokuma-docs package, preserving project/ directories.
+ *
+ * @example
+ * ```bash
+ * # Update all installed skills
+ * shirokuma-docs update-skills
+ *
+ * # Update specific skills only
+ * shirokuma-docs update-skills --skills managing-agents,reviewing-on-issue
+ *
+ * # Update with rules
+ * shirokuma-docs update-skills --with-rules
+ *
+ * # Preview changes without updating
+ * shirokuma-docs update-skills --dry-run
+ *
+ * # Force update (ignore local changes)
+ * shirokuma-docs update-skills --force
+ *
+ * # Sync mode: detect new/removed skills
+ * shirokuma-docs update-skills --sync
+ * ```
+ */
+/**
+ * update-skills command options
+ */
+interface UpdateSkillsOptions {
+    /** Project path */
+    project: string;
+    /** Specific skills to update (comma-separated) */
+    skills?: string;
+    /** Update rules as well */
+    withRules?: boolean;
+    /** Sync mode: detect and add new skills, detect removed skills */
+    sync?: boolean;
+    /** Auto-confirm destructive operations (removals) */
+    yes?: boolean;
+    /** Preview mode (no actual changes) */
+    dryRun?: boolean;
+    /** Force update (ignore local changes) */
+    force?: boolean;
+    /** Force global cache sync (claude plugin uninstall + install) */
+    installCache?: boolean;
+    /** Verbose logging */
+    verbose?: boolean;
+}
+/**
+ * update-skills command handler
+ */
+export declare function updateSkillsCommand(options: UpdateSkillsOptions): Promise<void>;
+export {};
+//# sourceMappingURL=update-skills.d.ts.map

package/dist/commands/update-skills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-skills.d.ts","sourceRoot":"","sources":["../../src/commands/update-skills.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAqCH;;GAEG;AACH,UAAU,mBAAmB;IAC3B,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,qDAAqD;IACrD,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,uCAAuC;IACvC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,kEAAkE;IAClE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAmUD;;GAEG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8MrF"}