@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.
- package/LICENSE +21 -0
- package/README.en.md +308 -0
- package/README.md +308 -0
- package/THIRD_PARTY_NOTICES.md +18 -0
- package/bin/shirokuma-docs +2 -0
- package/dist/analyzers/details-test-analysis.d.ts +31 -0
- package/dist/analyzers/details-test-analysis.d.ts.map +1 -0
- package/dist/analyzers/details-test-analysis.js +172 -0
- package/dist/analyzers/details-test-analysis.js.map +1 -0
- package/dist/analyzers/feature-map-builder.d.ts +20 -0
- package/dist/analyzers/feature-map-builder.d.ts.map +1 -0
- package/dist/analyzers/feature-map-builder.js +154 -0
- package/dist/analyzers/feature-map-builder.js.map +1 -0
- package/dist/analyzers/feature-map-references.d.ts +34 -0
- package/dist/analyzers/feature-map-references.d.ts.map +1 -0
- package/dist/analyzers/feature-map-references.js +249 -0
- package/dist/analyzers/feature-map-references.js.map +1 -0
- package/dist/analyzers/reference-analyzer.d.ts +95 -0
- package/dist/analyzers/reference-analyzer.d.ts.map +1 -0
- package/dist/analyzers/reference-analyzer.js +372 -0
- package/dist/analyzers/reference-analyzer.js.map +1 -0
- package/dist/commands/adr.d.ts +26 -0
- package/dist/commands/adr.d.ts.map +1 -0
- package/dist/commands/adr.js +129 -0
- package/dist/commands/adr.js.map +1 -0
- package/dist/commands/api-tools.d.ts +83 -0
- package/dist/commands/api-tools.d.ts.map +1 -0
- package/dist/commands/api-tools.js +775 -0
- package/dist/commands/api-tools.js.map +1 -0
- package/dist/commands/coverage.d.ts +139 -0
- package/dist/commands/coverage.d.ts.map +1 -0
- package/dist/commands/coverage.js +481 -0
- package/dist/commands/coverage.js.map +1 -0
- package/dist/commands/deps.d.ts +24 -0
- package/dist/commands/deps.d.ts.map +1 -0
- package/dist/commands/deps.js +211 -0
- package/dist/commands/deps.js.map +1 -0
- package/dist/commands/details-context.d.ts +38 -0
- package/dist/commands/details-context.d.ts.map +1 -0
- package/dist/commands/details-context.js +193 -0
- package/dist/commands/details-context.js.map +1 -0
- package/dist/commands/details-types.d.ts +315 -0
- package/dist/commands/details-types.d.ts.map +1 -0
- package/dist/commands/details-types.js +7 -0
- package/dist/commands/details-types.js.map +1 -0
- package/dist/commands/details.d.ts +24 -0
- package/dist/commands/details.d.ts.map +1 -0
- package/dist/commands/details.js +299 -0
- package/dist/commands/details.js.map +1 -0
- package/dist/commands/discussion-templates.d.ts +26 -0
- package/dist/commands/discussion-templates.d.ts.map +1 -0
- package/dist/commands/discussion-templates.js +270 -0
- package/dist/commands/discussion-templates.js.map +1 -0
- package/dist/commands/discussions.d.ts +31 -0
- package/dist/commands/discussions.d.ts.map +1 -0
- package/dist/commands/discussions.js +743 -0
- package/dist/commands/discussions.js.map +1 -0
- package/dist/commands/feature-map-types.d.ts +294 -0
- package/dist/commands/feature-map-types.d.ts.map +1 -0
- package/dist/commands/feature-map-types.js +8 -0
- package/dist/commands/feature-map-types.js.map +1 -0
- package/dist/commands/feature-map.d.ts +30 -0
- package/dist/commands/feature-map.d.ts.map +1 -0
- package/dist/commands/feature-map.js +137 -0
- package/dist/commands/feature-map.js.map +1 -0
- package/dist/commands/generate.d.ts +16 -0
- package/dist/commands/generate.d.ts.map +1 -0
- package/dist/commands/generate.js +88 -0
- package/dist/commands/generate.js.map +1 -0
- package/dist/commands/gh-discussions.d.ts +31 -0
- package/dist/commands/gh-discussions.d.ts.map +1 -0
- package/dist/commands/gh-discussions.js +743 -0
- package/dist/commands/gh-discussions.js.map +1 -0
- package/dist/commands/gh-issues-pr.d.ts +74 -0
- package/dist/commands/gh-issues-pr.d.ts.map +1 -0
- package/dist/commands/gh-issues-pr.js +417 -0
- package/dist/commands/gh-issues-pr.js.map +1 -0
- package/dist/commands/gh-issues.d.ts +90 -0
- package/dist/commands/gh-issues.d.ts.map +1 -0
- package/dist/commands/gh-issues.js +1297 -0
- package/dist/commands/gh-issues.js.map +1 -0
- package/dist/commands/gh-projects.d.ts +54 -0
- package/dist/commands/gh-projects.d.ts.map +1 -0
- package/dist/commands/gh-projects.js +966 -0
- package/dist/commands/gh-projects.js.map +1 -0
- package/dist/commands/gh-repo.d.ts +18 -0
- package/dist/commands/gh-repo.d.ts.map +1 -0
- package/dist/commands/gh-repo.js +253 -0
- package/dist/commands/gh-repo.js.map +1 -0
- package/dist/commands/github-data.d.ts +67 -0
- package/dist/commands/github-data.d.ts.map +1 -0
- package/dist/commands/github-data.js +361 -0
- package/dist/commands/github-data.js.map +1 -0
- package/dist/commands/i18n.d.ts +102 -0
- package/dist/commands/i18n.d.ts.map +1 -0
- package/dist/commands/i18n.js +829 -0
- package/dist/commands/i18n.js.map +1 -0
- package/dist/commands/impact.d.ts +14 -0
- package/dist/commands/impact.d.ts.map +1 -0
- package/dist/commands/impact.js +263 -0
- package/dist/commands/impact.js.map +1 -0
- package/dist/commands/init.d.ts +53 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +429 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/issues-pr.d.ts +74 -0
- package/dist/commands/issues-pr.d.ts.map +1 -0
- package/dist/commands/issues-pr.js +417 -0
- package/dist/commands/issues-pr.js.map +1 -0
- package/dist/commands/issues.d.ts +76 -0
- package/dist/commands/issues.d.ts.map +1 -0
- package/dist/commands/issues.js +1285 -0
- package/dist/commands/issues.js.map +1 -0
- package/dist/commands/link-docs.d.ts +21 -0
- package/dist/commands/link-docs.d.ts.map +1 -0
- package/dist/commands/link-docs.js +990 -0
- package/dist/commands/link-docs.js.map +1 -0
- package/dist/commands/lint-annotations.d.ts +28 -0
- package/dist/commands/lint-annotations.d.ts.map +1 -0
- package/dist/commands/lint-annotations.js +511 -0
- package/dist/commands/lint-annotations.js.map +1 -0
- package/dist/commands/lint-code.d.ts +26 -0
- package/dist/commands/lint-code.d.ts.map +1 -0
- package/dist/commands/lint-code.js +428 -0
- package/dist/commands/lint-code.js.map +1 -0
- package/dist/commands/lint-coverage.d.ts +33 -0
- package/dist/commands/lint-coverage.d.ts.map +1 -0
- package/dist/commands/lint-coverage.js +379 -0
- package/dist/commands/lint-coverage.js.map +1 -0
- package/dist/commands/lint-docs.d.ts +23 -0
- package/dist/commands/lint-docs.d.ts.map +1 -0
- package/dist/commands/lint-docs.js +338 -0
- package/dist/commands/lint-docs.js.map +1 -0
- package/dist/commands/lint-structure.d.ts +38 -0
- package/dist/commands/lint-structure.d.ts.map +1 -0
- package/dist/commands/lint-structure.js +350 -0
- package/dist/commands/lint-structure.js.map +1 -0
- package/dist/commands/lint-tests.d.ts +25 -0
- package/dist/commands/lint-tests.d.ts.map +1 -0
- package/dist/commands/lint-tests.js +105 -0
- package/dist/commands/lint-tests.js.map +1 -0
- package/dist/commands/lint-workflow.d.ts +36 -0
- package/dist/commands/lint-workflow.d.ts.map +1 -0
- package/dist/commands/lint-workflow.js +255 -0
- package/dist/commands/lint-workflow.js.map +1 -0
- package/dist/commands/overview.d.ts +21 -0
- package/dist/commands/overview.d.ts.map +1 -0
- package/dist/commands/overview.js +1300 -0
- package/dist/commands/overview.js.map +1 -0
- package/dist/commands/packages.d.ts +107 -0
- package/dist/commands/packages.d.ts.map +1 -0
- package/dist/commands/packages.js +308 -0
- package/dist/commands/packages.js.map +1 -0
- package/dist/commands/portal-nextjs.d.ts +23 -0
- package/dist/commands/portal-nextjs.d.ts.map +1 -0
- package/dist/commands/portal-nextjs.js +336 -0
- package/dist/commands/portal-nextjs.js.map +1 -0
- package/dist/commands/portal.d.ts +24 -0
- package/dist/commands/portal.d.ts.map +1 -0
- package/dist/commands/portal.js +16 -0
- package/dist/commands/portal.js.map +1 -0
- package/dist/commands/projects.d.ts +54 -0
- package/dist/commands/projects.d.ts.map +1 -0
- package/dist/commands/projects.js +969 -0
- package/dist/commands/projects.js.map +1 -0
- package/dist/commands/repo-pairs.d.ts +19 -0
- package/dist/commands/repo-pairs.d.ts.map +1 -0
- package/dist/commands/repo-pairs.js +529 -0
- package/dist/commands/repo-pairs.js.map +1 -0
- package/dist/commands/repo.d.ts +18 -0
- package/dist/commands/repo.d.ts.map +1 -0
- package/dist/commands/repo.js +253 -0
- package/dist/commands/repo.js.map +1 -0
- package/dist/commands/schema.d.ts +49 -0
- package/dist/commands/schema.d.ts.map +1 -0
- package/dist/commands/schema.js +830 -0
- package/dist/commands/schema.js.map +1 -0
- package/dist/commands/screenshots.d.ts +203 -0
- package/dist/commands/screenshots.d.ts.map +1 -0
- package/dist/commands/screenshots.js +1234 -0
- package/dist/commands/screenshots.js.map +1 -0
- package/dist/commands/search-index.d.ts +83 -0
- package/dist/commands/search-index.d.ts.map +1 -0
- package/dist/commands/search-index.js +389 -0
- package/dist/commands/search-index.js.map +1 -0
- package/dist/commands/session.d.ts +153 -0
- package/dist/commands/session.d.ts.map +1 -0
- package/dist/commands/session.js +1243 -0
- package/dist/commands/session.js.map +1 -0
- package/dist/commands/test-cases-types.d.ts +154 -0
- package/dist/commands/test-cases-types.d.ts.map +1 -0
- package/dist/commands/test-cases-types.js +7 -0
- package/dist/commands/test-cases-types.js.map +1 -0
- package/dist/commands/test-cases.d.ts +28 -0
- package/dist/commands/test-cases.d.ts.map +1 -0
- package/dist/commands/test-cases.js +192 -0
- package/dist/commands/test-cases.js.map +1 -0
- package/dist/commands/typedoc.d.ts +21 -0
- package/dist/commands/typedoc.d.ts.map +1 -0
- package/dist/commands/typedoc.js +192 -0
- package/dist/commands/typedoc.js.map +1 -0
- package/dist/commands/update-skills.d.ts +56 -0
- package/dist/commands/update-skills.d.ts.map +1 -0
- package/dist/commands/update-skills.js +620 -0
- package/dist/commands/update-skills.js.map +1 -0
- package/dist/generators/details-entity-pages.d.ts +40 -0
- package/dist/generators/details-entity-pages.d.ts.map +1 -0
- package/dist/generators/details-entity-pages.js +301 -0
- package/dist/generators/details-entity-pages.js.map +1 -0
- package/dist/generators/details-html.d.ts +23 -0
- package/dist/generators/details-html.d.ts.map +1 -0
- package/dist/generators/details-html.js +324 -0
- package/dist/generators/details-html.js.map +1 -0
- package/dist/generators/details-module-page.d.ts +33 -0
- package/dist/generators/details-module-page.d.ts.map +1 -0
- package/dist/generators/details-module-page.js +408 -0
- package/dist/generators/details-module-page.js.map +1 -0
- package/dist/generators/details-styles.d.ts +39 -0
- package/dist/generators/details-styles.d.ts.map +1 -0
- package/dist/generators/details-styles.js +409 -0
- package/dist/generators/details-styles.js.map +1 -0
- package/dist/generators/feature-map-html.d.ts +66 -0
- package/dist/generators/feature-map-html.d.ts.map +1 -0
- package/dist/generators/feature-map-html.js +569 -0
- package/dist/generators/feature-map-html.js.map +1 -0
- package/dist/generators/feature-map-styles.d.ts +39 -0
- package/dist/generators/feature-map-styles.d.ts.map +1 -0
- package/dist/generators/feature-map-styles.js +449 -0
- package/dist/generators/feature-map-styles.js.map +1 -0
- package/dist/generators/test-cases-hierarchy.d.ts +21 -0
- package/dist/generators/test-cases-hierarchy.d.ts.map +1 -0
- package/dist/generators/test-cases-hierarchy.js +336 -0
- package/dist/generators/test-cases-hierarchy.js.map +1 -0
- package/dist/generators/test-cases-main.d.ts +20 -0
- package/dist/generators/test-cases-main.d.ts.map +1 -0
- package/dist/generators/test-cases-main.js +439 -0
- package/dist/generators/test-cases-main.js.map +1 -0
- package/dist/generators/test-cases-styles.d.ts +64 -0
- package/dist/generators/test-cases-styles.d.ts.map +1 -0
- package/dist/generators/test-cases-styles.js +1277 -0
- package/dist/generators/test-cases-styles.js.map +1 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +517 -0
- package/dist/index.js.map +1 -0
- package/dist/lint/annotation-lint.d.ts +198 -0
- package/dist/lint/annotation-lint.d.ts.map +1 -0
- package/dist/lint/annotation-lint.js +510 -0
- package/dist/lint/annotation-lint.js.map +1 -0
- package/dist/lint/annotation-types.d.ts +161 -0
- package/dist/lint/annotation-types.d.ts.map +1 -0
- package/dist/lint/annotation-types.js +31 -0
- package/dist/lint/annotation-types.js.map +1 -0
- package/dist/lint/code-types.d.ts +135 -0
- package/dist/lint/code-types.d.ts.map +1 -0
- package/dist/lint/code-types.js +25 -0
- package/dist/lint/code-types.js.map +1 -0
- package/dist/lint/coverage-types.d.ts +128 -0
- package/dist/lint/coverage-types.d.ts.map +1 -0
- package/dist/lint/coverage-types.js +24 -0
- package/dist/lint/coverage-types.js.map +1 -0
- package/dist/lint/docs-types.d.ts +214 -0
- package/dist/lint/docs-types.d.ts.map +1 -0
- package/dist/lint/docs-types.js +18 -0
- package/dist/lint/docs-types.js.map +1 -0
- package/dist/lint/formatters/index.d.ts +14 -0
- package/dist/lint/formatters/index.d.ts.map +1 -0
- package/dist/lint/formatters/index.js +28 -0
- package/dist/lint/formatters/index.js.map +1 -0
- package/dist/lint/formatters/json.d.ts +11 -0
- package/dist/lint/formatters/json.d.ts.map +1 -0
- package/dist/lint/formatters/json.js +12 -0
- package/dist/lint/formatters/json.js.map +1 -0
- package/dist/lint/formatters/summary.d.ts +11 -0
- package/dist/lint/formatters/summary.d.ts.map +1 -0
- package/dist/lint/formatters/summary.js +37 -0
- package/dist/lint/formatters/summary.js.map +1 -0
- package/dist/lint/formatters/terminal.d.ts +11 -0
- package/dist/lint/formatters/terminal.d.ts.map +1 -0
- package/dist/lint/formatters/terminal.js +99 -0
- package/dist/lint/formatters/terminal.js.map +1 -0
- package/dist/lint/index.d.ts +18 -0
- package/dist/lint/index.d.ts.map +1 -0
- package/dist/lint/index.js +103 -0
- package/dist/lint/index.js.map +1 -0
- package/dist/lint/rules/annotation-required.d.ts +35 -0
- package/dist/lint/rules/annotation-required.d.ts.map +1 -0
- package/dist/lint/rules/annotation-required.js +127 -0
- package/dist/lint/rules/annotation-required.js.map +1 -0
- package/dist/lint/rules/code-rules.d.ts +12 -0
- package/dist/lint/rules/code-rules.d.ts.map +1 -0
- package/dist/lint/rules/code-rules.js +11 -0
- package/dist/lint/rules/code-rules.js.map +1 -0
- package/dist/lint/rules/describe-coverage.d.ts +8 -0
- package/dist/lint/rules/describe-coverage.d.ts.map +1 -0
- package/dist/lint/rules/describe-coverage.js +43 -0
- package/dist/lint/rules/describe-coverage.js.map +1 -0
- package/dist/lint/rules/duplicate-testdoc.d.ts +8 -0
- package/dist/lint/rules/duplicate-testdoc.d.ts.map +1 -0
- package/dist/lint/rules/duplicate-testdoc.js +38 -0
- package/dist/lint/rules/duplicate-testdoc.js.map +1 -0
- package/dist/lint/rules/index.d.ts +29 -0
- package/dist/lint/rules/index.d.ts.map +1 -0
- package/dist/lint/rules/index.js +55 -0
- package/dist/lint/rules/index.js.map +1 -0
- package/dist/lint/rules/server-action-structure.d.ts +37 -0
- package/dist/lint/rules/server-action-structure.d.ts.map +1 -0
- package/dist/lint/rules/server-action-structure.js +151 -0
- package/dist/lint/rules/server-action-structure.js.map +1 -0
- package/dist/lint/rules/skipped-test-report.d.ts +11 -0
- package/dist/lint/rules/skipped-test-report.d.ts.map +1 -0
- package/dist/lint/rules/skipped-test-report.js +31 -0
- package/dist/lint/rules/skipped-test-report.js.map +1 -0
- package/dist/lint/rules/structure-rules.d.ts +67 -0
- package/dist/lint/rules/structure-rules.d.ts.map +1 -0
- package/dist/lint/rules/structure-rules.js +615 -0
- package/dist/lint/rules/structure-rules.js.map +1 -0
- package/dist/lint/rules/testdoc-japanese.d.ts +8 -0
- package/dist/lint/rules/testdoc-japanese.d.ts.map +1 -0
- package/dist/lint/rules/testdoc-japanese.js +31 -0
- package/dist/lint/rules/testdoc-japanese.js.map +1 -0
- package/dist/lint/rules/testdoc-min-length.d.ts +8 -0
- package/dist/lint/rules/testdoc-min-length.d.ts.map +1 -0
- package/dist/lint/rules/testdoc-min-length.js +31 -0
- package/dist/lint/rules/testdoc-min-length.js.map +1 -0
- package/dist/lint/rules/testdoc-required.d.ts +8 -0
- package/dist/lint/rules/testdoc-required.d.ts.map +1 -0
- package/dist/lint/rules/testdoc-required.js +27 -0
- package/dist/lint/rules/testdoc-required.js.map +1 -0
- package/dist/lint/rules/workflow-branch-naming.d.ts +20 -0
- package/dist/lint/rules/workflow-branch-naming.d.ts.map +1 -0
- package/dist/lint/rules/workflow-branch-naming.js +85 -0
- package/dist/lint/rules/workflow-branch-naming.js.map +1 -0
- package/dist/lint/rules/workflow-commit-format.d.ts +27 -0
- package/dist/lint/rules/workflow-commit-format.d.ts.map +1 -0
- package/dist/lint/rules/workflow-commit-format.js +92 -0
- package/dist/lint/rules/workflow-commit-format.js.map +1 -0
- package/dist/lint/rules/workflow-issue-fields.d.ts +24 -0
- package/dist/lint/rules/workflow-issue-fields.d.ts.map +1 -0
- package/dist/lint/rules/workflow-issue-fields.js +89 -0
- package/dist/lint/rules/workflow-issue-fields.js.map +1 -0
- package/dist/lint/rules/workflow-main-protection.d.ts +32 -0
- package/dist/lint/rules/workflow-main-protection.d.ts.map +1 -0
- package/dist/lint/rules/workflow-main-protection.js +114 -0
- package/dist/lint/rules/workflow-main-protection.js.map +1 -0
- package/dist/lint/structure-types.d.ts +216 -0
- package/dist/lint/structure-types.d.ts.map +1 -0
- package/dist/lint/structure-types.js +96 -0
- package/dist/lint/structure-types.js.map +1 -0
- package/dist/lint/types.d.ts +154 -0
- package/dist/lint/types.d.ts.map +1 -0
- package/dist/lint/types.js +21 -0
- package/dist/lint/types.js.map +1 -0
- package/dist/lint/workflow-types.d.ts +90 -0
- package/dist/lint/workflow-types.d.ts.map +1 -0
- package/dist/lint/workflow-types.js +7 -0
- package/dist/lint/workflow-types.js.map +1 -0
- package/dist/md/analyzer/index.d.ts +46 -0
- package/dist/md/analyzer/index.d.ts.map +1 -0
- package/dist/md/analyzer/index.js +288 -0
- package/dist/md/analyzer/index.js.map +1 -0
- package/dist/md/builder/index.d.ts +91 -0
- package/dist/md/builder/index.d.ts.map +1 -0
- package/dist/md/builder/index.js +446 -0
- package/dist/md/builder/index.js.map +1 -0
- package/dist/md/cli/analyze.d.ts +11 -0
- package/dist/md/cli/analyze.d.ts.map +1 -0
- package/dist/md/cli/analyze.js +118 -0
- package/dist/md/cli/analyze.js.map +1 -0
- package/dist/md/cli/build.d.ts +11 -0
- package/dist/md/cli/build.d.ts.map +1 -0
- package/dist/md/cli/build.js +74 -0
- package/dist/md/cli/build.js.map +1 -0
- package/dist/md/cli/extract.d.ts +25 -0
- package/dist/md/cli/extract.d.ts.map +1 -0
- package/dist/md/cli/extract.js +230 -0
- package/dist/md/cli/extract.js.map +1 -0
- package/dist/md/cli/index.d.ts +3 -0
- package/dist/md/cli/index.d.ts.map +1 -0
- package/dist/md/cli/index.js +99 -0
- package/dist/md/cli/index.js.map +1 -0
- package/dist/md/cli/lint.d.ts +11 -0
- package/dist/md/cli/lint.d.ts.map +1 -0
- package/dist/md/cli/lint.js +165 -0
- package/dist/md/cli/lint.js.map +1 -0
- package/dist/md/cli/list.d.ts +16 -0
- package/dist/md/cli/list.d.ts.map +1 -0
- package/dist/md/cli/list.js +85 -0
- package/dist/md/cli/list.js.map +1 -0
- package/dist/md/cli/program.d.ts +11 -0
- package/dist/md/cli/program.d.ts.map +1 -0
- package/dist/md/cli/program.js +104 -0
- package/dist/md/cli/program.js.map +1 -0
- package/dist/md/cli/validate.d.ts +8 -0
- package/dist/md/cli/validate.d.ts.map +1 -0
- package/dist/md/cli/validate.js +82 -0
- package/dist/md/cli/validate.js.map +1 -0
- package/dist/md/constants.d.ts +69 -0
- package/dist/md/constants.d.ts.map +1 -0
- package/dist/md/constants.js +69 -0
- package/dist/md/constants.js.map +1 -0
- package/dist/md/extractor/index.d.ts +57 -0
- package/dist/md/extractor/index.d.ts.map +1 -0
- package/dist/md/extractor/index.js +359 -0
- package/dist/md/extractor/index.js.map +1 -0
- package/dist/md/index.d.ts +26 -0
- package/dist/md/index.d.ts.map +1 -0
- package/dist/md/index.js +30 -0
- package/dist/md/index.js.map +1 -0
- package/dist/md/linter/index.d.ts +20 -0
- package/dist/md/linter/index.d.ts.map +1 -0
- package/dist/md/linter/index.js +412 -0
- package/dist/md/linter/index.js.map +1 -0
- package/dist/md/linter/token-optimizer.d.ts +66 -0
- package/dist/md/linter/token-optimizer.d.ts.map +1 -0
- package/dist/md/linter/token-optimizer.js +292 -0
- package/dist/md/linter/token-optimizer.js.map +1 -0
- package/dist/md/lister/index.d.ts +42 -0
- package/dist/md/lister/index.d.ts.map +1 -0
- package/dist/md/lister/index.js +317 -0
- package/dist/md/lister/index.js.map +1 -0
- package/dist/md/parser/heading-numbers.d.ts +43 -0
- package/dist/md/parser/heading-numbers.d.ts.map +1 -0
- package/dist/md/parser/heading-numbers.js +97 -0
- package/dist/md/parser/heading-numbers.js.map +1 -0
- package/dist/md/parser/section-meta.d.ts +50 -0
- package/dist/md/parser/section-meta.d.ts.map +1 -0
- package/dist/md/parser/section-meta.js +212 -0
- package/dist/md/parser/section-meta.js.map +1 -0
- package/dist/md/parser/template.d.ts +56 -0
- package/dist/md/parser/template.d.ts.map +1 -0
- package/dist/md/parser/template.js +122 -0
- package/dist/md/parser/template.js.map +1 -0
- package/dist/md/plugins/loader.d.ts +15 -0
- package/dist/md/plugins/loader.d.ts.map +1 -0
- package/dist/md/plugins/loader.js +80 -0
- package/dist/md/plugins/loader.js.map +1 -0
- package/dist/md/plugins/normalize-headings.d.ts +43 -0
- package/dist/md/plugins/normalize-headings.d.ts.map +1 -0
- package/dist/md/plugins/normalize-headings.js +51 -0
- package/dist/md/plugins/normalize-headings.js.map +1 -0
- package/dist/md/plugins/normalize-whitespace.d.ts +46 -0
- package/dist/md/plugins/normalize-whitespace.d.ts.map +1 -0
- package/dist/md/plugins/normalize-whitespace.js +86 -0
- package/dist/md/plugins/normalize-whitespace.js.map +1 -0
- package/dist/md/plugins/remove-badges.d.ts +36 -0
- package/dist/md/plugins/remove-badges.d.ts.map +1 -0
- package/dist/md/plugins/remove-badges.js +59 -0
- package/dist/md/plugins/remove-badges.js.map +1 -0
- package/dist/md/plugins/remove-comments.d.ts +27 -0
- package/dist/md/plugins/remove-comments.d.ts.map +1 -0
- package/dist/md/plugins/remove-comments.js +40 -0
- package/dist/md/plugins/remove-comments.js.map +1 -0
- package/dist/md/plugins/remove-duplicates.d.ts +40 -0
- package/dist/md/plugins/remove-duplicates.d.ts.map +1 -0
- package/dist/md/plugins/remove-duplicates.js +72 -0
- package/dist/md/plugins/remove-duplicates.js.map +1 -0
- package/dist/md/plugins/remove-internal-links.d.ts +38 -0
- package/dist/md/plugins/remove-internal-links.d.ts.map +1 -0
- package/dist/md/plugins/remove-internal-links.js +66 -0
- package/dist/md/plugins/remove-internal-links.js.map +1 -0
- package/dist/md/plugins/strip-heading-numbers.d.ts +35 -0
- package/dist/md/plugins/strip-heading-numbers.d.ts.map +1 -0
- package/dist/md/plugins/strip-heading-numbers.js +59 -0
- package/dist/md/plugins/strip-heading-numbers.js.map +1 -0
- package/dist/md/plugins/strip-section-meta.d.ts +37 -0
- package/dist/md/plugins/strip-section-meta.d.ts.map +1 -0
- package/dist/md/plugins/strip-section-meta.js +62 -0
- package/dist/md/plugins/strip-section-meta.js.map +1 -0
- package/dist/md/types/config.d.ts +260 -0
- package/dist/md/types/config.d.ts.map +1 -0
- package/dist/md/types/config.js +156 -0
- package/dist/md/types/config.js.map +1 -0
- package/dist/md/types/document.d.ts +37 -0
- package/dist/md/types/document.d.ts.map +1 -0
- package/dist/md/types/document.js +2 -0
- package/dist/md/types/document.js.map +1 -0
- package/dist/md/types/validation.d.ts +107 -0
- package/dist/md/types/validation.d.ts.map +1 -0
- package/dist/md/types/validation.js +2 -0
- package/dist/md/types/validation.js.map +1 -0
- package/dist/md/utils/code-blocks.d.ts +136 -0
- package/dist/md/utils/code-blocks.d.ts.map +1 -0
- package/dist/md/utils/code-blocks.js +178 -0
- package/dist/md/utils/code-blocks.js.map +1 -0
- package/dist/md/utils/config.d.ts +10 -0
- package/dist/md/utils/config.d.ts.map +1 -0
- package/dist/md/utils/config.js +99 -0
- package/dist/md/utils/config.js.map +1 -0
- package/dist/md/utils/file-collector.d.ts +78 -0
- package/dist/md/utils/file-collector.d.ts.map +1 -0
- package/dist/md/utils/file-collector.js +100 -0
- package/dist/md/utils/file-collector.js.map +1 -0
- package/dist/md/utils/markdown.d.ts +18 -0
- package/dist/md/utils/markdown.d.ts.map +1 -0
- package/dist/md/utils/markdown.js +93 -0
- package/dist/md/utils/markdown.js.map +1 -0
- package/dist/md/utils/remark.d.ts +91 -0
- package/dist/md/utils/remark.d.ts.map +1 -0
- package/dist/md/utils/remark.js +125 -0
- package/dist/md/utils/remark.js.map +1 -0
- package/dist/md/utils/tokens.d.ts +9 -0
- package/dist/md/utils/tokens.d.ts.map +1 -0
- package/dist/md/utils/tokens.js +31 -0
- package/dist/md/utils/tokens.js.map +1 -0
- package/dist/md/validator/index.d.ts +40 -0
- package/dist/md/validator/index.d.ts.map +1 -0
- package/dist/md/validator/index.js +289 -0
- package/dist/md/validator/index.js.map +1 -0
- package/dist/parsers/details-jsdoc.d.ts +46 -0
- package/dist/parsers/details-jsdoc.d.ts.map +1 -0
- package/dist/parsers/details-jsdoc.js +262 -0
- package/dist/parsers/details-jsdoc.js.map +1 -0
- package/dist/parsers/details-zod.d.ts +22 -0
- package/dist/parsers/details-zod.d.ts.map +1 -0
- package/dist/parsers/details-zod.js +145 -0
- package/dist/parsers/details-zod.js.map +1 -0
- package/dist/parsers/drizzle-schema.d.ts +92 -0
- package/dist/parsers/drizzle-schema.d.ts.map +1 -0
- package/dist/parsers/drizzle-schema.js +376 -0
- package/dist/parsers/drizzle-schema.js.map +1 -0
- package/dist/parsers/feature-map-tags.d.ts +45 -0
- package/dist/parsers/feature-map-tags.d.ts.map +1 -0
- package/dist/parsers/feature-map-tags.js +292 -0
- package/dist/parsers/feature-map-tags.js.map +1 -0
- package/dist/parsers/feature-map-type-extraction.d.ts +62 -0
- package/dist/parsers/feature-map-type-extraction.d.ts.map +1 -0
- package/dist/parsers/feature-map-type-extraction.js +347 -0
- package/dist/parsers/feature-map-type-extraction.js.map +1 -0
- package/dist/parsers/feature-map-utils.d.ts +34 -0
- package/dist/parsers/feature-map-utils.d.ts.map +1 -0
- package/dist/parsers/feature-map-utils.js +101 -0
- package/dist/parsers/feature-map-utils.js.map +1 -0
- package/dist/parsers/jsdoc-common.d.ts +209 -0
- package/dist/parsers/jsdoc-common.d.ts.map +1 -0
- package/dist/parsers/jsdoc-common.js +655 -0
- package/dist/parsers/jsdoc-common.js.map +1 -0
- package/dist/parsers/jsdoc.d.ts +76 -0
- package/dist/parsers/jsdoc.d.ts.map +1 -0
- package/dist/parsers/jsdoc.js +238 -0
- package/dist/parsers/jsdoc.js.map +1 -0
- package/dist/parsers/screenshot-annotations.d.ts +96 -0
- package/dist/parsers/screenshot-annotations.d.ts.map +1 -0
- package/dist/parsers/screenshot-annotations.js +227 -0
- package/dist/parsers/screenshot-annotations.js.map +1 -0
- package/dist/parsers/test-annotations.d.ts +46 -0
- package/dist/parsers/test-annotations.d.ts.map +1 -0
- package/dist/parsers/test-annotations.js +393 -0
- package/dist/parsers/test-annotations.js.map +1 -0
- package/dist/parsers/test-categorization.d.ts +42 -0
- package/dist/parsers/test-categorization.d.ts.map +1 -0
- package/dist/parsers/test-categorization.js +182 -0
- package/dist/parsers/test-categorization.js.map +1 -0
- package/dist/parsers/zod-schema.d.ts +105 -0
- package/dist/parsers/zod-schema.d.ts.map +1 -0
- package/dist/parsers/zod-schema.js +270 -0
- package/dist/parsers/zod-schema.js.map +1 -0
- package/dist/utils/action-inference.d.ts +23 -0
- package/dist/utils/action-inference.d.ts.map +1 -0
- package/dist/utils/action-inference.js +36 -0
- package/dist/utils/action-inference.js.map +1 -0
- package/dist/utils/app-inference.d.ts +31 -0
- package/dist/utils/app-inference.d.ts.map +1 -0
- package/dist/utils/app-inference.js +41 -0
- package/dist/utils/app-inference.js.map +1 -0
- package/dist/utils/auto-infer.d.ts +93 -0
- package/dist/utils/auto-infer.d.ts.map +1 -0
- package/dist/utils/auto-infer.js +184 -0
- package/dist/utils/auto-infer.js.map +1 -0
- package/dist/utils/config.d.ts +709 -0
- package/dist/utils/config.d.ts.map +1 -0
- package/dist/utils/config.js +504 -0
- package/dist/utils/config.js.map +1 -0
- package/dist/utils/file.d.ts +46 -0
- package/dist/utils/file.d.ts.map +1 -0
- package/dist/utils/file.js +103 -0
- package/dist/utils/file.js.map +1 -0
- package/dist/utils/formatters.d.ts +111 -0
- package/dist/utils/formatters.d.ts.map +1 -0
- package/dist/utils/formatters.js +164 -0
- package/dist/utils/formatters.js.map +1 -0
- package/dist/utils/gh-config.d.ts +99 -0
- package/dist/utils/gh-config.d.ts.map +1 -0
- package/dist/utils/gh-config.js +247 -0
- package/dist/utils/gh-config.js.map +1 -0
- package/dist/utils/github.d.ts +98 -0
- package/dist/utils/github.d.ts.map +1 -0
- package/dist/utils/github.js +295 -0
- package/dist/utils/github.js.map +1 -0
- package/dist/utils/html.d.ts +107 -0
- package/dist/utils/html.d.ts.map +1 -0
- package/dist/utils/html.js +376 -0
- package/dist/utils/html.js.map +1 -0
- package/dist/utils/i18n.d.ts +40 -0
- package/dist/utils/i18n.d.ts.map +1 -0
- package/dist/utils/i18n.js +148 -0
- package/dist/utils/i18n.js.map +1 -0
- package/dist/utils/logger.d.ts +20 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +49 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/project-fields.d.ts +71 -0
- package/dist/utils/project-fields.d.ts.map +1 -0
- package/dist/utils/project-fields.js +318 -0
- package/dist/utils/project-fields.js.map +1 -0
- package/dist/utils/repo-pairs.d.ts +94 -0
- package/dist/utils/repo-pairs.d.ts.map +1 -0
- package/dist/utils/repo-pairs.js +196 -0
- package/dist/utils/repo-pairs.js.map +1 -0
- package/dist/utils/route-inference.d.ts +81 -0
- package/dist/utils/route-inference.d.ts.map +1 -0
- package/dist/utils/route-inference.js +137 -0
- package/dist/utils/route-inference.js.map +1 -0
- package/dist/utils/setup-check.d.ts +34 -0
- package/dist/utils/setup-check.d.ts.map +1 -0
- package/dist/utils/setup-check.js +136 -0
- package/dist/utils/setup-check.js.map +1 -0
- package/dist/utils/shirokumaignore.d.ts +55 -0
- package/dist/utils/shirokumaignore.d.ts.map +1 -0
- package/dist/utils/shirokumaignore.js +94 -0
- package/dist/utils/shirokumaignore.js.map +1 -0
- package/dist/utils/skills-repo.d.ts +353 -0
- package/dist/utils/skills-repo.d.ts.map +1 -0
- package/dist/utils/skills-repo.js +793 -0
- package/dist/utils/skills-repo.js.map +1 -0
- package/dist/utils/status-workflow.d.ts +54 -0
- package/dist/utils/status-workflow.d.ts.map +1 -0
- package/dist/utils/status-workflow.js +103 -0
- package/dist/utils/status-workflow.js.map +1 -0
- package/dist/validators/frontmatter.d.ts +41 -0
- package/dist/validators/frontmatter.d.ts.map +1 -0
- package/dist/validators/frontmatter.js +117 -0
- package/dist/validators/frontmatter.js.map +1 -0
- package/dist/validators/link-checker.d.ts +48 -0
- package/dist/validators/link-checker.d.ts.map +1 -0
- package/dist/validators/link-checker.js +108 -0
- package/dist/validators/link-checker.js.map +1 -0
- package/dist/validators/markdown-structure.d.ts +50 -0
- package/dist/validators/markdown-structure.d.ts.map +1 -0
- package/dist/validators/markdown-structure.js +253 -0
- package/dist/validators/markdown-structure.js.map +1 -0
- package/i18n/cli/en.json +155 -0
- package/i18n/cli/ja.json +155 -0
- package/i18n/discussion/en.json +191 -0
- package/i18n/discussion/ja.json +191 -0
- package/package.json +113 -0
- package/portal/app/api-tools/api-tools-client.tsx +411 -0
- package/portal/app/api-tools/api-tools-document.tsx +240 -0
- package/portal/app/api-tools/page.tsx +56 -0
- package/portal/app/api-tools/swagger-view.tsx +114 -0
- package/portal/app/apps/[appId]/[type]/[module]/[item]/item-tabs-client.tsx +71 -0
- package/portal/app/apps/[appId]/[type]/[module]/[item]/page.tsx +1422 -0
- package/portal/app/apps/[appId]/[type]/[module]/page.tsx +373 -0
- package/portal/app/apps/[appId]/feature-map/feature-map-app-document.tsx +298 -0
- package/portal/app/apps/[appId]/feature-map/page.tsx +224 -0
- package/portal/app/apps/[appId]/i18n/page.tsx +139 -0
- package/portal/app/apps/[appId]/test-cases/page.tsx +840 -0
- package/portal/app/apps/[appId]/tools/[tool]/page.tsx +351 -0
- package/portal/app/apps/[appId]/tools/api-tools-client.tsx +429 -0
- package/portal/app/apps/[appId]/tools/page.tsx +119 -0
- package/portal/app/db-schema/[db]/[table]/page.tsx +235 -0
- package/portal/app/db-schema/[db]/diagram/page.tsx +81 -0
- package/portal/app/db-schema/[db]/page.tsx +148 -0
- package/portal/app/db-schema/db-schema-document.tsx +100 -0
- package/portal/app/db-schema/diagram/client.tsx +211 -0
- package/portal/app/db-schema/diagram/page.tsx +20 -0
- package/portal/app/db-schema/page.tsx +145 -0
- package/portal/app/db-schema/table-detail-document.tsx +710 -0
- package/portal/app/db-schema/table-detail.tsx +747 -0
- package/portal/app/db-schema/table-list-document.tsx +224 -0
- package/portal/app/db-schema/table-list.tsx +247 -0
- package/portal/app/details/[type]/[module]/[item]/item-tabs-client.tsx +71 -0
- package/portal/app/details/[type]/[module]/[item]/page.tsx +1286 -0
- package/portal/app/details/[type]/[module]/page.tsx +884 -0
- package/portal/app/feature-map/feature-map-client.tsx +681 -0
- package/portal/app/feature-map/feature-map-document.tsx +313 -0
- package/portal/app/feature-map/page.tsx +438 -0
- package/portal/app/globals.css +205 -0
- package/portal/app/i18n/[...namespace]/page.tsx +190 -0
- package/portal/app/i18n/i18n-client.tsx +369 -0
- package/portal/app/i18n/page.tsx +339 -0
- package/portal/app/layout.tsx +37 -0
- package/portal/app/overview/page.tsx +65 -0
- package/portal/app/packages/[packageId]/page.tsx +201 -0
- package/portal/app/packages/page.tsx +148 -0
- package/portal/app/page.tsx +568 -0
- package/portal/app/test-cases/[file]/[line]/page.tsx +455 -0
- package/portal/app/test-cases/[file]/[line]/test-detail-document.tsx +335 -0
- package/portal/app/test-cases/[file]/page.tsx +323 -0
- package/portal/app/test-cases/[file]/test-file-document.tsx +335 -0
- package/portal/app/test-cases/page.tsx +546 -0
- package/portal/app/test-cases/test-cases-document.tsx +384 -0
- package/portal/components/code-block.tsx +57 -0
- package/portal/components/document/doc-params-table.tsx +71 -0
- package/portal/components/document/doc-section.tsx +133 -0
- package/portal/components/document/doc-table.tsx +119 -0
- package/portal/components/document/index.ts +9 -0
- package/portal/components/drawflow-er-diagram.tsx +607 -0
- package/portal/components/interactive-er-diagram.tsx +228 -0
- package/portal/components/layout/app-sidebar.tsx +490 -0
- package/portal/components/layout/er-sidebar.tsx +116 -0
- package/portal/components/layout/global-header.tsx +117 -0
- package/portal/components/layout/layout-content.tsx +48 -0
- package/portal/components/markdown-content.tsx +120 -0
- package/portal/components/mermaid-diagram.tsx +83 -0
- package/portal/components/reactflow-er-diagram.tsx +475 -0
- package/portal/components/search-dialog.tsx +268 -0
- package/portal/components/shared/coverage-score-bar.tsx +144 -0
- package/portal/components/swagger/endpoint-accordion.tsx +117 -0
- package/portal/components/swagger/index.ts +7 -0
- package/portal/components/swagger/method-badge.tsx +55 -0
- package/portal/components/swagger/params-table.tsx +78 -0
- package/portal/components/tabs-with-hash.tsx +43 -0
- package/portal/components/test/index.ts +2 -0
- package/portal/components/test/test-bdd-card.tsx +192 -0
- package/portal/components/test/test-matrix.tsx +242 -0
- package/portal/components/ui/accordion.tsx +66 -0
- package/portal/components/ui/badge.tsx +46 -0
- package/portal/components/ui/breadcrumb.tsx +109 -0
- package/portal/components/ui/button.tsx +62 -0
- package/portal/components/ui/card.tsx +92 -0
- package/portal/components/ui/collapsible.tsx +33 -0
- package/portal/components/ui/dialog.tsx +118 -0
- package/portal/components/ui/progress.tsx +28 -0
- package/portal/components/ui/scroll-area.tsx +58 -0
- package/portal/components/ui/sheet.tsx +139 -0
- package/portal/components/ui/table.tsx +116 -0
- package/portal/components/ui/tabs.tsx +66 -0
- package/portal/components.json +21 -0
- package/portal/lib/constants/test-categories.ts +186 -0
- package/portal/lib/data-loader.ts +1181 -0
- package/portal/lib/db-schema-utils.ts +182 -0
- package/portal/lib/format.ts +43 -0
- package/portal/lib/hooks/use-hash-tab.ts +144 -0
- package/portal/lib/path-utils.ts +25 -0
- package/portal/lib/search-index-generator.ts +214 -0
- package/portal/lib/search.ts +126 -0
- package/portal/lib/sidebar-context.tsx +111 -0
- package/portal/lib/types.ts +740 -0
- package/portal/lib/utils.ts +6 -0
- package/portal/next.config.ts +21 -0
- package/portal/package.json +45 -0
- package/portal/postcss.config.mjs +8 -0
- package/portal/tsconfig.json +41 -0
- package/portal/types/drawflow.d.ts +80 -0
- package/templates/README.md +73 -0
- package/templates/coverage.html +367 -0
- package/templates/dark-theme.css +443 -0
- package/templates/discussion/adr.yml.hbs +65 -0
- package/templates/discussion/handovers.yml.hbs +57 -0
- package/templates/discussion/knowledge.yml.hbs +60 -0
- package/templates/discussion/reports.yml.hbs +68 -0
- 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,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"}
|