@shirokuma-library/shirokuma-docs 0.1.0-alpha.5

package/i18n/discussion/en.json

@@ -0,0 +1,191 @@
+{
+  "handovers": {
+    "header": {
+      "title": "Session Handover",
+      "description": "Record information for AI session continuity."
+    },
+    "summary": {
+      "label": "Summary",
+      "description": "What was accomplished in this session",
+      "placeholder": "- Completed Issue #XX\n- Implemented feature YY"
+    },
+    "relatedItems": {
+      "label": "Related Items",
+      "description": "Related Issues/Discussions and their status",
+      "placeholder": "- Issue #19: execSync → spawnSync → Done\n- Issue #20: zod-schema fix → Done"
+    },
+    "decisions": {
+      "label": "Key Decisions",
+      "description": "Important decisions made",
+      "placeholder": "1. Adopted Table JSON format\n2. Using Discussions for knowledge management"
+    },
+    "blockers": {
+      "label": "Blockers",
+      "description": "Current blockers (or \"None\")",
+      "default": "None"
+    },
+    "nextSteps": {
+      "label": "Next Steps",
+      "description": "What to work on in the next session",
+      "placeholder": "- [ ] Start Issue #XX\n- [ ] Research YY"
+    },
+    "commits": {
+      "label": "Commits",
+      "description": "Commits made in this session",
+      "placeholder": "- `abc1234` feat: add feature X\n- `def5678` fix: resolve issue Y"
+    }
+  },
+  "adr": {
+    "header": {
+      "title": "Architecture Decision Record",
+      "description": "Record important architectural decisions."
+    },
+    "status": {
+      "label": "Status",
+      "description": "ADR status"
+    },
+    "context": {
+      "label": "Context",
+      "description": "What is the issue that motivates this decision?",
+      "placeholder": "Currently...\nThe problem is..."
+    },
+    "decision": {
+      "label": "Decision",
+      "description": "What is the change being proposed/made?",
+      "placeholder": "We will adopt XXX.\nBecause..."
+    },
+    "consequences": {
+      "label": "Consequences",
+      "description": "What becomes easier or more difficult?",
+      "placeholder": "**Pros:**\n- Benefit 1\n- Benefit 2\n\n**Cons:**\n- Drawback 1"
+    },
+    "alternatives": {
+      "label": "Alternatives Considered",
+      "description": "Other options that were evaluated",
+      "placeholder": "1. **Option A**: Description... → Reason not chosen\n2. **Option B**: Description... → Reason not chosen"
+    },
+    "references": {
+      "label": "References",
+      "description": "Related documents, Issues, Discussions",
+      "placeholder": "- Issue #XX\n- Discussion #YY\n- https://docs.example.com/"
+    }
+  },
+  "knowledge": {
+    "header": {
+      "title": "Technical Knowledge",
+      "description": "Record confirmed technical knowledge and patterns."
+    },
+    "problem": {
+      "label": "Problem",
+      "description": "What problem does this solve?",
+      "placeholder": "Radix UI components cause hydration errors"
+    },
+    "solution": {
+      "label": "Solution",
+      "description": "The confirmed solution",
+      "placeholder": "Use the `mounted` state pattern"
+    },
+    "example": {
+      "label": "Example",
+      "description": "Code example",
+      "placeholder": "const [mounted, setMounted] = useState(false)\nuseEffect(() => { setMounted(true) }, [])\n\nif (!mounted) return <Placeholder />\nreturn <RadixComponent />"
+    },
+    "whenToUse": {
+      "label": "When to Use",
+      "description": "When to apply this knowledge",
+      "placeholder": "- When using DropdownMenu, Select, Collapsible Radix UI components\n- When getting ID mismatch errors in SSR"
+    },
+    "references": {
+      "label": "References",
+      "description": "Related documents, Issues, Discussions",
+      "placeholder": "- Discovered in Issue #XX\n- https://github.com/radix-ui/primitives/issues/XXX"
+    },
+    "relatedRule": {
+      "label": "Related Rule",
+      "description": "Corresponding .claude/rules/ file (if any)",
+      "placeholder": ".claude/rules/radix-ui.md"
+    }
+  },
+  "research": {
+    "header": {
+      "title": "Research Request",
+      "description": "Record research requests and findings."
+    },
+    "question": {
+      "label": "Question",
+      "description": "What needs to be researched?",
+      "placeholder": "What are the best practices for implementing soft delete in Drizzle ORM?"
+    },
+    "context": {
+      "label": "Context",
+      "description": "Why is this research needed?",
+      "placeholder": "Want to implement logical deletion instead of physical deletion for user data.\nRelated: Issue #XX"
+    },
+    "scope": {
+      "label": "Scope",
+      "description": "Research scope and aspects",
+      "placeholder": "- Drizzle ORM official documentation\n- Existing project implementations\n- Performance implications"
+    },
+    "findings": {
+      "label": "Findings",
+      "description": "Research results (update after completion)",
+      "placeholder": "*Researching...*\n\n---\n**After completion:**\n1. Method A: ...\n2. Method B: ..."
+    },
+    "conclusion": {
+      "label": "Conclusion",
+      "description": "Conclusion and recommendations",
+      "placeholder": "**Recommendation**: Adopt Method A\n\nReason: ..."
+    },
+    "nextActions": {
+      "label": "Next Actions",
+      "description": "Actions after research",
+      "options": {
+        "adr": "Create ADR (if decision needed)",
+        "knowledge": "Create Knowledge (if pattern confirmed)",
+        "issue": "Create Issue (if implementation needed)",
+        "rule": "Create/update Rule (AI extract)"
+      }
+    }
+  },
+  "reports": {
+    "header": {
+      "title": "Agent / Manual Report",
+      "description": "Record review results, implementation reports, or design reports."
+    },
+    "reportType": {
+      "label": "Report Type",
+      "description": "Type of report"
+    },
+    "summary": {
+      "label": "Summary",
+      "description": "Brief summary of what was done and overall outcome",
+      "placeholder": "Reviewed 5 Server Action files. Overall security posture is Good.\nImplemented user profile editing with TDD approach."
+    },
+    "findings": {
+      "label": "Findings / Details",
+      "description": "Detailed findings, issues, decisions, or implementation details",
+      "placeholder": "| Issue | Location | Severity | Description |\n|-------|----------|----------|-------------|\n| Missing auth check | file.ts:45 | Critical | No session verification |"
+    },
+    "filesInvolved": {
+      "label": "Files Involved",
+      "description": "Files created, modified, or reviewed",
+      "placeholder": "| File | Purpose / Changes |\n|------|-------------------|\n| `lib/actions/profile.ts` | New Server Action |\n| `components/profile-form.tsx` | Modified form component |"
+    },
+    "verification": {
+      "label": "Verification",
+      "description": "Verification checklist",
+      "options": {
+        "tests": "All tests pass",
+        "lint": "No lint errors",
+        "typecheck": "Type check passes",
+        "build": "Build passes",
+        "manual": "Manual verification done"
+      }
+    },
+    "notes": {
+      "label": "Notes / Recommendations",
+      "description": "Follow-up tasks, recommendations, or additional context",
+      "placeholder": "1. **Immediate**: Fix critical auth issue\n2. **Before merge**: Add rate limiting\n3. **Future**: Consider caching strategy"
+    }
+  }
+}

package/i18n/discussion/ja.json

@@ -0,0 +1,191 @@
+{
+  "handovers": {
+    "header": {
+      "title": "セッション引き継ぎ",
+      "description": "AI セッション間の引き継ぎ情報を記録します。"
+    },
+    "summary": {
+      "label": "概要",
+      "description": "今回のセッションで達成したこと",
+      "placeholder": "- Issue #XX を完了\n- 機能 YY を実装"
+    },
+    "relatedItems": {
+      "label": "関連アイテム",
+      "description": "関連する Issue/Discussion とそのステータス",
+      "placeholder": "- Issue #19: execSync → spawnSync → Done\n- Issue #20: zod-schema 修正 → Done"
+    },
+    "decisions": {
+      "label": "重要な決定",
+      "description": "重要な決定事項",
+      "placeholder": "1. Table JSON フォーマットを採用\n2. Discussions を知識管理に活用"
+    },
+    "blockers": {
+      "label": "ブロッカー",
+      "description": "現在のブロッカー（なければ \"None\"）",
+      "default": "None"
+    },
+    "nextSteps": {
+      "label": "次のステップ",
+      "description": "次のセッションで取り組むべきこと",
+      "placeholder": "- [ ] Issue #XX に着手\n- [ ] YY の調査"
+    },
+    "commits": {
+      "label": "コミット",
+      "description": "今回のコミット一覧",
+      "placeholder": "- `abc1234` feat: add feature X\n- `def5678` fix: resolve issue Y"
+    }
+  },
+  "adr": {
+    "header": {
+      "title": "Architecture Decision Record",
+      "description": "設計上の重要な決定を記録します。"
+    },
+    "status": {
+      "label": "ステータス",
+      "description": "ADR のステータス"
+    },
+    "context": {
+      "label": "背景",
+      "description": "この決定が必要になった背景・課題",
+      "placeholder": "現在の状況として...\n課題として..."
+    },
+    "decision": {
+      "label": "決定",
+      "description": "決定した内容",
+      "placeholder": "XXX を採用する。\n理由は..."
+    },
+    "consequences": {
+      "label": "影響",
+      "description": "この決定による影響（良い点・悪い点）",
+      "placeholder": "**メリット:**\n- メリット1\n- メリット2\n\n**デメリット:**\n- デメリット1"
+    },
+    "alternatives": {
+      "label": "検討した代替案",
+      "description": "検討した他の選択肢",
+      "placeholder": "1. **選択肢A**: 説明... → 不採用理由\n2. **選択肢B**: 説明... → 不採用理由"
+    },
+    "references": {
+      "label": "参照",
+      "description": "関連するドキュメント、Issue、Discussion",
+      "placeholder": "- Issue #XX\n- Discussion #YY\n- https://docs.example.com/"
+    }
+  },
+  "knowledge": {
+    "header": {
+      "title": "技術知見",
+      "description": "確定した技術的知見・パターンを記録します。"
+    },
+    "problem": {
+      "label": "問題",
+      "description": "どんな問題を解決するか",
+      "placeholder": "Radix UI コンポーネントでハイドレーションエラーが発生する"
+    },
+    "solution": {
+      "label": "解決策",
+      "description": "確定した解決策",
+      "placeholder": "`mounted` state パターンを使用する"
+    },
+    "example": {
+      "label": "例",
+      "description": "コード例",
+      "placeholder": "const [mounted, setMounted] = useState(false)\nuseEffect(() => { setMounted(true) }, [])\n\nif (!mounted) return <Placeholder />\nreturn <RadixComponent />"
+    },
+    "whenToUse": {
+      "label": "適用タイミング",
+      "description": "この知見を適用すべき状況",
+      "placeholder": "- DropdownMenu, Select, Collapsible などの Radix UI コンポーネント使用時\n- SSR 環境で ID 不一致エラーが出る場合"
+    },
+    "references": {
+      "label": "参照",
+      "description": "関連するドキュメント、Issue、Discussion",
+      "placeholder": "- Issue #XX で発見\n- https://github.com/radix-ui/primitives/issues/XXX"
+    },
+    "relatedRule": {
+      "label": "関連ルール",
+      "description": "対応する .claude/rules/ ファイル（あれば）",
+      "placeholder": ".claude/rules/radix-ui.md"
+    }
+  },
+  "research": {
+    "header": {
+      "title": "調査依頼",
+      "description": "調査依頼・調査結果を記録します。"
+    },
+    "question": {
+      "label": "質問",
+      "description": "調査したい内容",
+      "placeholder": "Drizzle ORM で soft delete を実装するベストプラクティスは？"
+    },
+    "context": {
+      "label": "背景",
+      "description": "なぜこの調査が必要か",
+      "placeholder": "ユーザーデータの削除時に物理削除ではなく論理削除を実装したい。\n関連: Issue #XX"
+    },
+    "scope": {
+      "label": "スコープ",
+      "description": "調査の範囲・観点",
+      "placeholder": "- Drizzle ORM 公式ドキュメント\n- 既存プロジェクトの実装例\n- パフォーマンスへの影響"
+    },
+    "findings": {
+      "label": "調査結果",
+      "description": "調査結果（調査完了後に更新）",
+      "placeholder": "*調査中...*\n\n---\n**調査完了後:**\n1. 方法A: ...\n2. 方法B: ..."
+    },
+    "conclusion": {
+      "label": "結論",
+      "description": "結論・推奨事項",
+      "placeholder": "**推奨**: 方法A を採用\n\n理由: ..."
+    },
+    "nextActions": {
+      "label": "次のアクション",
+      "description": "調査後のアクション",
+      "options": {
+        "adr": "ADR を作成する（決定が必要な場合）",
+        "knowledge": "Knowledge を作成する（パターンが確定した場合）",
+        "issue": "Issue を作成する（実装が必要な場合）",
+        "rule": "Rule を作成/更新する（AI 用の抽出）"
+      }
+    }
+  },
+  "reports": {
+    "header": {
+      "title": "エージェント / 手動レポート",
+      "description": "レビュー結果、実装レポート、デザインレポートを記録します。"
+    },
+    "reportType": {
+      "label": "レポートタイプ",
+      "description": "レポートの種類"
+    },
+    "summary": {
+      "label": "概要",
+      "description": "実施内容と全体結果の要約",
+      "placeholder": "Server Action ファイル5件をレビュー。セキュリティ状態は良好。\nTDDアプローチでユーザープロフィール編集を実装。"
+    },
+    "findings": {
+      "label": "詳細 / 発見事項",
+      "description": "詳細な発見事項、問題点、決定事項、または実装詳細",
+      "placeholder": "| 問題 | 場所 | 重大度 | 説明 |\n|------|------|--------|------|\n| 認証チェック欠落 | file.ts:45 | Critical | セッション検証なし |"
+    },
+    "filesInvolved": {
+      "label": "関連ファイル",
+      "description": "作成、変更、またはレビューしたファイル",
+      "placeholder": "| ファイル | 目的 / 変更内容 |\n|---------|----------------|\n| `lib/actions/profile.ts` | 新規 Server Action |\n| `components/profile-form.tsx` | フォームコンポーネント変更 |"
+    },
+    "verification": {
+      "label": "検証",
+      "description": "検証チェックリスト",
+      "options": {
+        "tests": "全テスト合格",
+        "lint": "lint エラーなし",
+        "typecheck": "型チェック合格",
+        "build": "ビルド成功",
+        "manual": "手動検証済み"
+      }
+    },
+    "notes": {
+      "label": "備考 / 推奨事項",
+      "description": "フォローアップタスク、推奨事項、追加コンテキスト",
+      "placeholder": "1. **即時対応**: 認証の重大な問題を修正\n2. **マージ前**: レート制限を追加\n3. **将来**: キャッシュ戦略の検討"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@shirokuma-library/shirokuma-docs",
+  "version": "0.1.0-alpha.5",
+  "description": "Next.js プロジェクト用ドキュメント自動生成 CLI",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "shirokuma-docs": "./bin/shirokuma-docs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "node dist/index.js",
+    "lint": "eslint src",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+    "prepare": "[ -d .githooks ] && git config core.hooksPath .githooks; tsc"
+  },
+  "keywords": [
+    "documentation",
+    "cli",
+    "nextjs",
+    "typedoc",
+    "drizzle",
+    "dbml"
+  ],
+  "author": "ShirokumaLibrary",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ShirokumaLibrary/shirokuma-docs.git"
+  },
+  "homepage": "https://github.com/ShirokumaLibrary/shirokuma-docs#readme",
+  "bugs": {
+    "url": "https://github.com/ShirokumaLibrary/shirokuma-docs/issues"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "chokidar": "^5.0.0",
+    "commander": "^14.0.3",
+    "glob": "^13.0.3",
+    "gray-matter": "^4.0.3",
+    "handlebars": "^4.7.8",
+    "markdown-it": "^14.1.1",
+    "mdast-util-to-string": "^4.0.0",
+    "minimatch": "^10.2.0",
+    "ora": "^9.3.0",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "tiktoken": "^1.0.22",
+    "ts-morph": "^27.0.2",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.3",
+    "yaml": "^2.6.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/markdown-it": "^14.1.2",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^25.2.3",
+    "@types/unist": "^3.0.3",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.7.2"
+  },
+  "peerDependencies": {
+    "dependency-cruiser": ">=16.0.0",
+    "drizzle-dbml-generator": ">=0.7.0",
+    "typedoc": ">=0.26.0",
+    "typedoc-plugin-markdown": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typedoc": {
+      "optional": true
+    },
+    "typedoc-plugin-markdown": {
+      "optional": true
+    },
+    "dependency-cruiser": {
+      "optional": true
+    },
+    "drizzle-dbml-generator": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "templates",
+    "i18n",
+    "portal/app",
+    "portal/components",
+    "portal/lib",
+    "portal/types",
+    "portal/public",
+    "portal/package.json",
+    "portal/next.config.ts",
+    "portal/tsconfig.json",
+    "portal/postcss.config.mjs",
+    "portal/components.json",
+    "LICENSE",
+    "README.md",
+    "THIRD_PARTY_NOTICES.md"
+  ]
+}