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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of @shirokuma-library/shirokuma-docs might be problematic. Click here for more details.

Files changed (753) hide show
  1. package/LICENSE +21 -0
  2. package/README.en.md +308 -0
  3. package/README.md +308 -0
  4. package/THIRD_PARTY_NOTICES.md +18 -0
  5. package/bin/shirokuma-docs +2 -0
  6. package/dist/analyzers/details-test-analysis.d.ts +31 -0
  7. package/dist/analyzers/details-test-analysis.d.ts.map +1 -0
  8. package/dist/analyzers/details-test-analysis.js +172 -0
  9. package/dist/analyzers/details-test-analysis.js.map +1 -0
  10. package/dist/analyzers/feature-map-builder.d.ts +20 -0
  11. package/dist/analyzers/feature-map-builder.d.ts.map +1 -0
  12. package/dist/analyzers/feature-map-builder.js +154 -0
  13. package/dist/analyzers/feature-map-builder.js.map +1 -0
  14. package/dist/analyzers/feature-map-references.d.ts +34 -0
  15. package/dist/analyzers/feature-map-references.d.ts.map +1 -0
  16. package/dist/analyzers/feature-map-references.js +249 -0
  17. package/dist/analyzers/feature-map-references.js.map +1 -0
  18. package/dist/analyzers/reference-analyzer.d.ts +95 -0
  19. package/dist/analyzers/reference-analyzer.d.ts.map +1 -0
  20. package/dist/analyzers/reference-analyzer.js +372 -0
  21. package/dist/analyzers/reference-analyzer.js.map +1 -0
  22. package/dist/commands/adr.d.ts +26 -0
  23. package/dist/commands/adr.d.ts.map +1 -0
  24. package/dist/commands/adr.js +129 -0
  25. package/dist/commands/adr.js.map +1 -0
  26. package/dist/commands/api-tools.d.ts +83 -0
  27. package/dist/commands/api-tools.d.ts.map +1 -0
  28. package/dist/commands/api-tools.js +775 -0
  29. package/dist/commands/api-tools.js.map +1 -0
  30. package/dist/commands/coverage.d.ts +139 -0
  31. package/dist/commands/coverage.d.ts.map +1 -0
  32. package/dist/commands/coverage.js +481 -0
  33. package/dist/commands/coverage.js.map +1 -0
  34. package/dist/commands/deps.d.ts +24 -0
  35. package/dist/commands/deps.d.ts.map +1 -0
  36. package/dist/commands/deps.js +211 -0
  37. package/dist/commands/deps.js.map +1 -0
  38. package/dist/commands/details-context.d.ts +38 -0
  39. package/dist/commands/details-context.d.ts.map +1 -0
  40. package/dist/commands/details-context.js +193 -0
  41. package/dist/commands/details-context.js.map +1 -0
  42. package/dist/commands/details-types.d.ts +315 -0
  43. package/dist/commands/details-types.d.ts.map +1 -0
  44. package/dist/commands/details-types.js +7 -0
  45. package/dist/commands/details-types.js.map +1 -0
  46. package/dist/commands/details.d.ts +24 -0
  47. package/dist/commands/details.d.ts.map +1 -0
  48. package/dist/commands/details.js +299 -0
  49. package/dist/commands/details.js.map +1 -0
  50. package/dist/commands/discussion-templates.d.ts +26 -0
  51. package/dist/commands/discussion-templates.d.ts.map +1 -0
  52. package/dist/commands/discussion-templates.js +270 -0
  53. package/dist/commands/discussion-templates.js.map +1 -0
  54. package/dist/commands/discussions.d.ts +31 -0
  55. package/dist/commands/discussions.d.ts.map +1 -0
  56. package/dist/commands/discussions.js +743 -0
  57. package/dist/commands/discussions.js.map +1 -0
  58. package/dist/commands/feature-map-types.d.ts +294 -0
  59. package/dist/commands/feature-map-types.d.ts.map +1 -0
  60. package/dist/commands/feature-map-types.js +8 -0
  61. package/dist/commands/feature-map-types.js.map +1 -0
  62. package/dist/commands/feature-map.d.ts +30 -0
  63. package/dist/commands/feature-map.d.ts.map +1 -0
  64. package/dist/commands/feature-map.js +137 -0
  65. package/dist/commands/feature-map.js.map +1 -0
  66. package/dist/commands/generate.d.ts +16 -0
  67. package/dist/commands/generate.d.ts.map +1 -0
  68. package/dist/commands/generate.js +88 -0
  69. package/dist/commands/generate.js.map +1 -0
  70. package/dist/commands/gh-discussions.d.ts +31 -0
  71. package/dist/commands/gh-discussions.d.ts.map +1 -0
  72. package/dist/commands/gh-discussions.js +743 -0
  73. package/dist/commands/gh-discussions.js.map +1 -0
  74. package/dist/commands/gh-issues-pr.d.ts +74 -0
  75. package/dist/commands/gh-issues-pr.d.ts.map +1 -0
  76. package/dist/commands/gh-issues-pr.js +417 -0
  77. package/dist/commands/gh-issues-pr.js.map +1 -0
  78. package/dist/commands/gh-issues.d.ts +90 -0
  79. package/dist/commands/gh-issues.d.ts.map +1 -0
  80. package/dist/commands/gh-issues.js +1297 -0
  81. package/dist/commands/gh-issues.js.map +1 -0
  82. package/dist/commands/gh-projects.d.ts +54 -0
  83. package/dist/commands/gh-projects.d.ts.map +1 -0
  84. package/dist/commands/gh-projects.js +966 -0
  85. package/dist/commands/gh-projects.js.map +1 -0
  86. package/dist/commands/gh-repo.d.ts +18 -0
  87. package/dist/commands/gh-repo.d.ts.map +1 -0
  88. package/dist/commands/gh-repo.js +253 -0
  89. package/dist/commands/gh-repo.js.map +1 -0
  90. package/dist/commands/github-data.d.ts +67 -0
  91. package/dist/commands/github-data.d.ts.map +1 -0
  92. package/dist/commands/github-data.js +361 -0
  93. package/dist/commands/github-data.js.map +1 -0
  94. package/dist/commands/i18n.d.ts +102 -0
  95. package/dist/commands/i18n.d.ts.map +1 -0
  96. package/dist/commands/i18n.js +829 -0
  97. package/dist/commands/i18n.js.map +1 -0
  98. package/dist/commands/impact.d.ts +14 -0
  99. package/dist/commands/impact.d.ts.map +1 -0
  100. package/dist/commands/impact.js +263 -0
  101. package/dist/commands/impact.js.map +1 -0
  102. package/dist/commands/init.d.ts +53 -0
  103. package/dist/commands/init.d.ts.map +1 -0
  104. package/dist/commands/init.js +429 -0
  105. package/dist/commands/init.js.map +1 -0
  106. package/dist/commands/issues-pr.d.ts +74 -0
  107. package/dist/commands/issues-pr.d.ts.map +1 -0
  108. package/dist/commands/issues-pr.js +417 -0
  109. package/dist/commands/issues-pr.js.map +1 -0
  110. package/dist/commands/issues.d.ts +76 -0
  111. package/dist/commands/issues.d.ts.map +1 -0
  112. package/dist/commands/issues.js +1285 -0
  113. package/dist/commands/issues.js.map +1 -0
  114. package/dist/commands/link-docs.d.ts +21 -0
  115. package/dist/commands/link-docs.d.ts.map +1 -0
  116. package/dist/commands/link-docs.js +990 -0
  117. package/dist/commands/link-docs.js.map +1 -0
  118. package/dist/commands/lint-annotations.d.ts +28 -0
  119. package/dist/commands/lint-annotations.d.ts.map +1 -0
  120. package/dist/commands/lint-annotations.js +511 -0
  121. package/dist/commands/lint-annotations.js.map +1 -0
  122. package/dist/commands/lint-code.d.ts +26 -0
  123. package/dist/commands/lint-code.d.ts.map +1 -0
  124. package/dist/commands/lint-code.js +428 -0
  125. package/dist/commands/lint-code.js.map +1 -0
  126. package/dist/commands/lint-coverage.d.ts +33 -0
  127. package/dist/commands/lint-coverage.d.ts.map +1 -0
  128. package/dist/commands/lint-coverage.js +379 -0
  129. package/dist/commands/lint-coverage.js.map +1 -0
  130. package/dist/commands/lint-docs.d.ts +23 -0
  131. package/dist/commands/lint-docs.d.ts.map +1 -0
  132. package/dist/commands/lint-docs.js +338 -0
  133. package/dist/commands/lint-docs.js.map +1 -0
  134. package/dist/commands/lint-structure.d.ts +38 -0
  135. package/dist/commands/lint-structure.d.ts.map +1 -0
  136. package/dist/commands/lint-structure.js +350 -0
  137. package/dist/commands/lint-structure.js.map +1 -0
  138. package/dist/commands/lint-tests.d.ts +25 -0
  139. package/dist/commands/lint-tests.d.ts.map +1 -0
  140. package/dist/commands/lint-tests.js +105 -0
  141. package/dist/commands/lint-tests.js.map +1 -0
  142. package/dist/commands/lint-workflow.d.ts +36 -0
  143. package/dist/commands/lint-workflow.d.ts.map +1 -0
  144. package/dist/commands/lint-workflow.js +255 -0
  145. package/dist/commands/lint-workflow.js.map +1 -0
  146. package/dist/commands/overview.d.ts +21 -0
  147. package/dist/commands/overview.d.ts.map +1 -0
  148. package/dist/commands/overview.js +1300 -0
  149. package/dist/commands/overview.js.map +1 -0
  150. package/dist/commands/packages.d.ts +107 -0
  151. package/dist/commands/packages.d.ts.map +1 -0
  152. package/dist/commands/packages.js +308 -0
  153. package/dist/commands/packages.js.map +1 -0
  154. package/dist/commands/portal-nextjs.d.ts +23 -0
  155. package/dist/commands/portal-nextjs.d.ts.map +1 -0
  156. package/dist/commands/portal-nextjs.js +336 -0
  157. package/dist/commands/portal-nextjs.js.map +1 -0
  158. package/dist/commands/portal.d.ts +24 -0
  159. package/dist/commands/portal.d.ts.map +1 -0
  160. package/dist/commands/portal.js +16 -0
  161. package/dist/commands/portal.js.map +1 -0
  162. package/dist/commands/projects.d.ts +54 -0
  163. package/dist/commands/projects.d.ts.map +1 -0
  164. package/dist/commands/projects.js +969 -0
  165. package/dist/commands/projects.js.map +1 -0
  166. package/dist/commands/repo-pairs.d.ts +19 -0
  167. package/dist/commands/repo-pairs.d.ts.map +1 -0
  168. package/dist/commands/repo-pairs.js +529 -0
  169. package/dist/commands/repo-pairs.js.map +1 -0
  170. package/dist/commands/repo.d.ts +18 -0
  171. package/dist/commands/repo.d.ts.map +1 -0
  172. package/dist/commands/repo.js +253 -0
  173. package/dist/commands/repo.js.map +1 -0
  174. package/dist/commands/schema.d.ts +49 -0
  175. package/dist/commands/schema.d.ts.map +1 -0
  176. package/dist/commands/schema.js +830 -0
  177. package/dist/commands/schema.js.map +1 -0
  178. package/dist/commands/screenshots.d.ts +203 -0
  179. package/dist/commands/screenshots.d.ts.map +1 -0
  180. package/dist/commands/screenshots.js +1234 -0
  181. package/dist/commands/screenshots.js.map +1 -0
  182. package/dist/commands/search-index.d.ts +83 -0
  183. package/dist/commands/search-index.d.ts.map +1 -0
  184. package/dist/commands/search-index.js +389 -0
  185. package/dist/commands/search-index.js.map +1 -0
  186. package/dist/commands/session.d.ts +153 -0
  187. package/dist/commands/session.d.ts.map +1 -0
  188. package/dist/commands/session.js +1243 -0
  189. package/dist/commands/session.js.map +1 -0
  190. package/dist/commands/test-cases-types.d.ts +154 -0
  191. package/dist/commands/test-cases-types.d.ts.map +1 -0
  192. package/dist/commands/test-cases-types.js +7 -0
  193. package/dist/commands/test-cases-types.js.map +1 -0
  194. package/dist/commands/test-cases.d.ts +28 -0
  195. package/dist/commands/test-cases.d.ts.map +1 -0
  196. package/dist/commands/test-cases.js +192 -0
  197. package/dist/commands/test-cases.js.map +1 -0
  198. package/dist/commands/typedoc.d.ts +21 -0
  199. package/dist/commands/typedoc.d.ts.map +1 -0
  200. package/dist/commands/typedoc.js +192 -0
  201. package/dist/commands/typedoc.js.map +1 -0
  202. package/dist/commands/update-skills.d.ts +56 -0
  203. package/dist/commands/update-skills.d.ts.map +1 -0
  204. package/dist/commands/update-skills.js +620 -0
  205. package/dist/commands/update-skills.js.map +1 -0
  206. package/dist/generators/details-entity-pages.d.ts +40 -0
  207. package/dist/generators/details-entity-pages.d.ts.map +1 -0
  208. package/dist/generators/details-entity-pages.js +301 -0
  209. package/dist/generators/details-entity-pages.js.map +1 -0
  210. package/dist/generators/details-html.d.ts +23 -0
  211. package/dist/generators/details-html.d.ts.map +1 -0
  212. package/dist/generators/details-html.js +324 -0
  213. package/dist/generators/details-html.js.map +1 -0
  214. package/dist/generators/details-module-page.d.ts +33 -0
  215. package/dist/generators/details-module-page.d.ts.map +1 -0
  216. package/dist/generators/details-module-page.js +408 -0
  217. package/dist/generators/details-module-page.js.map +1 -0
  218. package/dist/generators/details-styles.d.ts +39 -0
  219. package/dist/generators/details-styles.d.ts.map +1 -0
  220. package/dist/generators/details-styles.js +409 -0
  221. package/dist/generators/details-styles.js.map +1 -0
  222. package/dist/generators/feature-map-html.d.ts +66 -0
  223. package/dist/generators/feature-map-html.d.ts.map +1 -0
  224. package/dist/generators/feature-map-html.js +569 -0
  225. package/dist/generators/feature-map-html.js.map +1 -0
  226. package/dist/generators/feature-map-styles.d.ts +39 -0
  227. package/dist/generators/feature-map-styles.d.ts.map +1 -0
  228. package/dist/generators/feature-map-styles.js +449 -0
  229. package/dist/generators/feature-map-styles.js.map +1 -0
  230. package/dist/generators/test-cases-hierarchy.d.ts +21 -0
  231. package/dist/generators/test-cases-hierarchy.d.ts.map +1 -0
  232. package/dist/generators/test-cases-hierarchy.js +336 -0
  233. package/dist/generators/test-cases-hierarchy.js.map +1 -0
  234. package/dist/generators/test-cases-main.d.ts +20 -0
  235. package/dist/generators/test-cases-main.d.ts.map +1 -0
  236. package/dist/generators/test-cases-main.js +439 -0
  237. package/dist/generators/test-cases-main.js.map +1 -0
  238. package/dist/generators/test-cases-styles.d.ts +64 -0
  239. package/dist/generators/test-cases-styles.d.ts.map +1 -0
  240. package/dist/generators/test-cases-styles.js +1277 -0
  241. package/dist/generators/test-cases-styles.js.map +1 -0
  242. package/dist/index.d.ts +13 -0
  243. package/dist/index.d.ts.map +1 -0
  244. package/dist/index.js +517 -0
  245. package/dist/index.js.map +1 -0
  246. package/dist/lint/annotation-lint.d.ts +198 -0
  247. package/dist/lint/annotation-lint.d.ts.map +1 -0
  248. package/dist/lint/annotation-lint.js +510 -0
  249. package/dist/lint/annotation-lint.js.map +1 -0
  250. package/dist/lint/annotation-types.d.ts +161 -0
  251. package/dist/lint/annotation-types.d.ts.map +1 -0
  252. package/dist/lint/annotation-types.js +31 -0
  253. package/dist/lint/annotation-types.js.map +1 -0
  254. package/dist/lint/code-types.d.ts +135 -0
  255. package/dist/lint/code-types.d.ts.map +1 -0
  256. package/dist/lint/code-types.js +25 -0
  257. package/dist/lint/code-types.js.map +1 -0
  258. package/dist/lint/coverage-types.d.ts +128 -0
  259. package/dist/lint/coverage-types.d.ts.map +1 -0
  260. package/dist/lint/coverage-types.js +24 -0
  261. package/dist/lint/coverage-types.js.map +1 -0
  262. package/dist/lint/docs-types.d.ts +214 -0
  263. package/dist/lint/docs-types.d.ts.map +1 -0
  264. package/dist/lint/docs-types.js +18 -0
  265. package/dist/lint/docs-types.js.map +1 -0
  266. package/dist/lint/formatters/index.d.ts +14 -0
  267. package/dist/lint/formatters/index.d.ts.map +1 -0
  268. package/dist/lint/formatters/index.js +28 -0
  269. package/dist/lint/formatters/index.js.map +1 -0
  270. package/dist/lint/formatters/json.d.ts +11 -0
  271. package/dist/lint/formatters/json.d.ts.map +1 -0
  272. package/dist/lint/formatters/json.js +12 -0
  273. package/dist/lint/formatters/json.js.map +1 -0
  274. package/dist/lint/formatters/summary.d.ts +11 -0
  275. package/dist/lint/formatters/summary.d.ts.map +1 -0
  276. package/dist/lint/formatters/summary.js +37 -0
  277. package/dist/lint/formatters/summary.js.map +1 -0
  278. package/dist/lint/formatters/terminal.d.ts +11 -0
  279. package/dist/lint/formatters/terminal.d.ts.map +1 -0
  280. package/dist/lint/formatters/terminal.js +99 -0
  281. package/dist/lint/formatters/terminal.js.map +1 -0
  282. package/dist/lint/index.d.ts +18 -0
  283. package/dist/lint/index.d.ts.map +1 -0
  284. package/dist/lint/index.js +103 -0
  285. package/dist/lint/index.js.map +1 -0
  286. package/dist/lint/rules/annotation-required.d.ts +35 -0
  287. package/dist/lint/rules/annotation-required.d.ts.map +1 -0
  288. package/dist/lint/rules/annotation-required.js +127 -0
  289. package/dist/lint/rules/annotation-required.js.map +1 -0
  290. package/dist/lint/rules/code-rules.d.ts +12 -0
  291. package/dist/lint/rules/code-rules.d.ts.map +1 -0
  292. package/dist/lint/rules/code-rules.js +11 -0
  293. package/dist/lint/rules/code-rules.js.map +1 -0
  294. package/dist/lint/rules/describe-coverage.d.ts +8 -0
  295. package/dist/lint/rules/describe-coverage.d.ts.map +1 -0
  296. package/dist/lint/rules/describe-coverage.js +43 -0
  297. package/dist/lint/rules/describe-coverage.js.map +1 -0
  298. package/dist/lint/rules/duplicate-testdoc.d.ts +8 -0
  299. package/dist/lint/rules/duplicate-testdoc.d.ts.map +1 -0
  300. package/dist/lint/rules/duplicate-testdoc.js +38 -0
  301. package/dist/lint/rules/duplicate-testdoc.js.map +1 -0
  302. package/dist/lint/rules/index.d.ts +29 -0
  303. package/dist/lint/rules/index.d.ts.map +1 -0
  304. package/dist/lint/rules/index.js +55 -0
  305. package/dist/lint/rules/index.js.map +1 -0
  306. package/dist/lint/rules/server-action-structure.d.ts +37 -0
  307. package/dist/lint/rules/server-action-structure.d.ts.map +1 -0
  308. package/dist/lint/rules/server-action-structure.js +151 -0
  309. package/dist/lint/rules/server-action-structure.js.map +1 -0
  310. package/dist/lint/rules/skipped-test-report.d.ts +11 -0
  311. package/dist/lint/rules/skipped-test-report.d.ts.map +1 -0
  312. package/dist/lint/rules/skipped-test-report.js +31 -0
  313. package/dist/lint/rules/skipped-test-report.js.map +1 -0
  314. package/dist/lint/rules/structure-rules.d.ts +67 -0
  315. package/dist/lint/rules/structure-rules.d.ts.map +1 -0
  316. package/dist/lint/rules/structure-rules.js +615 -0
  317. package/dist/lint/rules/structure-rules.js.map +1 -0
  318. package/dist/lint/rules/testdoc-japanese.d.ts +8 -0
  319. package/dist/lint/rules/testdoc-japanese.d.ts.map +1 -0
  320. package/dist/lint/rules/testdoc-japanese.js +31 -0
  321. package/dist/lint/rules/testdoc-japanese.js.map +1 -0
  322. package/dist/lint/rules/testdoc-min-length.d.ts +8 -0
  323. package/dist/lint/rules/testdoc-min-length.d.ts.map +1 -0
  324. package/dist/lint/rules/testdoc-min-length.js +31 -0
  325. package/dist/lint/rules/testdoc-min-length.js.map +1 -0
  326. package/dist/lint/rules/testdoc-required.d.ts +8 -0
  327. package/dist/lint/rules/testdoc-required.d.ts.map +1 -0
  328. package/dist/lint/rules/testdoc-required.js +27 -0
  329. package/dist/lint/rules/testdoc-required.js.map +1 -0
  330. package/dist/lint/rules/workflow-branch-naming.d.ts +20 -0
  331. package/dist/lint/rules/workflow-branch-naming.d.ts.map +1 -0
  332. package/dist/lint/rules/workflow-branch-naming.js +85 -0
  333. package/dist/lint/rules/workflow-branch-naming.js.map +1 -0
  334. package/dist/lint/rules/workflow-commit-format.d.ts +27 -0
  335. package/dist/lint/rules/workflow-commit-format.d.ts.map +1 -0
  336. package/dist/lint/rules/workflow-commit-format.js +92 -0
  337. package/dist/lint/rules/workflow-commit-format.js.map +1 -0
  338. package/dist/lint/rules/workflow-issue-fields.d.ts +24 -0
  339. package/dist/lint/rules/workflow-issue-fields.d.ts.map +1 -0
  340. package/dist/lint/rules/workflow-issue-fields.js +89 -0
  341. package/dist/lint/rules/workflow-issue-fields.js.map +1 -0
  342. package/dist/lint/rules/workflow-main-protection.d.ts +32 -0
  343. package/dist/lint/rules/workflow-main-protection.d.ts.map +1 -0
  344. package/dist/lint/rules/workflow-main-protection.js +114 -0
  345. package/dist/lint/rules/workflow-main-protection.js.map +1 -0
  346. package/dist/lint/structure-types.d.ts +216 -0
  347. package/dist/lint/structure-types.d.ts.map +1 -0
  348. package/dist/lint/structure-types.js +96 -0
  349. package/dist/lint/structure-types.js.map +1 -0
  350. package/dist/lint/types.d.ts +154 -0
  351. package/dist/lint/types.d.ts.map +1 -0
  352. package/dist/lint/types.js +21 -0
  353. package/dist/lint/types.js.map +1 -0
  354. package/dist/lint/workflow-types.d.ts +90 -0
  355. package/dist/lint/workflow-types.d.ts.map +1 -0
  356. package/dist/lint/workflow-types.js +7 -0
  357. package/dist/lint/workflow-types.js.map +1 -0
  358. package/dist/md/analyzer/index.d.ts +46 -0
  359. package/dist/md/analyzer/index.d.ts.map +1 -0
  360. package/dist/md/analyzer/index.js +288 -0
  361. package/dist/md/analyzer/index.js.map +1 -0
  362. package/dist/md/builder/index.d.ts +91 -0
  363. package/dist/md/builder/index.d.ts.map +1 -0
  364. package/dist/md/builder/index.js +446 -0
  365. package/dist/md/builder/index.js.map +1 -0
  366. package/dist/md/cli/analyze.d.ts +11 -0
  367. package/dist/md/cli/analyze.d.ts.map +1 -0
  368. package/dist/md/cli/analyze.js +118 -0
  369. package/dist/md/cli/analyze.js.map +1 -0
  370. package/dist/md/cli/build.d.ts +11 -0
  371. package/dist/md/cli/build.d.ts.map +1 -0
  372. package/dist/md/cli/build.js +74 -0
  373. package/dist/md/cli/build.js.map +1 -0
  374. package/dist/md/cli/extract.d.ts +25 -0
  375. package/dist/md/cli/extract.d.ts.map +1 -0
  376. package/dist/md/cli/extract.js +230 -0
  377. package/dist/md/cli/extract.js.map +1 -0
  378. package/dist/md/cli/index.d.ts +3 -0
  379. package/dist/md/cli/index.d.ts.map +1 -0
  380. package/dist/md/cli/index.js +99 -0
  381. package/dist/md/cli/index.js.map +1 -0
  382. package/dist/md/cli/lint.d.ts +11 -0
  383. package/dist/md/cli/lint.d.ts.map +1 -0
  384. package/dist/md/cli/lint.js +165 -0
  385. package/dist/md/cli/lint.js.map +1 -0
  386. package/dist/md/cli/list.d.ts +16 -0
  387. package/dist/md/cli/list.d.ts.map +1 -0
  388. package/dist/md/cli/list.js +85 -0
  389. package/dist/md/cli/list.js.map +1 -0
  390. package/dist/md/cli/program.d.ts +11 -0
  391. package/dist/md/cli/program.d.ts.map +1 -0
  392. package/dist/md/cli/program.js +104 -0
  393. package/dist/md/cli/program.js.map +1 -0
  394. package/dist/md/cli/validate.d.ts +8 -0
  395. package/dist/md/cli/validate.d.ts.map +1 -0
  396. package/dist/md/cli/validate.js +82 -0
  397. package/dist/md/cli/validate.js.map +1 -0
  398. package/dist/md/constants.d.ts +69 -0
  399. package/dist/md/constants.d.ts.map +1 -0
  400. package/dist/md/constants.js +69 -0
  401. package/dist/md/constants.js.map +1 -0
  402. package/dist/md/extractor/index.d.ts +57 -0
  403. package/dist/md/extractor/index.d.ts.map +1 -0
  404. package/dist/md/extractor/index.js +359 -0
  405. package/dist/md/extractor/index.js.map +1 -0
  406. package/dist/md/index.d.ts +26 -0
  407. package/dist/md/index.d.ts.map +1 -0
  408. package/dist/md/index.js +30 -0
  409. package/dist/md/index.js.map +1 -0
  410. package/dist/md/linter/index.d.ts +20 -0
  411. package/dist/md/linter/index.d.ts.map +1 -0
  412. package/dist/md/linter/index.js +412 -0
  413. package/dist/md/linter/index.js.map +1 -0
  414. package/dist/md/linter/token-optimizer.d.ts +66 -0
  415. package/dist/md/linter/token-optimizer.d.ts.map +1 -0
  416. package/dist/md/linter/token-optimizer.js +292 -0
  417. package/dist/md/linter/token-optimizer.js.map +1 -0
  418. package/dist/md/lister/index.d.ts +42 -0
  419. package/dist/md/lister/index.d.ts.map +1 -0
  420. package/dist/md/lister/index.js +317 -0
  421. package/dist/md/lister/index.js.map +1 -0
  422. package/dist/md/parser/heading-numbers.d.ts +43 -0
  423. package/dist/md/parser/heading-numbers.d.ts.map +1 -0
  424. package/dist/md/parser/heading-numbers.js +97 -0
  425. package/dist/md/parser/heading-numbers.js.map +1 -0
  426. package/dist/md/parser/section-meta.d.ts +50 -0
  427. package/dist/md/parser/section-meta.d.ts.map +1 -0
  428. package/dist/md/parser/section-meta.js +212 -0
  429. package/dist/md/parser/section-meta.js.map +1 -0
  430. package/dist/md/parser/template.d.ts +56 -0
  431. package/dist/md/parser/template.d.ts.map +1 -0
  432. package/dist/md/parser/template.js +122 -0
  433. package/dist/md/parser/template.js.map +1 -0
  434. package/dist/md/plugins/loader.d.ts +15 -0
  435. package/dist/md/plugins/loader.d.ts.map +1 -0
  436. package/dist/md/plugins/loader.js +80 -0
  437. package/dist/md/plugins/loader.js.map +1 -0
  438. package/dist/md/plugins/normalize-headings.d.ts +43 -0
  439. package/dist/md/plugins/normalize-headings.d.ts.map +1 -0
  440. package/dist/md/plugins/normalize-headings.js +51 -0
  441. package/dist/md/plugins/normalize-headings.js.map +1 -0
  442. package/dist/md/plugins/normalize-whitespace.d.ts +46 -0
  443. package/dist/md/plugins/normalize-whitespace.d.ts.map +1 -0
  444. package/dist/md/plugins/normalize-whitespace.js +86 -0
  445. package/dist/md/plugins/normalize-whitespace.js.map +1 -0
  446. package/dist/md/plugins/remove-badges.d.ts +36 -0
  447. package/dist/md/plugins/remove-badges.d.ts.map +1 -0
  448. package/dist/md/plugins/remove-badges.js +59 -0
  449. package/dist/md/plugins/remove-badges.js.map +1 -0
  450. package/dist/md/plugins/remove-comments.d.ts +27 -0
  451. package/dist/md/plugins/remove-comments.d.ts.map +1 -0
  452. package/dist/md/plugins/remove-comments.js +40 -0
  453. package/dist/md/plugins/remove-comments.js.map +1 -0
  454. package/dist/md/plugins/remove-duplicates.d.ts +40 -0
  455. package/dist/md/plugins/remove-duplicates.d.ts.map +1 -0
  456. package/dist/md/plugins/remove-duplicates.js +72 -0
  457. package/dist/md/plugins/remove-duplicates.js.map +1 -0
  458. package/dist/md/plugins/remove-internal-links.d.ts +38 -0
  459. package/dist/md/plugins/remove-internal-links.d.ts.map +1 -0
  460. package/dist/md/plugins/remove-internal-links.js +66 -0
  461. package/dist/md/plugins/remove-internal-links.js.map +1 -0
  462. package/dist/md/plugins/strip-heading-numbers.d.ts +35 -0
  463. package/dist/md/plugins/strip-heading-numbers.d.ts.map +1 -0
  464. package/dist/md/plugins/strip-heading-numbers.js +59 -0
  465. package/dist/md/plugins/strip-heading-numbers.js.map +1 -0
  466. package/dist/md/plugins/strip-section-meta.d.ts +37 -0
  467. package/dist/md/plugins/strip-section-meta.d.ts.map +1 -0
  468. package/dist/md/plugins/strip-section-meta.js +62 -0
  469. package/dist/md/plugins/strip-section-meta.js.map +1 -0
  470. package/dist/md/types/config.d.ts +260 -0
  471. package/dist/md/types/config.d.ts.map +1 -0
  472. package/dist/md/types/config.js +156 -0
  473. package/dist/md/types/config.js.map +1 -0
  474. package/dist/md/types/document.d.ts +37 -0
  475. package/dist/md/types/document.d.ts.map +1 -0
  476. package/dist/md/types/document.js +2 -0
  477. package/dist/md/types/document.js.map +1 -0
  478. package/dist/md/types/validation.d.ts +107 -0
  479. package/dist/md/types/validation.d.ts.map +1 -0
  480. package/dist/md/types/validation.js +2 -0
  481. package/dist/md/types/validation.js.map +1 -0
  482. package/dist/md/utils/code-blocks.d.ts +136 -0
  483. package/dist/md/utils/code-blocks.d.ts.map +1 -0
  484. package/dist/md/utils/code-blocks.js +178 -0
  485. package/dist/md/utils/code-blocks.js.map +1 -0
  486. package/dist/md/utils/config.d.ts +10 -0
  487. package/dist/md/utils/config.d.ts.map +1 -0
  488. package/dist/md/utils/config.js +99 -0
  489. package/dist/md/utils/config.js.map +1 -0
  490. package/dist/md/utils/file-collector.d.ts +78 -0
  491. package/dist/md/utils/file-collector.d.ts.map +1 -0
  492. package/dist/md/utils/file-collector.js +100 -0
  493. package/dist/md/utils/file-collector.js.map +1 -0
  494. package/dist/md/utils/markdown.d.ts +18 -0
  495. package/dist/md/utils/markdown.d.ts.map +1 -0
  496. package/dist/md/utils/markdown.js +93 -0
  497. package/dist/md/utils/markdown.js.map +1 -0
  498. package/dist/md/utils/remark.d.ts +91 -0
  499. package/dist/md/utils/remark.d.ts.map +1 -0
  500. package/dist/md/utils/remark.js +125 -0
  501. package/dist/md/utils/remark.js.map +1 -0
  502. package/dist/md/utils/tokens.d.ts +9 -0
  503. package/dist/md/utils/tokens.d.ts.map +1 -0
  504. package/dist/md/utils/tokens.js +31 -0
  505. package/dist/md/utils/tokens.js.map +1 -0
  506. package/dist/md/validator/index.d.ts +40 -0
  507. package/dist/md/validator/index.d.ts.map +1 -0
  508. package/dist/md/validator/index.js +289 -0
  509. package/dist/md/validator/index.js.map +1 -0
  510. package/dist/parsers/details-jsdoc.d.ts +46 -0
  511. package/dist/parsers/details-jsdoc.d.ts.map +1 -0
  512. package/dist/parsers/details-jsdoc.js +262 -0
  513. package/dist/parsers/details-jsdoc.js.map +1 -0
  514. package/dist/parsers/details-zod.d.ts +22 -0
  515. package/dist/parsers/details-zod.d.ts.map +1 -0
  516. package/dist/parsers/details-zod.js +145 -0
  517. package/dist/parsers/details-zod.js.map +1 -0
  518. package/dist/parsers/drizzle-schema.d.ts +92 -0
  519. package/dist/parsers/drizzle-schema.d.ts.map +1 -0
  520. package/dist/parsers/drizzle-schema.js +376 -0
  521. package/dist/parsers/drizzle-schema.js.map +1 -0
  522. package/dist/parsers/feature-map-tags.d.ts +45 -0
  523. package/dist/parsers/feature-map-tags.d.ts.map +1 -0
  524. package/dist/parsers/feature-map-tags.js +292 -0
  525. package/dist/parsers/feature-map-tags.js.map +1 -0
  526. package/dist/parsers/feature-map-type-extraction.d.ts +62 -0
  527. package/dist/parsers/feature-map-type-extraction.d.ts.map +1 -0
  528. package/dist/parsers/feature-map-type-extraction.js +347 -0
  529. package/dist/parsers/feature-map-type-extraction.js.map +1 -0
  530. package/dist/parsers/feature-map-utils.d.ts +34 -0
  531. package/dist/parsers/feature-map-utils.d.ts.map +1 -0
  532. package/dist/parsers/feature-map-utils.js +101 -0
  533. package/dist/parsers/feature-map-utils.js.map +1 -0
  534. package/dist/parsers/jsdoc-common.d.ts +209 -0
  535. package/dist/parsers/jsdoc-common.d.ts.map +1 -0
  536. package/dist/parsers/jsdoc-common.js +655 -0
  537. package/dist/parsers/jsdoc-common.js.map +1 -0
  538. package/dist/parsers/jsdoc.d.ts +76 -0
  539. package/dist/parsers/jsdoc.d.ts.map +1 -0
  540. package/dist/parsers/jsdoc.js +238 -0
  541. package/dist/parsers/jsdoc.js.map +1 -0
  542. package/dist/parsers/screenshot-annotations.d.ts +96 -0
  543. package/dist/parsers/screenshot-annotations.d.ts.map +1 -0
  544. package/dist/parsers/screenshot-annotations.js +227 -0
  545. package/dist/parsers/screenshot-annotations.js.map +1 -0
  546. package/dist/parsers/test-annotations.d.ts +46 -0
  547. package/dist/parsers/test-annotations.d.ts.map +1 -0
  548. package/dist/parsers/test-annotations.js +393 -0
  549. package/dist/parsers/test-annotations.js.map +1 -0
  550. package/dist/parsers/test-categorization.d.ts +42 -0
  551. package/dist/parsers/test-categorization.d.ts.map +1 -0
  552. package/dist/parsers/test-categorization.js +182 -0
  553. package/dist/parsers/test-categorization.js.map +1 -0
  554. package/dist/parsers/zod-schema.d.ts +105 -0
  555. package/dist/parsers/zod-schema.d.ts.map +1 -0
  556. package/dist/parsers/zod-schema.js +270 -0
  557. package/dist/parsers/zod-schema.js.map +1 -0
  558. package/dist/utils/action-inference.d.ts +23 -0
  559. package/dist/utils/action-inference.d.ts.map +1 -0
  560. package/dist/utils/action-inference.js +36 -0
  561. package/dist/utils/action-inference.js.map +1 -0
  562. package/dist/utils/app-inference.d.ts +31 -0
  563. package/dist/utils/app-inference.d.ts.map +1 -0
  564. package/dist/utils/app-inference.js +41 -0
  565. package/dist/utils/app-inference.js.map +1 -0
  566. package/dist/utils/auto-infer.d.ts +93 -0
  567. package/dist/utils/auto-infer.d.ts.map +1 -0
  568. package/dist/utils/auto-infer.js +184 -0
  569. package/dist/utils/auto-infer.js.map +1 -0
  570. package/dist/utils/config.d.ts +709 -0
  571. package/dist/utils/config.d.ts.map +1 -0
  572. package/dist/utils/config.js +504 -0
  573. package/dist/utils/config.js.map +1 -0
  574. package/dist/utils/file.d.ts +46 -0
  575. package/dist/utils/file.d.ts.map +1 -0
  576. package/dist/utils/file.js +103 -0
  577. package/dist/utils/file.js.map +1 -0
  578. package/dist/utils/formatters.d.ts +111 -0
  579. package/dist/utils/formatters.d.ts.map +1 -0
  580. package/dist/utils/formatters.js +164 -0
  581. package/dist/utils/formatters.js.map +1 -0
  582. package/dist/utils/gh-config.d.ts +99 -0
  583. package/dist/utils/gh-config.d.ts.map +1 -0
  584. package/dist/utils/gh-config.js +247 -0
  585. package/dist/utils/gh-config.js.map +1 -0
  586. package/dist/utils/github.d.ts +98 -0
  587. package/dist/utils/github.d.ts.map +1 -0
  588. package/dist/utils/github.js +295 -0
  589. package/dist/utils/github.js.map +1 -0
  590. package/dist/utils/html.d.ts +107 -0
  591. package/dist/utils/html.d.ts.map +1 -0
  592. package/dist/utils/html.js +376 -0
  593. package/dist/utils/html.js.map +1 -0
  594. package/dist/utils/i18n.d.ts +40 -0
  595. package/dist/utils/i18n.d.ts.map +1 -0
  596. package/dist/utils/i18n.js +148 -0
  597. package/dist/utils/i18n.js.map +1 -0
  598. package/dist/utils/logger.d.ts +20 -0
  599. package/dist/utils/logger.d.ts.map +1 -0
  600. package/dist/utils/logger.js +49 -0
  601. package/dist/utils/logger.js.map +1 -0
  602. package/dist/utils/project-fields.d.ts +71 -0
  603. package/dist/utils/project-fields.d.ts.map +1 -0
  604. package/dist/utils/project-fields.js +318 -0
  605. package/dist/utils/project-fields.js.map +1 -0
  606. package/dist/utils/repo-pairs.d.ts +94 -0
  607. package/dist/utils/repo-pairs.d.ts.map +1 -0
  608. package/dist/utils/repo-pairs.js +196 -0
  609. package/dist/utils/repo-pairs.js.map +1 -0
  610. package/dist/utils/route-inference.d.ts +81 -0
  611. package/dist/utils/route-inference.d.ts.map +1 -0
  612. package/dist/utils/route-inference.js +137 -0
  613. package/dist/utils/route-inference.js.map +1 -0
  614. package/dist/utils/setup-check.d.ts +34 -0
  615. package/dist/utils/setup-check.d.ts.map +1 -0
  616. package/dist/utils/setup-check.js +136 -0
  617. package/dist/utils/setup-check.js.map +1 -0
  618. package/dist/utils/shirokumaignore.d.ts +55 -0
  619. package/dist/utils/shirokumaignore.d.ts.map +1 -0
  620. package/dist/utils/shirokumaignore.js +94 -0
  621. package/dist/utils/shirokumaignore.js.map +1 -0
  622. package/dist/utils/skills-repo.d.ts +353 -0
  623. package/dist/utils/skills-repo.d.ts.map +1 -0
  624. package/dist/utils/skills-repo.js +793 -0
  625. package/dist/utils/skills-repo.js.map +1 -0
  626. package/dist/utils/status-workflow.d.ts +54 -0
  627. package/dist/utils/status-workflow.d.ts.map +1 -0
  628. package/dist/utils/status-workflow.js +103 -0
  629. package/dist/utils/status-workflow.js.map +1 -0
  630. package/dist/validators/frontmatter.d.ts +41 -0
  631. package/dist/validators/frontmatter.d.ts.map +1 -0
  632. package/dist/validators/frontmatter.js +117 -0
  633. package/dist/validators/frontmatter.js.map +1 -0
  634. package/dist/validators/link-checker.d.ts +48 -0
  635. package/dist/validators/link-checker.d.ts.map +1 -0
  636. package/dist/validators/link-checker.js +108 -0
  637. package/dist/validators/link-checker.js.map +1 -0
  638. package/dist/validators/markdown-structure.d.ts +50 -0
  639. package/dist/validators/markdown-structure.d.ts.map +1 -0
  640. package/dist/validators/markdown-structure.js +253 -0
  641. package/dist/validators/markdown-structure.js.map +1 -0
  642. package/i18n/cli/en.json +155 -0
  643. package/i18n/cli/ja.json +155 -0
  644. package/i18n/discussion/en.json +191 -0
  645. package/i18n/discussion/ja.json +191 -0
  646. package/package.json +113 -0
  647. package/portal/app/api-tools/api-tools-client.tsx +411 -0
  648. package/portal/app/api-tools/api-tools-document.tsx +240 -0
  649. package/portal/app/api-tools/page.tsx +56 -0
  650. package/portal/app/api-tools/swagger-view.tsx +114 -0
  651. package/portal/app/apps/[appId]/[type]/[module]/[item]/item-tabs-client.tsx +71 -0
  652. package/portal/app/apps/[appId]/[type]/[module]/[item]/page.tsx +1422 -0
  653. package/portal/app/apps/[appId]/[type]/[module]/page.tsx +373 -0
  654. package/portal/app/apps/[appId]/feature-map/feature-map-app-document.tsx +298 -0
  655. package/portal/app/apps/[appId]/feature-map/page.tsx +224 -0
  656. package/portal/app/apps/[appId]/i18n/page.tsx +139 -0
  657. package/portal/app/apps/[appId]/test-cases/page.tsx +840 -0
  658. package/portal/app/apps/[appId]/tools/[tool]/page.tsx +351 -0
  659. package/portal/app/apps/[appId]/tools/api-tools-client.tsx +429 -0
  660. package/portal/app/apps/[appId]/tools/page.tsx +119 -0
  661. package/portal/app/db-schema/[db]/[table]/page.tsx +235 -0
  662. package/portal/app/db-schema/[db]/diagram/page.tsx +81 -0
  663. package/portal/app/db-schema/[db]/page.tsx +148 -0
  664. package/portal/app/db-schema/db-schema-document.tsx +100 -0
  665. package/portal/app/db-schema/diagram/client.tsx +211 -0
  666. package/portal/app/db-schema/diagram/page.tsx +20 -0
  667. package/portal/app/db-schema/page.tsx +145 -0
  668. package/portal/app/db-schema/table-detail-document.tsx +710 -0
  669. package/portal/app/db-schema/table-detail.tsx +747 -0
  670. package/portal/app/db-schema/table-list-document.tsx +224 -0
  671. package/portal/app/db-schema/table-list.tsx +247 -0
  672. package/portal/app/details/[type]/[module]/[item]/item-tabs-client.tsx +71 -0
  673. package/portal/app/details/[type]/[module]/[item]/page.tsx +1286 -0
  674. package/portal/app/details/[type]/[module]/page.tsx +884 -0
  675. package/portal/app/feature-map/feature-map-client.tsx +681 -0
  676. package/portal/app/feature-map/feature-map-document.tsx +313 -0
  677. package/portal/app/feature-map/page.tsx +438 -0
  678. package/portal/app/globals.css +205 -0
  679. package/portal/app/i18n/[...namespace]/page.tsx +190 -0
  680. package/portal/app/i18n/i18n-client.tsx +369 -0
  681. package/portal/app/i18n/page.tsx +339 -0
  682. package/portal/app/layout.tsx +37 -0
  683. package/portal/app/overview/page.tsx +65 -0
  684. package/portal/app/packages/[packageId]/page.tsx +201 -0
  685. package/portal/app/packages/page.tsx +148 -0
  686. package/portal/app/page.tsx +568 -0
  687. package/portal/app/test-cases/[file]/[line]/page.tsx +455 -0
  688. package/portal/app/test-cases/[file]/[line]/test-detail-document.tsx +335 -0
  689. package/portal/app/test-cases/[file]/page.tsx +323 -0
  690. package/portal/app/test-cases/[file]/test-file-document.tsx +335 -0
  691. package/portal/app/test-cases/page.tsx +546 -0
  692. package/portal/app/test-cases/test-cases-document.tsx +384 -0
  693. package/portal/components/code-block.tsx +57 -0
  694. package/portal/components/document/doc-params-table.tsx +71 -0
  695. package/portal/components/document/doc-section.tsx +133 -0
  696. package/portal/components/document/doc-table.tsx +119 -0
  697. package/portal/components/document/index.ts +9 -0
  698. package/portal/components/drawflow-er-diagram.tsx +607 -0
  699. package/portal/components/interactive-er-diagram.tsx +228 -0
  700. package/portal/components/layout/app-sidebar.tsx +490 -0
  701. package/portal/components/layout/er-sidebar.tsx +116 -0
  702. package/portal/components/layout/global-header.tsx +117 -0
  703. package/portal/components/layout/layout-content.tsx +48 -0
  704. package/portal/components/markdown-content.tsx +120 -0
  705. package/portal/components/mermaid-diagram.tsx +83 -0
  706. package/portal/components/reactflow-er-diagram.tsx +475 -0
  707. package/portal/components/search-dialog.tsx +268 -0
  708. package/portal/components/shared/coverage-score-bar.tsx +144 -0
  709. package/portal/components/swagger/endpoint-accordion.tsx +117 -0
  710. package/portal/components/swagger/index.ts +7 -0
  711. package/portal/components/swagger/method-badge.tsx +55 -0
  712. package/portal/components/swagger/params-table.tsx +78 -0
  713. package/portal/components/tabs-with-hash.tsx +43 -0
  714. package/portal/components/test/index.ts +2 -0
  715. package/portal/components/test/test-bdd-card.tsx +192 -0
  716. package/portal/components/test/test-matrix.tsx +242 -0
  717. package/portal/components/ui/accordion.tsx +66 -0
  718. package/portal/components/ui/badge.tsx +46 -0
  719. package/portal/components/ui/breadcrumb.tsx +109 -0
  720. package/portal/components/ui/button.tsx +62 -0
  721. package/portal/components/ui/card.tsx +92 -0
  722. package/portal/components/ui/collapsible.tsx +33 -0
  723. package/portal/components/ui/dialog.tsx +118 -0
  724. package/portal/components/ui/progress.tsx +28 -0
  725. package/portal/components/ui/scroll-area.tsx +58 -0
  726. package/portal/components/ui/sheet.tsx +139 -0
  727. package/portal/components/ui/table.tsx +116 -0
  728. package/portal/components/ui/tabs.tsx +66 -0
  729. package/portal/components.json +21 -0
  730. package/portal/lib/constants/test-categories.ts +186 -0
  731. package/portal/lib/data-loader.ts +1181 -0
  732. package/portal/lib/db-schema-utils.ts +182 -0
  733. package/portal/lib/format.ts +43 -0
  734. package/portal/lib/hooks/use-hash-tab.ts +144 -0
  735. package/portal/lib/path-utils.ts +25 -0
  736. package/portal/lib/search-index-generator.ts +214 -0
  737. package/portal/lib/search.ts +126 -0
  738. package/portal/lib/sidebar-context.tsx +111 -0
  739. package/portal/lib/types.ts +740 -0
  740. package/portal/lib/utils.ts +6 -0
  741. package/portal/next.config.ts +21 -0
  742. package/portal/package.json +45 -0
  743. package/portal/postcss.config.mjs +8 -0
  744. package/portal/tsconfig.json +41 -0
  745. package/portal/types/drawflow.d.ts +80 -0
  746. package/templates/README.md +73 -0
  747. package/templates/coverage.html +367 -0
  748. package/templates/dark-theme.css +443 -0
  749. package/templates/discussion/adr.yml.hbs +65 -0
  750. package/templates/discussion/handovers.yml.hbs +57 -0
  751. package/templates/discussion/knowledge.yml.hbs +60 -0
  752. package/templates/discussion/reports.yml.hbs +68 -0
  753. package/templates/discussion/research.yml.hbs +61 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 ShirokumaLibrary
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.en.md ADDED
@@ -0,0 +1,308 @@
1
+ # shirokuma-docs
2
+
3
+ Next.js + TypeScript project documentation generator CLI with bundled Claude Code skills.
4
+
5
+ [日本語](README.md)
6
+
7
+ ## Installation
8
+
9
+ ### Recommended: Installer Script (No sudo required)
10
+
11
+ ```bash
12
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash
13
+ ```
14
+
15
+ To pre-select a language:
16
+
17
+ ```bash
18
+ # Japanese
19
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash -s -- --lang ja
20
+
21
+ # English
22
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash -s -- --lang en
23
+ ```
24
+
25
+ This installs shirokuma-docs to `~/.local/` with a symlink in `~/.local/bin/`. Claude Code users already have `~/.local/bin` in PATH.
26
+
27
+ ### Alternative: npm / pnpm global install
28
+
29
+ ```bash
30
+ # npm
31
+ npm install -g @shirokuma-library/shirokuma-docs
32
+
33
+ # pnpm
34
+ pnpm add -g @shirokuma-library/shirokuma-docs
35
+ ```
36
+
37
+ ### Verify Installation
38
+
39
+ ```bash
40
+ shirokuma-docs --version
41
+ # => 0.1.0-alpha.1
42
+ ```
43
+
44
+ ## Getting Started
45
+
46
+ ### 1. Initialize
47
+
48
+ ```bash
49
+ cd /path/to/your/project
50
+ shirokuma-docs init --with-skills --with-rules --lang en
51
+ ```
52
+
53
+ This creates `shirokuma-docs.config.yaml`, installs plugins, and deploys rules to `.claude/rules/shirokuma/`.
54
+
55
+ ### 2. Customize the Config
56
+
57
+ Open `shirokuma-docs.config.yaml` and edit paths to match your project structure:
58
+
59
+ ```yaml
60
+ project:
61
+ name: "MyProject" # Your project name
62
+ description: "..."
63
+
64
+ typedoc:
65
+ entryPoints:
66
+ - "./src/lib/actions" # Change to your source paths
67
+ - "./src/db/schema"
68
+ tsconfig: "./tsconfig.json"
69
+
70
+ schema:
71
+ sources:
72
+ - path: "./src/db/schema" # Drizzle ORM schema path
73
+ ```
74
+
75
+ **Don't use Drizzle ORM?** Delete the `schema` section entirely.
76
+ Other optional sections (`deps`, `testCases`, `lintDocs`, etc.) can be removed if not needed — only configured sections run with `generate`.
77
+
78
+ ### 3. Generate Documentation
79
+
80
+ ```bash
81
+ # Run all configured commands
82
+ shirokuma-docs generate
83
+
84
+ # Or run individually
85
+ shirokuma-docs test-cases -p .
86
+ shirokuma-docs deps -p .
87
+ shirokuma-docs portal -p .
88
+ ```
89
+
90
+ ### 4. Start Using with Claude Code
91
+
92
+ Start a new Claude Code session. Skills will be available as slash commands (e.g., `/working-on-issue #42`).
93
+
94
+ See [Getting Started Guide](docs/guide/getting-started.md) for detailed setup instructions.
95
+
96
+ ## Upgrade
97
+
98
+ ```bash
99
+ # Step 1: Update CLI
100
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash
101
+ # or: npm update -g @shirokuma-library/shirokuma-docs
102
+
103
+ # Step 2: Update plugins, rules, and cache
104
+ cd /path/to/your/project
105
+ shirokuma-docs update
106
+
107
+ # Step 3: Start a new Claude Code session
108
+ ```
109
+
110
+ ### Troubleshooting
111
+
112
+ If skills don't update after `shirokuma-docs update`:
113
+
114
+ ```bash
115
+ # Force cache refresh
116
+ claude plugin uninstall shirokuma-skills-en@shirokuma-library --scope project
117
+ claude plugin install shirokuma-skills-en@shirokuma-library --scope project
118
+ ```
119
+
120
+ ## Uninstall
121
+
122
+ ```bash
123
+ # If installed via install.sh
124
+ rm -f ~/.local/bin/shirokuma-docs
125
+ rm -rf ~/.local/share/shirokuma-docs
126
+
127
+ # If installed via npm
128
+ npm uninstall -g @shirokuma-library/shirokuma-docs
129
+ ```
130
+
131
+ To remove per-project files:
132
+
133
+ ```bash
134
+ # Remove deployed rules and config
135
+ rm -rf .claude/rules/shirokuma/
136
+ rm -f shirokuma-docs.config.yaml
137
+
138
+ # Remove plugins from global cache
139
+ claude plugin uninstall shirokuma-skills-en@shirokuma-library --scope project
140
+ claude plugin uninstall shirokuma-hooks@shirokuma-library --scope project
141
+ ```
142
+
143
+ ## Features
144
+
145
+ ### Documentation Generation (16 commands)
146
+
147
+ | Command | Description |
148
+ |---------|-------------|
149
+ | `typedoc` | TypeDoc API documentation |
150
+ | `schema` | Drizzle ORM to DBML/SVG ER diagrams |
151
+ | `deps` | Dependency graph (dependency-cruiser) |
152
+ | `test-cases` | Jest/Playwright test case extraction |
153
+ | `coverage` | Jest coverage dashboard |
154
+ | `portal` | Dark-themed HTML documentation portal |
155
+ | `search-index` | Full-text search JSON index |
156
+ | `overview` | Project overview page |
157
+ | `feature-map` | Feature hierarchy map (4-layer) |
158
+ | `link-docs` | API-test bidirectional links |
159
+ | `screenshots` | Playwright screenshot generation |
160
+ | `details` | Entity detail pages (Screen, Component, Action, Table) |
161
+ | `impact` | Change impact analysis |
162
+ | `api-tools` | MCP tool documentation |
163
+ | `i18n` | i18n translation file documentation |
164
+ | `packages` | Monorepo shared package documentation |
165
+
166
+ ### Validation (7 commands)
167
+
168
+ | Command | Description |
169
+ |---------|-------------|
170
+ | `lint-tests` | @testdoc comment quality check |
171
+ | `lint-coverage` | Implementation-test correspondence check |
172
+ | `lint-docs` | Document structure validation |
173
+ | `lint-code` | Code annotation / structure validation |
174
+ | `lint-annotations` | Annotation consistency validation |
175
+ | `lint-structure` | Project structure validation |
176
+ | `lint-workflow` | AI workflow convention validation |
177
+
178
+ ### GitHub Integration (5 commands)
179
+
180
+ | Command | Description |
181
+ |---------|-------------|
182
+ | `issues` | GitHub Issues management (Projects field integration) |
183
+ | `projects` | GitHub Projects V2 management |
184
+ | `discussions` | GitHub Discussions management |
185
+ | `repo` | Repository info / label management |
186
+ | `discussion-templates` | Discussion form template generation (i18n) |
187
+
188
+ ### Session Management
189
+
190
+ | Command | Description |
191
+ |---------|-------------|
192
+ | `session start` | Start session (handover + issues + PRs) |
193
+ | `session end` | End session (save handover + status update) |
194
+ | `session check` | Issue-Project status consistency check (`--fix` for auto-repair) |
195
+
196
+ ### Management & Utilities
197
+
198
+ | Command | Description |
199
+ |---------|-------------|
200
+ | `init` | Initialize config (with `--with-skills --with-rules` support) |
201
+ | `generate` | Run all generation commands |
202
+ | `update` | Update skills, rules, and cache (shorthand for `update-skills --sync`) |
203
+ | `update-skills` | Update skills/rules with detailed options |
204
+ | `adr` | ADR management (GitHub Discussions integration) |
205
+ | `repo-pairs` | Public/Private repository pair management |
206
+ | `github-data` | GitHub data JSON generation |
207
+ | `md` | LLM-optimized Markdown management (build, validate, analyze, lint, list, extract) |
208
+
209
+ ## Claude Code Integration
210
+
211
+ shirokuma-docs bundles the **shirokuma-skills** plugin (EN/JA), which provides skills, agents, and rules for Claude Code.
212
+
213
+ ### Key Skills (22 total)
214
+
215
+ Invoke any skill as a slash command: `/<skill-name>` (e.g., `/committing-on-issue`, `/working-on-issue #42`).
216
+
217
+ | Category | Skill | Purpose |
218
+ |----------|-------|---------|
219
+ | **Orchestration** | `working-on-issue` | Work dispatcher (entry point) |
220
+ | | `planning-on-issue` | Issue planning phase |
221
+ | **Session** | `starting-session` | Start work session |
222
+ | | `ending-session` | End session with handover |
223
+ | **Development** | `nextjs-vibe-coding` | TDD implementation for Next.js |
224
+ | | `frontend-designing` | Distinctive UI design |
225
+ | | `codebase-rule-discovery` | Pattern discovery + convention proposal |
226
+ | | `reviewing-on-issue` | Code / security review |
227
+ | | `best-practices-researching` | Research best practices |
228
+ | | `claude-config-reviewing` | Config file quality check |
229
+ | **Git / GitHub** | `committing-on-issue` | Stage, commit, push |
230
+ | | `creating-pr-on-issue` | Create pull request |
231
+ | | `managing-github-items` | Issue / Discussion creation |
232
+ | | `showing-github` | Display project data / dashboard |
233
+ | | `github-project-setup` | Project initial setup |
234
+ | **Config** | `managing-skills` | Create / update skills |
235
+ | | `managing-agents` | Create / update agents |
236
+ | | `managing-rules` | Create / update rules |
237
+ | | `managing-plugins` | Create / update plugins |
238
+ | | `managing-output-styles` | Manage output styles |
239
+ | **Other** | `project-config-generator` | Generate project config files |
240
+ | | `publishing` | Public release via repo-pairs |
241
+
242
+ ### Rules (21 total)
243
+
244
+ Deployed to `.claude/rules/shirokuma/`, covering:
245
+ - Git commit style and branch workflow
246
+ - GitHub project item management and Discussion usage
247
+ - Next.js best practices (tech stack, known issues, testing, Tailwind v4)
248
+ - shirokuma-docs CLI usage and plugin cache management
249
+ - Memory operations and config authoring
250
+
251
+ ## Configuration
252
+
253
+ `shirokuma-docs init` generates `shirokuma-docs.config.yaml` with all available sections. Each section includes inline comments explaining what it does and how to customize it.
254
+
255
+ | Section | Purpose | Required |
256
+ |---------|---------|----------|
257
+ | `project` | Project name and description | Yes |
258
+ | `output` | Output directories | Yes |
259
+ | `typedoc` | TypeDoc API documentation | No |
260
+ | `schema` | Drizzle ORM ER diagrams | No |
261
+ | `deps` | Dependency graph | No |
262
+ | `testCases` | Test case extraction (Jest/Playwright) | No |
263
+ | `portal` | Documentation portal | No |
264
+ | `lintDocs` / `lintCode` / `lintStructure` | Validation rules | No |
265
+ | `github` | GitHub Projects / Discussions integration | No |
266
+ | `adr` | Architecture Decision Records | No |
267
+
268
+ Remove any section you don't need — only configured sections are active. See [Configuration Reference](docs/guide/config.md) for the full schema.
269
+
270
+ ## Output Structure
271
+
272
+ ```
273
+ docs/
274
+ ├── portal/
275
+ │ ├── index.html # Portal top page
276
+ │ ├── viewer.html # Markdown/DBML/SVG viewer
277
+ │ └── test-cases.html # Test case list
278
+ └── generated/
279
+ ├── api/ # TypeDoc Markdown
280
+ ├── api-html/ # TypeDoc HTML
281
+ ├── schema/
282
+ │ ├── schema.dbml
283
+ │ └── schema-docs.md
284
+ ├── dependencies.svg
285
+ ├── dependencies.html
286
+ └── test-cases.md
287
+ ```
288
+
289
+ ## Requirements
290
+
291
+ - **Node.js**: 20.0.0+
292
+ - **Claude Code**: For skills/rules integration
293
+ - **gh CLI**: For GitHub commands (`gh auth login` required)
294
+
295
+ ### Optional Dependencies
296
+
297
+ | Tool | Purpose | Install |
298
+ |------|---------|---------|
299
+ | graphviz | Dependency graph SVG | `apt install graphviz` |
300
+ | typedoc | API documentation | `npm i -D typedoc typedoc-plugin-markdown` |
301
+ | dependency-cruiser | Dependency analysis | `npm i -D dependency-cruiser` |
302
+ | drizzle-dbml-generator | DBML generation | `npm i -D drizzle-dbml-generator` |
303
+
304
+ ## License
305
+
306
+ MIT
307
+
308
+ See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for third-party license information.
package/README.md ADDED
@@ -0,0 +1,308 @@
1
+ # shirokuma-docs
2
+
3
+ Next.js + TypeScript プロジェクト向けのドキュメント自動生成 CLI。Claude Code スキル同梱。
4
+
5
+ [English](README.en.md)
6
+
7
+ ## インストール
8
+
9
+ ### 推奨: インストーラスクリプト(sudo 不要)
10
+
11
+ ```bash
12
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash
13
+ ```
14
+
15
+ 言語を事前に指定する場合:
16
+
17
+ ```bash
18
+ # 日本語
19
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash -s -- --lang ja
20
+
21
+ # 英語
22
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash -s -- --lang en
23
+ ```
24
+
25
+ `~/.local/` にインストールされます。Claude Code ユーザーは `~/.local/bin` が PATH に含まれているため追加設定不要です。
26
+
27
+ ### npm / pnpm でグローバルインストール
28
+
29
+ ```bash
30
+ # npm
31
+ npm install -g @shirokuma-library/shirokuma-docs
32
+
33
+ # pnpm
34
+ pnpm add -g @shirokuma-library/shirokuma-docs
35
+ ```
36
+
37
+ ### インストール確認
38
+
39
+ ```bash
40
+ shirokuma-docs --version
41
+ # => 0.1.0-alpha.1
42
+ ```
43
+
44
+ ## はじめかた
45
+
46
+ ### 1. 初期化
47
+
48
+ ```bash
49
+ cd /path/to/your/project
50
+ shirokuma-docs init --with-skills --with-rules --lang ja
51
+ ```
52
+
53
+ `shirokuma-docs.config.yaml` の作成、プラグインのインストール、`.claude/rules/shirokuma/` へのルールデプロイを一括で実行します。
54
+
55
+ ### 2. 設定ファイルのカスタマイズ
56
+
57
+ `shirokuma-docs.config.yaml` を開き、自分のプロジェクト構成に合わせてパスを編集します:
58
+
59
+ ```yaml
60
+ project:
61
+ name: "MyProject" # プロジェクト名
62
+ description: "..."
63
+
64
+ typedoc:
65
+ entryPoints:
66
+ - "./src/lib/actions" # ソースコードのパスに変更
67
+ - "./src/db/schema"
68
+ tsconfig: "./tsconfig.json"
69
+
70
+ schema:
71
+ sources:
72
+ - path: "./src/db/schema" # Drizzle ORM スキーマのパス
73
+ ```
74
+
75
+ **Drizzle ORM を使わない場合**は `schema` セクションをまるごと削除してください。
76
+ `deps`、`testCases`、`lintDocs` 等のオプションセクションも不要なら削除できます。`generate` 実行時は設定されたセクションのみ動作します。
77
+
78
+ ### 3. ドキュメント生成
79
+
80
+ ```bash
81
+ # 全コマンド一括実行
82
+ shirokuma-docs generate
83
+
84
+ # 個別実行
85
+ shirokuma-docs test-cases -p .
86
+ shirokuma-docs deps -p .
87
+ shirokuma-docs portal -p .
88
+ ```
89
+
90
+ ### 4. Claude Code との連携
91
+
92
+ 新しい Claude Code セッションを開始するとスキルが利用可能になります(例: `/working-on-issue #42`)。
93
+
94
+ 詳細は[はじめかたガイド](docs/guide/getting-started.md)を参照してください。
95
+
96
+ ## アップグレード
97
+
98
+ ```bash
99
+ # ステップ 1: CLI を更新
100
+ curl -fsSL https://raw.githubusercontent.com/ShirokumaLibrary/shirokuma-docs/main/install.sh | bash
101
+ # または: npm update -g @shirokuma-library/shirokuma-docs
102
+
103
+ # ステップ 2: プラグイン・ルール・キャッシュを更新
104
+ cd /path/to/your/project
105
+ shirokuma-docs update
106
+
107
+ # ステップ 3: 新しい Claude Code セッションを開始
108
+ ```
109
+
110
+ ### トラブルシューティング
111
+
112
+ `shirokuma-docs update` 後にスキルが更新されない場合:
113
+
114
+ ```bash
115
+ # キャッシュを強制リフレッシュ
116
+ claude plugin uninstall shirokuma-skills-ja@shirokuma-library --scope project
117
+ claude plugin install shirokuma-skills-ja@shirokuma-library --scope project
118
+ ```
119
+
120
+ ## アンインストール
121
+
122
+ ```bash
123
+ # インストーラスクリプト経由の場合
124
+ rm -f ~/.local/bin/shirokuma-docs
125
+ rm -rf ~/.local/share/shirokuma-docs
126
+
127
+ # npm 経由の場合
128
+ npm uninstall -g @shirokuma-library/shirokuma-docs
129
+ ```
130
+
131
+ プロジェクトごとのファイルを削除する場合:
132
+
133
+ ```bash
134
+ # ルールと設定ファイルを削除
135
+ rm -rf .claude/rules/shirokuma/
136
+ rm -f shirokuma-docs.config.yaml
137
+
138
+ # グローバルキャッシュからプラグインを削除
139
+ claude plugin uninstall shirokuma-skills-ja@shirokuma-library --scope project
140
+ claude plugin uninstall shirokuma-hooks@shirokuma-library --scope project
141
+ ```
142
+
143
+ ## 機能
144
+
145
+ ### ドキュメント生成(16 コマンド)
146
+
147
+ | コマンド | 説明 |
148
+ |---------|------|
149
+ | `typedoc` | TypeDoc API ドキュメント |
150
+ | `schema` | Drizzle ORM → DBML/SVG ER図 |
151
+ | `deps` | 依存関係グラフ(dependency-cruiser) |
152
+ | `test-cases` | Jest/Playwright テストケース抽出 |
153
+ | `coverage` | Jest カバレッジダッシュボード |
154
+ | `portal` | ダークテーマ HTML ドキュメントポータル |
155
+ | `search-index` | 全文検索用 JSON インデックス |
156
+ | `overview` | プロジェクト概要ページ |
157
+ | `feature-map` | 機能階層マップ(4層構造) |
158
+ | `link-docs` | API-テスト双方向リンク |
159
+ | `screenshots` | Playwright スクリーンショット生成 |
160
+ | `details` | 各要素の詳細ページ(Screen, Component, Action, Table) |
161
+ | `impact` | 変更影響分析 |
162
+ | `api-tools` | MCP ツールドキュメント |
163
+ | `i18n` | i18n 翻訳ファイルドキュメント |
164
+ | `packages` | モノレポ共有パッケージドキュメント |
165
+
166
+ ### 検証(7 コマンド)
167
+
168
+ | コマンド | 説明 |
169
+ |---------|------|
170
+ | `lint-tests` | @testdoc コメント品質チェック |
171
+ | `lint-coverage` | 実装-テスト対応チェック |
172
+ | `lint-docs` | ドキュメント構造検証 |
173
+ | `lint-code` | コードアノテーション・構造検証 |
174
+ | `lint-annotations` | アノテーション整合性検証 |
175
+ | `lint-structure` | プロジェクト構造検証 |
176
+ | `lint-workflow` | AI ワークフロー規約検証 |
177
+
178
+ ### GitHub 連携(5 コマンド)
179
+
180
+ | コマンド | 説明 |
181
+ |---------|------|
182
+ | `issues` | GitHub Issues 管理(Projects フィールド統合) |
183
+ | `projects` | GitHub Projects V2 管理 |
184
+ | `discussions` | GitHub Discussions 管理 |
185
+ | `repo` | リポジトリ情報・ラベル管理 |
186
+ | `discussion-templates` | Discussion テンプレート生成(多言語対応) |
187
+
188
+ ### セッション管理
189
+
190
+ | コマンド | 説明 |
191
+ |---------|------|
192
+ | `session start` | セッション開始(引き継ぎ + Issues + PRs 一括取得) |
193
+ | `session end` | セッション終了(引き継ぎ保存 + ステータス更新) |
194
+ | `session check` | Issue-Project ステータス整合性チェック(`--fix` で自動修正) |
195
+
196
+ ### 管理・ユーティリティ
197
+
198
+ | コマンド | 説明 |
199
+ |---------|------|
200
+ | `init` | 設定ファイル初期化(`--with-skills --with-rules` 対応) |
201
+ | `generate` | 全コマンド一括実行 |
202
+ | `update` | スキル・ルール・キャッシュ更新(`update-skills --sync` の短縮形) |
203
+ | `update-skills` | スキル・ルール更新(詳細オプション付き) |
204
+ | `adr` | ADR 管理(GitHub Discussions 連携) |
205
+ | `repo-pairs` | Public/Private リポジトリペア管理 |
206
+ | `github-data` | GitHub データ JSON 生成 |
207
+ | `md` | LLM 最適化 Markdown 管理(build, validate, analyze, lint, list, extract) |
208
+
209
+ ## Claude Code 連携
210
+
211
+ shirokuma-docs は **shirokuma-skills** プラグイン(EN/JA)を同梱しており、Claude Code 向けのスキル・エージェント・ルールを提供します。
212
+
213
+ ### 主要スキル(全 22 件)
214
+
215
+ スラッシュコマンドで起動: `/<skill-name>`(例: `/committing-on-issue`、`/working-on-issue #42`)
216
+
217
+ | カテゴリ | スキル | 用途 |
218
+ |---------|--------|------|
219
+ | **オーケストレーション** | `working-on-issue` | ワークディスパッチャー(エントリポイント) |
220
+ | | `planning-on-issue` | Issue 計画策定 |
221
+ | **セッション** | `starting-session` | 作業セッション開始 |
222
+ | | `ending-session` | セッション終了・引き継ぎ保存 |
223
+ | **開発** | `nextjs-vibe-coding` | Next.js 向け TDD 実装 |
224
+ | | `frontend-designing` | 印象的な UI デザイン |
225
+ | | `codebase-rule-discovery` | パターン発見・規約提案 |
226
+ | | `reviewing-on-issue` | コード / セキュリティレビュー |
227
+ | | `best-practices-researching` | ベストプラクティス調査 |
228
+ | | `claude-config-reviewing` | 設定ファイル品質チェック |
229
+ | **Git / GitHub** | `committing-on-issue` | ステージ・コミット・プッシュ |
230
+ | | `creating-pr-on-issue` | プルリクエスト作成 |
231
+ | | `managing-github-items` | Issue / Discussion 作成 |
232
+ | | `showing-github` | プロジェクトデータ表示 |
233
+ | | `github-project-setup` | プロジェクト初期セットアップ |
234
+ | **設定管理** | `managing-skills` | スキル作成・更新 |
235
+ | | `managing-agents` | エージェント作成・更新 |
236
+ | | `managing-rules` | ルール作成・更新 |
237
+ | | `managing-plugins` | プラグイン作成・更新 |
238
+ | | `managing-output-styles` | 出力スタイル管理 |
239
+ | **その他** | `project-config-generator` | プロジェクト設定ファイル生成 |
240
+ | | `publishing` | repo-pairs 経由のパブリックリリース |
241
+
242
+ ### ルール(全 21 件)
243
+
244
+ `.claude/rules/shirokuma/` にデプロイ。以下をカバー:
245
+ - Git コミットスタイルとブランチワークフロー
246
+ - GitHub プロジェクトアイテム管理と Discussion 活用
247
+ - Next.js ベストプラクティス(技術スタック、既知の問題、テスト、Tailwind v4)
248
+ - shirokuma-docs CLI 呼び出しとプラグインキャッシュ管理
249
+ - メモリ運用と設定ファイル作成
250
+
251
+ ## 設定ファイル
252
+
253
+ `shirokuma-docs init` で `shirokuma-docs.config.yaml` が生成されます。各セクションにはインラインコメントで説明が記載されています。
254
+
255
+ | セクション | 用途 | 必須 |
256
+ |-----------|------|------|
257
+ | `project` | プロジェクト名・説明 | はい |
258
+ | `output` | 出力ディレクトリ | はい |
259
+ | `typedoc` | TypeDoc API ドキュメント | いいえ |
260
+ | `schema` | Drizzle ORM ER図 | いいえ |
261
+ | `deps` | 依存関係グラフ | いいえ |
262
+ | `testCases` | テストケース抽出(Jest/Playwright) | いいえ |
263
+ | `portal` | ドキュメントポータル | いいえ |
264
+ | `lintDocs` / `lintCode` / `lintStructure` | 検証ルール | いいえ |
265
+ | `github` | GitHub Projects / Discussions 連携 | いいえ |
266
+ | `adr` | ADR(Architecture Decision Records) | いいえ |
267
+
268
+ 不要なセクションは削除できます。設定されたセクションのみが有効です。全スキーマは[設定ファイルリファレンス](docs/guide/config.md)を参照してください。
269
+
270
+ ## 出力構造
271
+
272
+ ```
273
+ docs/
274
+ ├── portal/
275
+ │ ├── index.html # ポータルトップページ
276
+ │ ├── viewer.html # Markdown/DBML/SVG ビューア
277
+ │ └── test-cases.html # テストケース一覧
278
+ └── generated/
279
+ ├── api/ # TypeDoc Markdown
280
+ ├── api-html/ # TypeDoc HTML
281
+ ├── schema/
282
+ │ ├── schema.dbml
283
+ │ └── schema-docs.md
284
+ ├── dependencies.svg
285
+ ├── dependencies.html
286
+ └── test-cases.md
287
+ ```
288
+
289
+ ## 動作要件
290
+
291
+ - **Node.js**: 20.0.0 以上
292
+ - **Claude Code**: スキル・ルール連携に必要
293
+ - **gh CLI**: GitHub コマンドに必要(`gh auth login` 要)
294
+
295
+ ### オプション依存
296
+
297
+ | ツール | 用途 | インストール |
298
+ |--------|------|-------------|
299
+ | graphviz | 依存関係グラフ SVG | `apt install graphviz` |
300
+ | typedoc | API ドキュメント | `npm i -D typedoc typedoc-plugin-markdown` |
301
+ | dependency-cruiser | 依存関係分析 | `npm i -D dependency-cruiser` |
302
+ | drizzle-dbml-generator | DBML 生成 | `npm i -D drizzle-dbml-generator` |
303
+
304
+ ## ライセンス
305
+
306
+ MIT
307
+
308
+ サードパーティライセンスは [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) を参照してください。
@@ -0,0 +1,18 @@
1
+ # Third-Party Notices
2
+
3
+ This project is licensed under the MIT License.
4
+ The following components are licensed under different terms.
5
+
6
+ ## Apache License 2.0
7
+
8
+ The following files are derived from [anthropics/skills](https://github.com/anthropics/skills)
9
+ (skill-creator), licensed under Apache License 2.0:
10
+
11
+ - plugin/shirokuma-skills-{en,ja}/skills/managing-skills/scripts/init_skill.py
12
+ - plugin/shirokuma-skills-{en,ja}/skills/managing-skills/scripts/package_skill.py
13
+ - plugin/shirokuma-skills-{en,ja}/skills/managing-skills/scripts/quick_validate.py
14
+ - plugin/shirokuma-skills-{en,ja}/skills/managing-skills/reference-workflows.md
15
+ - plugin/shirokuma-skills-{en,ja}/skills/managing-skills/reference-output-patterns.md
16
+
17
+ These files have been modified for use in shirokuma-docs.
18
+ See the LICENSE.txt in each managing-skills/scripts directory for the full Apache License 2.0 text.
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ import '../dist/index.js';
@@ -0,0 +1,31 @@
1
+ /**
2
+ * details-test-analysis - テストケース分析
3
+ *
4
+ * 要素・モジュールに関連するテストケースを抽出し、
5
+ * カテゴリ分類とカバレッジ分析を行う。
6
+ */
7
+ import type { DetailsContext, TestCategory, CategorizedTestCase, TestCoverageAnalysis } from "../commands/details-types.js";
8
+ /**
9
+ * 要素に関連するテストケースを抽出
10
+ */
11
+ export declare function findTestCasesForElement(elementName: string, elementPath: string, ctx: DetailsContext): CategorizedTestCase[];
12
+ /**
13
+ * テスト名からカテゴリを推定
14
+ */
15
+ export declare function categorizeTest(testName: string, describePath: string): {
16
+ category: TestCategory;
17
+ summary: string;
18
+ };
19
+ /**
20
+ * テスト名から意図を抽出
21
+ */
22
+ export declare function extractTestIntent(testName: string): string;
23
+ /**
24
+ * テストカバレッジを分析
25
+ */
26
+ export declare function analyzeTestCoverage(testCases: CategorizedTestCase[], hasAuth?: boolean, hasDb?: boolean): TestCoverageAnalysis;
27
+ /**
28
+ * モジュールに関連するテストケースを抽出
29
+ */
30
+ export declare function findTestCasesForModule(moduleName: string, type: string, ctx: DetailsContext): CategorizedTestCase[];
31
+ //# sourceMappingURL=details-test-analysis.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"details-test-analysis.d.ts","sourceRoot":"","sources":["../../src/analyzers/details-test-analysis.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,cAAc,EAEd,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,cAAc,GAClB,mBAAmB,EAAE,CAwBvB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAqC7C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAQ1D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,mBAAmB,EAAE,EAChC,OAAO,GAAE,OAAe,EACxB,KAAK,GAAE,OAAe,GACrB,oBAAoB,CA+DtB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,cAAc,GAClB,mBAAmB,EAAE,CA8CvB"}