@sk8metal/michi-cli 0.0.9 → 0.2.0
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.
- package/CHANGELOG.md +27 -0
- package/README.md +236 -57
- package/dist/scripts/__tests__/create-project.test.js +24 -28
- package/dist/scripts/__tests__/create-project.test.js.map +1 -1
- package/dist/scripts/__tests__/jira-transitions.test.d.ts +5 -0
- package/dist/scripts/__tests__/jira-transitions.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/jira-transitions.test.js +172 -0
- package/dist/scripts/__tests__/jira-transitions.test.js.map +1 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.js +14 -15
- package/dist/scripts/__tests__/multi-project-estimate.test.js.map +1 -1
- package/dist/scripts/__tests__/setup-existing-project.test.js +79 -0
- package/dist/scripts/__tests__/setup-existing-project.test.js.map +1 -1
- package/dist/scripts/__tests__/setup-interactive.test.js +23 -17
- package/dist/scripts/__tests__/setup-interactive.test.js.map +1 -1
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts +5 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.js +321 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.js.map +1 -0
- package/dist/scripts/__tests__/spec-loader.test.d.ts +5 -0
- package/dist/scripts/__tests__/spec-loader.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/spec-loader.test.js +153 -0
- package/dist/scripts/__tests__/spec-loader.test.js.map +1 -0
- package/dist/scripts/__tests__/validate-phase.test.js +109 -22
- package/dist/scripts/__tests__/validate-phase.test.js.map +1 -1
- package/dist/scripts/config/config-schema.d.ts +31 -0
- package/dist/scripts/config/config-schema.d.ts.map +1 -1
- package/dist/scripts/config/config-schema.js +64 -26
- package/dist/scripts/config/config-schema.js.map +1 -1
- package/dist/scripts/config-interactive.d.ts.map +1 -1
- package/dist/scripts/config-interactive.js +53 -38
- package/dist/scripts/config-interactive.js.map +1 -1
- package/dist/scripts/confluence-sync.d.ts.map +1 -1
- package/dist/scripts/confluence-sync.js +0 -11
- package/dist/scripts/confluence-sync.js.map +1 -1
- package/dist/scripts/constants/__tests__/environments.test.js +39 -5
- package/dist/scripts/constants/__tests__/environments.test.js.map +1 -1
- package/dist/scripts/constants/environments.d.ts +1 -1
- package/dist/scripts/constants/environments.d.ts.map +1 -1
- package/dist/scripts/constants/environments.js +22 -7
- package/dist/scripts/constants/environments.js.map +1 -1
- package/dist/scripts/constants/test-commands.d.ts +36 -0
- package/dist/scripts/constants/test-commands.d.ts.map +1 -0
- package/dist/scripts/constants/test-commands.js +70 -0
- package/dist/scripts/constants/test-commands.js.map +1 -0
- package/dist/scripts/jira-sync.d.ts +89 -3
- package/dist/scripts/jira-sync.d.ts.map +1 -1
- package/dist/scripts/jira-sync.js +366 -96
- package/dist/scripts/jira-sync.js.map +1 -1
- package/dist/scripts/markdown-to-confluence.js +1 -1
- package/dist/scripts/markdown-to-confluence.js.map +1 -1
- package/dist/scripts/phase-runner.d.ts +1 -1
- package/dist/scripts/phase-runner.d.ts.map +1 -1
- package/dist/scripts/phase-runner.js +809 -13
- package/dist/scripts/phase-runner.js.map +1 -1
- package/dist/scripts/pr-automation.d.ts.map +1 -1
- package/dist/scripts/pr-automation.js.map +1 -1
- package/dist/scripts/pre-flight-check.js +1 -1
- package/dist/scripts/pre-flight-check.js.map +1 -1
- package/dist/scripts/setup-existing-project.js +61 -29
- package/dist/scripts/setup-existing-project.js.map +1 -1
- package/dist/scripts/setup-interactive.js +3 -3
- package/dist/scripts/setup-interactive.js.map +1 -1
- package/dist/scripts/spec-impl-workflow.d.ts +94 -0
- package/dist/scripts/spec-impl-workflow.d.ts.map +1 -0
- package/dist/scripts/spec-impl-workflow.js +354 -0
- package/dist/scripts/spec-impl-workflow.js.map +1 -0
- package/dist/scripts/template/__tests__/renderer.test.js.map +1 -1
- package/dist/scripts/test-execution-generator.d.ts +52 -0
- package/dist/scripts/test-execution-generator.d.ts.map +1 -0
- package/dist/scripts/test-execution-generator.js +576 -0
- package/dist/scripts/test-execution-generator.js.map +1 -0
- package/dist/scripts/test-interactive.d.ts +10 -0
- package/dist/scripts/test-interactive.d.ts.map +1 -0
- package/dist/scripts/test-interactive.js +627 -0
- package/dist/scripts/test-interactive.js.map +1 -0
- package/dist/scripts/test-new-features.d.ts +5 -0
- package/dist/scripts/test-new-features.d.ts.map +1 -0
- package/dist/scripts/test-new-features.js +145 -0
- package/dist/scripts/test-new-features.js.map +1 -0
- package/dist/scripts/test-spec-generator.d.ts +29 -0
- package/dist/scripts/test-spec-generator.d.ts.map +1 -0
- package/dist/scripts/test-spec-generator.js +494 -0
- package/dist/scripts/test-spec-generator.js.map +1 -0
- package/dist/scripts/test-workflow-stages.d.ts +6 -0
- package/dist/scripts/test-workflow-stages.d.ts.map +1 -0
- package/dist/scripts/test-workflow-stages.js +43 -0
- package/dist/scripts/test-workflow-stages.js.map +1 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js +315 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/business-days.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/business-days.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/business-days.test.js +171 -0
- package/dist/scripts/utils/__tests__/business-days.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/config-loader.test.js +1 -1
- package/dist/scripts/utils/__tests__/config-loader.test.js.map +1 -1
- package/dist/scripts/utils/__tests__/config-validator.test.js +164 -35
- package/dist/scripts/utils/__tests__/config-validator.test.js.map +1 -1
- package/dist/scripts/utils/__tests__/env-config.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/env-config.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/env-config.test.js +218 -0
- package/dist/scripts/utils/__tests__/env-config.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js +202 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.js +500 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js +314 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/test-runner.test.js +64 -0
- package/dist/scripts/utils/__tests__/test-runner.test.js.map +1 -0
- package/dist/scripts/utils/aidlc-parser.d.ts +86 -0
- package/dist/scripts/utils/aidlc-parser.d.ts.map +1 -0
- package/dist/scripts/utils/aidlc-parser.js +208 -0
- package/dist/scripts/utils/aidlc-parser.js.map +1 -0
- package/dist/scripts/utils/business-days.d.ts +52 -0
- package/dist/scripts/utils/business-days.d.ts.map +1 -0
- package/dist/scripts/utils/business-days.js +98 -0
- package/dist/scripts/utils/business-days.js.map +1 -0
- package/dist/scripts/utils/ci-generator.d.ts +14 -0
- package/dist/scripts/utils/ci-generator.d.ts.map +1 -0
- package/dist/scripts/utils/ci-generator.js +61 -0
- package/dist/scripts/utils/ci-generator.js.map +1 -0
- package/dist/scripts/utils/config-loader.js +2 -2
- package/dist/scripts/utils/config-loader.js.map +1 -1
- package/dist/scripts/utils/config-validator.d.ts +7 -1
- package/dist/scripts/utils/config-validator.d.ts.map +1 -1
- package/dist/scripts/utils/config-validator.js +136 -23
- package/dist/scripts/utils/config-validator.js.map +1 -1
- package/dist/scripts/utils/confluence-approval.d.ts +46 -0
- package/dist/scripts/utils/confluence-approval.d.ts.map +1 -0
- package/dist/scripts/utils/confluence-approval.js +118 -0
- package/dist/scripts/utils/confluence-approval.js.map +1 -0
- package/dist/scripts/utils/confluence-hierarchy.d.ts.map +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js.map +1 -1
- package/dist/scripts/utils/docker-generator.d.ts +9 -0
- package/dist/scripts/utils/docker-generator.d.ts.map +1 -0
- package/dist/scripts/utils/docker-generator.js +132 -0
- package/dist/scripts/utils/docker-generator.js.map +1 -0
- package/dist/scripts/utils/docker-requirement-detector.d.ts +15 -0
- package/dist/scripts/utils/docker-requirement-detector.d.ts.map +1 -0
- package/dist/scripts/utils/docker-requirement-detector.js +124 -0
- package/dist/scripts/utils/docker-requirement-detector.js.map +1 -0
- package/dist/scripts/utils/env-config.d.ts +54 -0
- package/dist/scripts/utils/env-config.d.ts.map +1 -0
- package/dist/scripts/utils/env-config.js +414 -0
- package/dist/scripts/utils/env-config.js.map +1 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.d.ts +70 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.d.ts.map +1 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.js +147 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.js.map +1 -0
- package/dist/scripts/utils/language-detector.d.ts +14 -0
- package/dist/scripts/utils/language-detector.d.ts.map +1 -0
- package/dist/scripts/utils/language-detector.js +119 -0
- package/dist/scripts/utils/language-detector.js.map +1 -0
- package/dist/scripts/utils/markdown-parser.d.ts +55 -0
- package/dist/scripts/utils/markdown-parser.d.ts.map +1 -0
- package/dist/scripts/utils/markdown-parser.js +289 -0
- package/dist/scripts/utils/markdown-parser.js.map +1 -0
- package/dist/scripts/utils/project-detector.d.ts +17 -0
- package/dist/scripts/utils/project-detector.d.ts.map +1 -0
- package/dist/scripts/utils/project-detector.js +166 -0
- package/dist/scripts/utils/project-detector.js.map +1 -0
- package/dist/scripts/utils/project-finder.js +2 -2
- package/dist/scripts/utils/project-finder.js.map +1 -1
- package/dist/scripts/utils/release-notes-generator.d.ts +56 -0
- package/dist/scripts/utils/release-notes-generator.d.ts.map +1 -0
- package/dist/scripts/utils/release-notes-generator.js +162 -0
- package/dist/scripts/utils/release-notes-generator.js.map +1 -0
- package/dist/scripts/utils/spec-loader.d.ts +79 -0
- package/dist/scripts/utils/spec-loader.d.ts.map +1 -0
- package/dist/scripts/utils/spec-loader.js +80 -0
- package/dist/scripts/utils/spec-loader.js.map +1 -0
- package/dist/scripts/utils/spec-updater.d.ts +7 -0
- package/dist/scripts/utils/spec-updater.d.ts.map +1 -1
- package/dist/scripts/utils/spec-updater.js.map +1 -1
- package/dist/scripts/utils/tasks-converter.d.ts +57 -0
- package/dist/scripts/utils/tasks-converter.d.ts.map +1 -0
- package/dist/scripts/utils/tasks-converter.js +322 -0
- package/dist/scripts/utils/tasks-converter.js.map +1 -0
- package/dist/scripts/utils/tasks-format-validator.d.ts +36 -0
- package/dist/scripts/utils/tasks-format-validator.d.ts.map +1 -0
- package/dist/scripts/utils/tasks-format-validator.js +158 -0
- package/dist/scripts/utils/tasks-format-validator.js.map +1 -0
- package/dist/scripts/utils/template-applier.d.ts +37 -0
- package/dist/scripts/utils/template-applier.d.ts.map +1 -0
- package/dist/scripts/utils/template-applier.js +129 -0
- package/dist/scripts/utils/template-applier.js.map +1 -0
- package/dist/scripts/utils/test-config-generator.d.ts +12 -0
- package/dist/scripts/utils/test-config-generator.d.ts.map +1 -0
- package/dist/scripts/utils/test-config-generator.js +185 -0
- package/dist/scripts/utils/test-config-generator.js.map +1 -0
- package/dist/scripts/utils/test-runner.d.ts +31 -0
- package/dist/scripts/utils/test-runner.d.ts.map +1 -0
- package/dist/scripts/utils/test-runner.js +103 -0
- package/dist/scripts/utils/test-runner.js.map +1 -0
- package/dist/scripts/validate-phase.d.ts +1 -1
- package/dist/scripts/validate-phase.d.ts.map +1 -1
- package/dist/scripts/validate-phase.js +171 -8
- package/dist/scripts/validate-phase.js.map +1 -1
- package/dist/scripts/workflow-orchestrator.d.ts +8 -0
- package/dist/scripts/workflow-orchestrator.d.ts.map +1 -1
- package/dist/scripts/workflow-orchestrator.js +108 -7
- package/dist/scripts/workflow-orchestrator.js.map +1 -1
- package/dist/src/__tests__/integration/internationalization.test.d.ts +8 -0
- package/dist/src/__tests__/integration/internationalization.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/internationalization.test.js +333 -0
- package/dist/src/__tests__/integration/internationalization.test.js.map +1 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts +1 -1
- package/dist/src/__tests__/integration/setup/claude-agent.test.js +17 -20
- package/dist/src/__tests__/integration/setup/claude-agent.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/claude.test.js +82 -0
- package/dist/src/__tests__/integration/setup/claude.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/cursor.test.js +23 -19
- package/dist/src/__tests__/integration/setup/cursor.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/validation.test.js +41 -58
- package/dist/src/__tests__/integration/setup/validation.test.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +209 -18
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +4 -0
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +367 -47
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/docs/README.md +3 -1
- package/docs/context.md +59 -0
- package/docs/design-issue-55.md +240 -0
- package/docs/design-issue-56.md +181 -0
- package/docs/michi-development/testing/manual-verification-flow.md +2242 -0
- package/docs/michi-development/testing/pre-publish-checklist.md +560 -0
- package/docs/plan.md +275 -0
- package/docs/user-guide/getting-started/github-token-setup.md +509 -0
- package/docs/{getting-started → user-guide/getting-started}/quick-start.md +16 -0
- package/docs/{getting-started → user-guide/getting-started}/setup.md +28 -1
- package/docs/user-guide/guides/agent-skills-integration.md +217 -0
- package/docs/{guides → user-guide/guides}/customization.md +2 -2
- package/docs/user-guide/guides/internationalization.md +540 -0
- package/docs/{guides → user-guide/guides}/multi-project.md +3 -3
- package/docs/{guides → user-guide/guides}/phase-automation.md +92 -34
- package/docs/user-guide/guides/workflow.md +570 -0
- package/docs/user-guide/hands-on/README.md +142 -0
- package/docs/user-guide/hands-on/claude-agent-setup.md +455 -0
- package/docs/user-guide/hands-on/claude-setup.md +398 -0
- package/docs/user-guide/hands-on/cursor-setup.md +352 -0
- package/docs/user-guide/hands-on/troubleshooting.md +964 -0
- package/docs/user-guide/hands-on/verification-checklist.md +438 -0
- package/docs/user-guide/hands-on/workflow-walkthrough.md +906 -0
- package/docs/user-guide/reference/config.md +564 -0
- package/docs/{reference → user-guide/reference}/quick-reference.md +53 -40
- package/docs/{reference → user-guide/reference}/tasks-template.md +2 -2
- package/docs/user-guide/release/ci-setup.md +541 -0
- package/docs/user-guide/release/release-flow.md +476 -0
- package/docs/user-guide/templates/test-specs/README.md +173 -0
- package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +547 -0
- package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +435 -0
- package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +454 -0
- package/docs/user-guide/templates/test-specs/security-test-spec-template.md +664 -0
- package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +328 -0
- package/docs/{testing → user-guide/testing}/integration-tests.md +24 -9
- package/docs/user-guide/testing/tdd-cycle.md +349 -0
- package/docs/user-guide/testing/test-execution-flow.md +396 -0
- package/docs/user-guide/testing/test-failure-handling.md +521 -0
- package/docs/user-guide/testing/test-planning-flow.md +181 -0
- package/docs/user-guide/testing-strategy.md +185 -0
- package/docs/verification-guide.md +518 -0
- package/package.json +7 -2
- package/scripts/__tests__/create-project.test.ts +67 -49
- package/scripts/__tests__/jira-transitions.test.ts +225 -0
- package/scripts/__tests__/multi-project-estimate.test.ts +36 -30
- package/scripts/__tests__/setup-existing-project.test.ts +98 -1
- package/scripts/__tests__/setup-interactive.test.ts +52 -46
- package/scripts/__tests__/spec-impl-workflow.test.ts +429 -0
- package/scripts/__tests__/spec-loader.test.ts +199 -0
- package/scripts/__tests__/validate-phase.test.ts +178 -54
- package/scripts/config/config-schema.ts +100 -50
- package/scripts/config-interactive.ts +191 -136
- package/scripts/confluence-sync.ts +0 -12
- package/scripts/constants/__tests__/environments.test.ts +42 -6
- package/scripts/constants/environments.ts +33 -13
- package/scripts/constants/test-commands.ts +96 -0
- package/scripts/jira-sync.ts +767 -232
- package/scripts/markdown-to-confluence.ts +1 -1
- package/scripts/phase-runner.ts +1056 -63
- package/scripts/pr-automation.ts +0 -1
- package/scripts/pre-flight-check.ts +1 -1
- package/scripts/pre-publish-check.sh +311 -0
- package/scripts/quick-verify.sh +115 -0
- package/scripts/setup-existing-project.ts +201 -117
- package/scripts/setup-interactive.ts +4 -4
- package/scripts/spec-impl-workflow.ts +505 -0
- package/scripts/template/__tests__/renderer.test.ts +1 -2
- package/scripts/test-execution-generator.ts +695 -0
- package/scripts/test-interactive.ts +779 -0
- package/scripts/test-new-features.ts +168 -0
- package/scripts/test-npm-package.sh +345 -0
- package/scripts/test-spec-generator.ts +574 -0
- package/scripts/test-workflow-stages.ts +53 -0
- package/scripts/utils/__tests__/aidlc-parser.test.ts +349 -0
- package/scripts/utils/__tests__/business-days.test.ts +214 -0
- package/scripts/utils/__tests__/config-loader.test.ts +1 -1
- package/scripts/utils/__tests__/config-validator.test.ts +309 -88
- package/scripts/utils/__tests__/env-config.test.ts +259 -0
- package/scripts/utils/__tests__/jira-issue-type-fetcher.test.ts +272 -0
- package/scripts/utils/__tests__/tasks-converter.test.ts +582 -0
- package/scripts/utils/__tests__/tasks-format-validator.test.ts +338 -0
- package/scripts/utils/__tests__/test-runner.test.ts +77 -0
- package/scripts/utils/aidlc-parser.ts +289 -0
- package/scripts/utils/business-days.ts +115 -0
- package/scripts/utils/ci-generator.ts +84 -0
- package/scripts/utils/config-loader.ts +2 -2
- package/scripts/utils/config-validator.ts +304 -117
- package/scripts/utils/confluence-approval.ts +167 -0
- package/scripts/utils/confluence-hierarchy.ts +2 -4
- package/scripts/utils/docker-generator.ts +151 -0
- package/scripts/utils/docker-requirement-detector.ts +153 -0
- package/scripts/utils/env-config.ts +526 -0
- package/scripts/utils/jira-issue-type-fetcher.ts +199 -0
- package/scripts/utils/language-detector.ts +139 -0
- package/scripts/utils/markdown-parser.ts +376 -0
- package/scripts/utils/project-detector.ts +192 -0
- package/scripts/utils/project-finder.ts +2 -2
- package/scripts/utils/release-notes-generator.ts +210 -0
- package/scripts/utils/spec-loader.ts +125 -0
- package/scripts/utils/spec-updater.ts +8 -1
- package/scripts/utils/tasks-converter.ts +601 -0
- package/scripts/utils/tasks-format-validator.ts +193 -0
- package/scripts/utils/template-applier.ts +202 -0
- package/scripts/utils/test-config-generator.ts +210 -0
- package/scripts/utils/test-runner.ts +133 -0
- package/scripts/validate-phase.ts +207 -12
- package/scripts/workflow-orchestrator.ts +130 -12
- package/templates/ci/github-actions/java.yml +54 -0
- package/templates/ci/github-actions/nodejs.yml +46 -0
- package/templates/ci/github-actions/php.yml +52 -0
- package/templates/ci/screwdriver/java.yaml +17 -0
- package/templates/ci/screwdriver/nodejs.yaml +17 -0
- package/templates/ci/screwdriver/php.yaml +20 -0
- package/templates/claude/agents/design-reviewer/AGENT.md +497 -0
- package/templates/claude/agents/e2e-first-planner/AGENT.md +410 -0
- package/templates/claude/agents/oss-license-checker/AGENT.md +265 -0
- package/templates/claude/agents/pr-resolver/AGENT.md +196 -0
- package/templates/claude/agents/stable-version-auditor/AGENT.md +279 -0
- package/templates/claude/commands/kiro/kiro-spec-impl.md +253 -0
- package/templates/claude/commands/kiro/kiro-spec-tasks.md +368 -0
- package/templates/claude/commands/michi/design-review.md +66 -0
- package/templates/claude/commands/michi/e2e-plan.md +113 -0
- package/templates/claude/commands/michi/license-check.md +80 -0
- package/templates/claude/commands/michi/pr-resolve.md +153 -0
- package/templates/claude/commands/michi/version-audit.md +91 -0
- package/templates/claude/skills/design-review/SKILL.md +648 -0
- package/templates/claude/skills/e2e-first-planning/SKILL.md +360 -0
- package/templates/claude/skills/oss-license/SKILL.md +232 -0
- package/templates/claude/skills/stable-version/SKILL.md +252 -0
- package/templates/claude-agent/README.md +7 -1
- package/templates/claude-agent/agents/.gitkeep +0 -0
- package/templates/claude-agent/agents/designer.md +79 -0
- package/templates/claude-agent/agents/developer.md +68 -0
- package/templates/claude-agent/agents/manager-agent.md +59 -0
- package/templates/claude-agent/agents/tester.md +101 -0
- package/templates/claude-agent/commands/kiro/.gitkeep +0 -0
- package/templates/claude-agent/commands/kiro/kiro-spec-impl.md +244 -0
- package/templates/claude-agent/commands/kiro/kiro-spec-tasks.md +354 -0
- package/templates/cline/rules/atlassian-integration.md +36 -0
- package/templates/cline/rules/michi-core.md +56 -0
- package/templates/codex/AGENTS.override.md +277 -0
- package/templates/codex/prompts/confluence-sync.md +177 -0
- package/templates/codex/rules/README.md +210 -0
- package/templates/common/.kiro/project.json.template +21 -0
- package/templates/cursor/commands/kiro/kiro-spec-impl.md +244 -0
- package/templates/cursor/commands/kiro/kiro-spec-tasks.md +354 -0
- package/templates/gemini/commands/README.md +41 -0
- package/templates/gemini/rules/GEMINI.md +80 -0
- package/docs/guides/workflow.md +0 -342
- package/docs/reference/config.md +0 -545
- package/scripts/setup-existing.sh +0 -279
- /package/docs/{contributing → michi-development/contributing}/development.md +0 -0
- /package/docs/{contributing → michi-development/contributing}/release.md +0 -0
- /package/docs/{testing-strategy.md → michi-development/testing-strategy.md} +0 -0
- /package/docs/{getting-started → user-guide/getting-started}/new-repository-setup.md +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.0] - 2025-12-03
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **Codex統合**: Codex環境のcc-sdd統合とワークフロー機能拡張(#81)
|
|
12
|
+
- 検証ガイド(`docs/verification-guide.md`)
|
|
13
|
+
- クイック検証スクリプト(`scripts/quick-verify.sh`)
|
|
14
|
+
- 新機能テスト(`scripts/test-new-features.ts`)
|
|
15
|
+
- ワークフローステージテスト(`scripts/test-workflow-stages.ts`)
|
|
16
|
+
- Confluence承認ユーティリティ(`scripts/utils/confluence-approval.ts`)
|
|
17
|
+
- リリースノート生成ユーティリティ(`scripts/utils/release-notes-generator.ts`)
|
|
18
|
+
- テストランナー(`scripts/utils/test-runner.ts`とテストスイート)
|
|
19
|
+
- Codexテンプレート(`templates/codex/AGENTS.override.md`、`templates/codex/prompts/confluence-sync.md`)
|
|
20
|
+
- 共通プロジェクト設定テンプレート(`templates/common/.kiro/project.json.template`)
|
|
21
|
+
- **Kiro統合**: Claude Code/Claude AgentにkiroコードレビューとPR確認機能を追加(#79)
|
|
22
|
+
- **Kiro spec-impl**: コードレビューとPR作成確認を追加(#78)
|
|
23
|
+
- **Kiro spec-impl統合**: 統合ワークフローと関連機能を追加(#77)
|
|
24
|
+
- **マルチ環境サポート**: 対話型テスト実行とマルチ環境サポートを追加(#65)
|
|
25
|
+
- **新CLIサポート**: Gemini CLI、Codex CLI、Clineのサポートを追加(#64)
|
|
26
|
+
|
|
27
|
+
### Changed
|
|
28
|
+
- **依存関係更新**: inquirerを9.3.8から13.0.1にメジャーバージョンアップ(dependabot)
|
|
29
|
+
- **ワークフローオーケストレーター**: `scripts/workflow-orchestrator.ts`を機能拡張
|
|
30
|
+
- **setup-existingコマンド**: `src/commands/setup-existing.ts`を改善
|
|
31
|
+
|
|
32
|
+
### Refactored
|
|
33
|
+
- **コードクリーンアップ**: 不要なファイルを整理(#75)
|
|
34
|
+
|
|
8
35
|
## [0.0.9] - 2025-11-17
|
|
9
36
|
|
|
10
37
|
### Added
|
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# Michi (道)
|
|
2
|
+
|
|
2
3
|
**M**anaged **I**ntelligent **C**omprehensive **H**ub for **I**ntegration
|
|
3
4
|
|
|
4
5
|
AI駆動開発ワークフロー自動化プラットフォーム
|
|
@@ -12,15 +13,18 @@ AI駆動開発ワークフロー自動化プラットフォーム
|
|
|
12
13
|
|
|
13
14
|
Michiは、開発フロー全体(要件定義→設計→タスク分割→実装→テスト→リリース)をAIで自動化するプラットフォームです。
|
|
14
15
|
|
|
15
|
-
**Powered by [cc-sdd](https://github.com/gotalab/cc-sdd)**
|
|
16
|
+
**Powered by [cc-sdd](https://github.com/gotalab/cc-sdd)**
|
|
16
17
|
|
|
17
18
|
### 主な機能
|
|
19
|
+
|
|
18
20
|
- ✅ **AI駆動開発**: cc-sdd + Cursor/VS Code統合
|
|
21
|
+
- ✅ **多言語サポート**: 12言語対応(AI駆動、翻訳ファイル不要)
|
|
19
22
|
- ✅ **GitHub SSoT(Single Source Of True)**: GitHubを情報源として管理
|
|
20
23
|
- ✅ **Confluence/JIRA連携**: 承認者向けドキュメント、タスク管理
|
|
21
24
|
- ✅ **マルチプロジェクト対応**: 3-5プロジェクト同時進行
|
|
22
25
|
- ✅ **自動化スクリプト**: Markdown↔Confluence同期、JIRA連携、PR自動化
|
|
23
26
|
- ✅ **フェーズバリデーション**: フェーズ抜け漏れ防止の自動チェック
|
|
27
|
+
- ✅ **スキル・サブエージェント**: デザインレビュー、ライセンスチェック、バージョン監査、E2Eプランニング、PRレビュー対応
|
|
24
28
|
|
|
25
29
|
### アーキテクチャ
|
|
26
30
|
|
|
@@ -31,16 +35,108 @@ Confluence ← ドキュメント管理
|
|
|
31
35
|
JIRA ← タスク管理・進捗追跡
|
|
32
36
|
```
|
|
33
37
|
|
|
38
|
+
## ワークフロー構造の概要
|
|
39
|
+
|
|
40
|
+
### 新ワークフロー構造(推奨)
|
|
41
|
+
|
|
42
|
+
Michiは以下のフェーズで構成されています:
|
|
43
|
+
|
|
44
|
+
**Phase 0.0-0.6: 仕様化フェーズ**
|
|
45
|
+
|
|
46
|
+
- **Phase 0.0**: プロジェクト初期化
|
|
47
|
+
- **Phase 0.1**: 要件定義(Requirements) - 必須
|
|
48
|
+
- **Phase 0.2**: 設計(Design) - 必須
|
|
49
|
+
- **Phase 0.3**: テストタイプ選択(任意)
|
|
50
|
+
- **Phase 0.4**: テスト仕様書作成(任意)
|
|
51
|
+
- **Phase 0.5**: タスク分割 - 必須
|
|
52
|
+
- **Phase 0.6**: JIRA同期 - 必須
|
|
53
|
+
|
|
54
|
+
**Phase 1: 環境構築(任意)**
|
|
55
|
+
|
|
56
|
+
- テスト環境のセットアップ
|
|
57
|
+
- 開発環境の構築
|
|
58
|
+
|
|
59
|
+
**Phase 2: TDD実装(必須)**
|
|
60
|
+
|
|
61
|
+
- テスト駆動開発による実装
|
|
62
|
+
- RED-GREEN-REFACTORサイクル
|
|
63
|
+
|
|
64
|
+
**Phase A: PR前自動テスト(任意)**
|
|
65
|
+
|
|
66
|
+
- 単体テスト自動実行
|
|
67
|
+
- Lint自動実行
|
|
68
|
+
- ビルド自動実行
|
|
69
|
+
|
|
70
|
+
**Phase 3: 追加QA(任意)**
|
|
71
|
+
|
|
72
|
+
- 統合テスト
|
|
73
|
+
- E2Eテスト
|
|
74
|
+
|
|
75
|
+
**Phase B: リリース準備テスト(任意)**
|
|
76
|
+
|
|
77
|
+
- 手動テスト実行
|
|
78
|
+
- セキュリティテスト
|
|
79
|
+
- パフォーマンステスト
|
|
80
|
+
|
|
81
|
+
**Phase 4: リリース準備(必須)**
|
|
82
|
+
|
|
83
|
+
- 本番環境構築
|
|
84
|
+
- リリースドキュメント作成
|
|
85
|
+
|
|
86
|
+
**Phase 5: リリース(必須)**
|
|
87
|
+
|
|
88
|
+
- ステージング環境デプロイ
|
|
89
|
+
- 本番環境リリース
|
|
90
|
+
|
|
91
|
+
### レガシー6-Phaseサポート
|
|
92
|
+
|
|
93
|
+
後方互換性のため、従来のPhase 0-5構造(要件定義→設計→実装→試験→リリース準備→リリース)もサポートしています。既存プロジェクトはそのまま動作します。
|
|
94
|
+
|
|
95
|
+
詳細は [ワークフローガイド](./docs/user-guide/guides/workflow.md) を参照してください。
|
|
96
|
+
|
|
97
|
+
### 対応プロジェクト
|
|
98
|
+
|
|
99
|
+
Michiは**言語非依存**で、どんなプロジェクトでも使用できます:
|
|
100
|
+
|
|
101
|
+
- ✅ **Java**(Maven/Gradle)
|
|
102
|
+
- ✅ **Python**(pip/poetry/uv)
|
|
103
|
+
- ✅ **Go**(go mod)
|
|
104
|
+
- ✅ **Node.js**(npm/yarn/pnpm)
|
|
105
|
+
- ✅ **Rust**(Cargo)
|
|
106
|
+
- ✅ **PHP**(Composer)
|
|
107
|
+
- ✅ **Ruby**(Bundler)
|
|
108
|
+
- ✅ その他あらゆる言語
|
|
109
|
+
|
|
110
|
+
**重要**: Michiは`package.json`を要求しません。プロジェクトの設定は`.kiro/project.json`で完結します。
|
|
111
|
+
|
|
34
112
|
## クイックスタート
|
|
35
113
|
|
|
36
114
|
### 前提条件
|
|
37
115
|
|
|
38
|
-
- Node.js 20.x
|
|
116
|
+
- Node.js 20.x以上(Michi CLIの実行に必要。プロジェクト自体はNode.jsでなくてもOK)
|
|
39
117
|
- Git(または Jujutsu (jj) も使用可能)
|
|
40
|
-
-
|
|
118
|
+
- **AI開発環境**(以下のいずれか):
|
|
119
|
+
- [Cursor IDE](https://cursor.sh/) (推奨)
|
|
120
|
+
- [Claude Code](https://claude.com/claude-code)
|
|
121
|
+
- [Gemini CLI](https://geminicli.com/)
|
|
122
|
+
- [Codex CLI](https://developers.openai.com/codex/cli)
|
|
123
|
+
- [Cline](https://cline.bot/) (VSCode拡張)
|
|
124
|
+
- VSCode + 他のAI拡張
|
|
41
125
|
- GitHub CLI (gh) - PR作成時に使用
|
|
126
|
+
- **GitHub Personal Access Token** - GitHub連携に必要([作成ガイド](./docs/user-guide/getting-started/github-token-setup.md))
|
|
42
127
|
- **cc-sdd**: AI駆動開発ワークフローのコアフレームワーク
|
|
43
128
|
|
|
129
|
+
**重要な注意事項**:
|
|
130
|
+
|
|
131
|
+
- ⚠️ **セットアップ時にテンプレートファイルが不足している場合、エラーが発生します**
|
|
132
|
+
- 最新のMichiをインストールしてください
|
|
133
|
+
- エラーが発生した場合は[トラブルシューティング](./docs/hands-on/troubleshooting.md)を参照
|
|
134
|
+
- ⚠️ **tasks.mdのフォーマットが間違っているとJIRA同期が失敗します**
|
|
135
|
+
- 新ワークフロー構造では必須フェーズ(Phase 0.1, 0.2, 2, 4, 5)が必要です
|
|
136
|
+
- レガシー構造では全6フェーズ(Phase 0-5)が必須です
|
|
137
|
+
- AIコマンド実行時は必ずテンプレートを参照するよう指示してください
|
|
138
|
+
- 詳細: [tasks.mdフォーマット問題](./docs/hands-on/troubleshooting.md#問題-tasksmdのフォーマットが間違っているformat-validation-error)
|
|
139
|
+
|
|
44
140
|
### インストール
|
|
45
141
|
|
|
46
142
|
#### 方法1: NPMパッケージとしてインストール(推奨)
|
|
@@ -106,14 +202,14 @@ cp env.example .env
|
|
|
106
202
|
**AIコマンド + CLIツール実行** で抜け漏れを防止:
|
|
107
203
|
|
|
108
204
|
```bash
|
|
109
|
-
# Phase 0:
|
|
205
|
+
# Phase 0.0: プロジェクト初期化
|
|
110
206
|
# 凡例
|
|
111
207
|
/kiro:spec-init <機能説明>
|
|
112
208
|
|
|
113
209
|
# 具体例
|
|
114
210
|
/kiro:spec-init ユーザー認証機能
|
|
115
211
|
|
|
116
|
-
# Phase 1: 要件定義
|
|
212
|
+
# Phase 0.1: 要件定義
|
|
117
213
|
# 凡例
|
|
118
214
|
/kiro:spec-requirements <feature> # AIで requirements.md 作成
|
|
119
215
|
npx @sk8metal/michi-cli phase:run <feature> requirements # Confluence作成+バリデーション(必須)
|
|
@@ -122,7 +218,7 @@ npx @sk8metal/michi-cli phase:run <feature> requirements # Confluence作成
|
|
|
122
218
|
/kiro:spec-requirements user-auth # AIで requirements.md 作成
|
|
123
219
|
npx @sk8metal/michi-cli phase:run user-auth requirements # Confluence作成+バリデーション(必須)
|
|
124
220
|
|
|
125
|
-
# Phase 2: 設計
|
|
221
|
+
# Phase 0.2: 設計
|
|
126
222
|
# 凡例
|
|
127
223
|
/kiro:spec-design <feature> # AIで design.md 作成
|
|
128
224
|
npx @sk8metal/michi-cli phase:run <feature> design # Confluence作成+バリデーション(必須)
|
|
@@ -131,32 +227,46 @@ npx @sk8metal/michi-cli phase:run <feature> design # Confluence作成
|
|
|
131
227
|
/kiro:spec-design user-auth # AIで design.md 作成
|
|
132
228
|
npx @sk8metal/michi-cli phase:run user-auth design # Confluence作成+バリデーション(必須)
|
|
133
229
|
|
|
134
|
-
# Phase 3:
|
|
230
|
+
# Phase 0.3-0.4: テスト計画(任意)
|
|
231
|
+
# プロジェクトに応じてテストタイプを選択し、テスト仕様書を作成
|
|
232
|
+
# 詳細: docs/user-guide/testing/test-planning-flow.md
|
|
233
|
+
|
|
234
|
+
# Phase 0.5-0.6: タスク分割とJIRA同期
|
|
135
235
|
# 凡例
|
|
136
|
-
/kiro:spec-tasks <feature> # AIで tasks.md
|
|
236
|
+
/kiro:spec-tasks <feature> # AIで tasks.md 作成(全フェーズ)
|
|
137
237
|
npx @sk8metal/michi-cli phase:run <feature> tasks # 全フェーズのJIRA作成+バリデーション(必須)
|
|
138
238
|
|
|
139
239
|
# 具体例
|
|
140
|
-
/kiro:spec-tasks user-auth # AIで tasks.md
|
|
240
|
+
/kiro:spec-tasks user-auth # AIで tasks.md 作成(全フェーズ)
|
|
141
241
|
npx @sk8metal/michi-cli phase:run user-auth tasks # 全フェーズのJIRA作成+バリデーション(必須)
|
|
142
242
|
|
|
143
|
-
# Phase
|
|
243
|
+
# Phase 1: 環境構築(任意)
|
|
244
|
+
# テスト環境のセットアップ、開発環境の構築
|
|
245
|
+
|
|
246
|
+
# Phase 2: TDD実装
|
|
144
247
|
# 凡例
|
|
145
248
|
/kiro:spec-impl <feature> # TDD実装開始
|
|
146
249
|
|
|
147
250
|
# 具体例
|
|
148
251
|
/kiro:spec-impl user-auth # TDD実装開始
|
|
149
252
|
|
|
150
|
-
# Phase
|
|
151
|
-
#
|
|
253
|
+
# Phase A: PR前自動テスト(任意)
|
|
254
|
+
# CI/CDで自動実行される単体テスト、Lint、ビルド
|
|
255
|
+
|
|
256
|
+
# Phase 3: 追加QA(任意)
|
|
257
|
+
# tasks.mdに従って統合テスト、E2Eテストを実施
|
|
258
|
+
|
|
259
|
+
# Phase B: リリース準備テスト(任意)
|
|
260
|
+
# 手動テスト、セキュリティテスト、パフォーマンステストを実施
|
|
152
261
|
|
|
153
|
-
# Phase
|
|
262
|
+
# Phase 4-5: リリース準備・リリース
|
|
154
263
|
# tasks.mdのPhase 4-5に従ってリリース準備・本番リリース
|
|
155
264
|
```
|
|
156
265
|
|
|
157
|
-
**重要**:
|
|
266
|
+
**重要**: Phase 0.1, 0.2, 0.5-0.6では `npx @sk8metal/michi-cli phase:run` を実行しないと、Confluence/JIRAが作成されず、承認者がレビューできません。
|
|
158
267
|
|
|
159
268
|
**CLIツールの使用方法**:
|
|
269
|
+
|
|
160
270
|
- **npx実行(推奨)**: `npx @sk8metal/michi-cli <command>` - 常に最新版を使用
|
|
161
271
|
- **グローバルインストール**: `npm install -g @sk8metal/michi-cli` 後、`michi <command>` で実行
|
|
162
272
|
- **ローカル開発**: `npm run michi <command>` または `npx tsx src/cli.ts <command>`
|
|
@@ -189,6 +299,27 @@ npx @sk8metal/michi-cli project:list # プロジェ
|
|
|
189
299
|
npx @sk8metal/michi-cli workflow:run --feature user-auth # ワークフロー実行
|
|
190
300
|
```
|
|
191
301
|
|
|
302
|
+
### 実装フェーズ(JIRA連携)
|
|
303
|
+
|
|
304
|
+
```bash
|
|
305
|
+
# AIコマンドで実装(JIRA連携は自動)
|
|
306
|
+
# /kiro:spec-impl user-auth
|
|
307
|
+
# ↑ spec.json から JIRA 情報を自動取得
|
|
308
|
+
# ↑ Epic + 最初の Story を「進行中」に移動
|
|
309
|
+
# ↑ TDD 実装
|
|
310
|
+
# ↑ PR 作成
|
|
311
|
+
# ↑ Epic + 最初の Story を「レビュー待ち」に移動
|
|
312
|
+
# ↑ PR リンクを JIRA にコメント
|
|
313
|
+
|
|
314
|
+
# 個別のJIRA操作(必要な場合のみ)
|
|
315
|
+
npx @sk8metal/michi-cli jira:transition <issueKey> <status>
|
|
316
|
+
npx @sk8metal/michi-cli jira:comment <issueKey> <comment>
|
|
317
|
+
|
|
318
|
+
# 具体例
|
|
319
|
+
npx @sk8metal/michi-cli jira:transition MICHI-123 "In Progress"
|
|
320
|
+
npx @sk8metal/michi-cli jira:comment MICHI-123 "PRを作成しました: https://github.com/..."
|
|
321
|
+
```
|
|
322
|
+
|
|
192
323
|
## プロジェクト構造
|
|
193
324
|
|
|
194
325
|
```text
|
|
@@ -229,14 +360,14 @@ Michiは**cc-sdd準拠の多環境対応**を目指しています:
|
|
|
229
360
|
|
|
230
361
|
#### プレースホルダー一覧
|
|
231
362
|
|
|
232
|
-
| プレースホルダー
|
|
233
|
-
|
|
234
|
-
| `{{LANG_CODE}}`
|
|
235
|
-
| `{{DEV_GUIDELINES}}` | 言語別AI指示
|
|
236
|
-
| `{{KIRO_DIR}}`
|
|
237
|
-
| `{{AGENT_DIR}}`
|
|
238
|
-
| `{{PROJECT_ID}}`
|
|
239
|
-
| `{{FEATURE_NAME}}`
|
|
363
|
+
| プレースホルダー | 説明 | 例 |
|
|
364
|
+
| -------------------- | ---------------- | ---------------------------------------- |
|
|
365
|
+
| `{{LANG_CODE}}` | 言語コード | ja, en |
|
|
366
|
+
| `{{DEV_GUIDELINES}}` | 言語別AI指示 | "Think in English, generate in Japanese" |
|
|
367
|
+
| `{{KIRO_DIR}}` | 仕様書ルート | .kiro |
|
|
368
|
+
| `{{AGENT_DIR}}` | エージェント設定 | .claude |
|
|
369
|
+
| `{{PROJECT_ID}}` | プロジェクトID | michi |
|
|
370
|
+
| `{{FEATURE_NAME}}` | 機能名 | user-auth |
|
|
240
371
|
|
|
241
372
|
#### テンプレート例
|
|
242
373
|
|
|
@@ -244,24 +375,27 @@ Michiは**cc-sdd準拠の多環境対応**を目指しています:
|
|
|
244
375
|
# Michi Core Principles
|
|
245
376
|
|
|
246
377
|
## Development Guidelines
|
|
378
|
+
|
|
247
379
|
{{DEV_GUIDELINES}}
|
|
248
380
|
|
|
249
381
|
## Language
|
|
382
|
+
|
|
250
383
|
All generated documents should be in: **{{LANG_CODE}}**
|
|
251
384
|
|
|
252
385
|
## Project Metadata
|
|
386
|
+
|
|
253
387
|
- Project ID: {{PROJECT_ID}}
|
|
254
388
|
- Kiro directory: {{KIRO_DIR}}
|
|
255
389
|
- Agent directory: {{AGENT_DIR}}
|
|
256
390
|
```
|
|
257
391
|
|
|
258
392
|
**利点:**
|
|
393
|
+
|
|
259
394
|
- ✅ 静的翻訳ファイル不要(メンテナンスコスト削減)
|
|
260
395
|
- ✅ cc-sddとの完全互換
|
|
261
396
|
- ✅ Cursor/Claude両環境で動作
|
|
262
397
|
- ✅ プロジェクト固有値の動的生成
|
|
263
398
|
|
|
264
|
-
|
|
265
399
|
### 設定ファイル
|
|
266
400
|
|
|
267
401
|
OSS公開に対応するため、以下のテンプレートファイルを用意しています:
|
|
@@ -271,7 +405,6 @@ OSS公開に対応するため、以下のテンプレートファイルを用
|
|
|
271
405
|
- GitHub認証情報
|
|
272
406
|
- プロジェクト固有設定
|
|
273
407
|
- **ワークフロー承認ゲート設定**(オプション)
|
|
274
|
-
|
|
275
408
|
- **`mcp.json.example`**: MCP設定テンプレート
|
|
276
409
|
- Cursor/VS Code用のAtlassian MCP設定
|
|
277
410
|
|
|
@@ -283,6 +416,7 @@ OSS公開に対応するため、以下のテンプレートファイルを用
|
|
|
283
416
|
- **注意**: 以前は `.kiro/config.json` を使用していましたが、Michi専用の設定ファイルとして `.michi/config.json` に変更されました。
|
|
284
417
|
|
|
285
418
|
**初回セットアップ時:**
|
|
419
|
+
|
|
286
420
|
```bash
|
|
287
421
|
# 環境変数を設定
|
|
288
422
|
cp env.example .env
|
|
@@ -371,29 +505,62 @@ npm run setup:interactive
|
|
|
371
505
|
#### Gemini CLI
|
|
372
506
|
|
|
373
507
|
```bash
|
|
374
|
-
# Step 1: cc-sdd
|
|
375
|
-
npx cc-sdd@latest --gemini --lang ja
|
|
508
|
+
# Step 1: cc-sdd導入(準備中 - 現在はスキップ可能)
|
|
509
|
+
# npx cc-sdd@latest --gemini --lang ja
|
|
376
510
|
|
|
377
|
-
# Step 2: Michi
|
|
378
|
-
npx @sk8metal/michi-cli setup-existing --
|
|
511
|
+
# Step 2: Michi固有ファイル追加
|
|
512
|
+
npx @sk8metal/michi-cli setup-existing --gemini --lang ja
|
|
379
513
|
|
|
380
514
|
# Step 3: 環境設定
|
|
381
515
|
npm run setup:interactive
|
|
382
516
|
```
|
|
383
517
|
|
|
518
|
+
**Gemini CLI特有の機能**:
|
|
519
|
+
|
|
520
|
+
- `.gemini/GEMINI.md` - プロジェクトコンテキスト(階層的ロード対応)
|
|
521
|
+
- `.gemini/extensions/` - 拡張機能
|
|
522
|
+
|
|
384
523
|
#### Codex CLI
|
|
385
524
|
|
|
386
525
|
```bash
|
|
387
|
-
# Step 1: cc-sdd
|
|
388
|
-
npx cc-sdd@
|
|
526
|
+
# Step 1: cc-sdd導入(必須)
|
|
527
|
+
npx cc-sdd@latest --codex --lang ja
|
|
389
528
|
|
|
390
|
-
# Step 2: Michi
|
|
391
|
-
npx @sk8metal/michi-cli setup-existing --
|
|
529
|
+
# Step 2: Michi拡張をインストール
|
|
530
|
+
npx @sk8metal/michi-cli setup-existing --codex --lang ja
|
|
392
531
|
|
|
393
532
|
# Step 3: 環境設定
|
|
394
533
|
npm run setup:interactive
|
|
395
534
|
```
|
|
396
535
|
|
|
536
|
+
**Codex CLI + cc-sdd統合**:
|
|
537
|
+
|
|
538
|
+
- ✅ **完全対応**: cc-sddとの統合により、Michiワークフロー全機能をサポート
|
|
539
|
+
- ✅ **11個の /kiro:* コマンド**: cc-sddが提供(spec-init, requirements, design, tasks, impl など)
|
|
540
|
+
- ✅ **1個の /prompts:confluence-sync コマンド**: Michi独自(Confluence連携)
|
|
541
|
+
- ✅ **AGENTS.md**: プロジェクトコンテキスト(cc-sdd提供 + Michi拡張)
|
|
542
|
+
- ✅ **`.kiro/` ディレクトリ**: Spec-Driven Development構造
|
|
543
|
+
|
|
544
|
+
**詳細**: `templates/codex/rules/README.md` を参照
|
|
545
|
+
|
|
546
|
+
#### Cline (VSCode拡張)
|
|
547
|
+
|
|
548
|
+
```bash
|
|
549
|
+
# Step 1: VSCodeにCline拡張をインストール
|
|
550
|
+
# https://marketplace.visualstudio.com/items?itemName=saoudrizwan.claude-dev
|
|
551
|
+
|
|
552
|
+
# Step 2: Michi固有ファイル追加
|
|
553
|
+
npx @sk8metal/michi-cli setup-existing --cline --lang ja
|
|
554
|
+
|
|
555
|
+
# Step 3: 環境設定
|
|
556
|
+
npm run setup:interactive
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
**Cline特有の機能**:
|
|
560
|
+
|
|
561
|
+
- `.clinerules/rules/` - プロジェクト固有のルール(Markdown形式)
|
|
562
|
+
- ルールのトグル機能(v3.13以降)- 各ルールファイルを個別に有効/無効化可能
|
|
563
|
+
|
|
397
564
|
#### Windsurf IDE
|
|
398
565
|
|
|
399
566
|
```bash
|
|
@@ -424,6 +591,7 @@ npm run setup:interactive
|
|
|
424
591
|
```
|
|
425
592
|
|
|
426
593
|
**自動的に追加されるもの**:
|
|
594
|
+
|
|
427
595
|
- 共通ルール(`.cursor/rules/`または`.claude/rules/`)
|
|
428
596
|
- Michi専用コマンド(`.cursor/commands/michi/`または`.claude/commands/michi/`)
|
|
429
597
|
- Steeringテンプレート(`.kiro/steering/`)
|
|
@@ -454,21 +622,27 @@ npm run create-project -- \
|
|
|
454
622
|
## ドキュメント
|
|
455
623
|
|
|
456
624
|
### はじめに
|
|
625
|
+
|
|
457
626
|
- [クイックスタート](./docs/getting-started/quick-start.md) - 5分で始める ⭐
|
|
458
627
|
- [セットアップガイド](./docs/getting-started/setup.md) - インストール・設定手順
|
|
459
628
|
- [新規リポジトリセットアップ](./docs/getting-started/new-repository-setup.md) - 新規リポジトリでの開始方法
|
|
629
|
+
- **[ハンズオンガイド](./docs/hands-on/README.md)** - 実際に手を動かして学ぶ1時間のチュートリアル ⭐
|
|
460
630
|
|
|
461
631
|
### 実践ガイド
|
|
632
|
+
|
|
462
633
|
- [ワークフローガイド](./docs/guides/workflow.md) - AI開発フロー ⭐
|
|
463
634
|
- [フェーズ自動化ガイド](./docs/guides/phase-automation.md) - Confluence/JIRA自動作成 ⭐
|
|
464
635
|
- [マルチプロジェクト管理](./docs/guides/multi-project.md) - 複数プロジェクト管理
|
|
465
636
|
- [カスタマイズガイド](./docs/guides/customization.md) - Confluence/JIRA階層構造のカスタマイズ
|
|
637
|
+
- [多言語サポートガイド](./docs/guides/internationalization.md) - AI駆動多言語対応(12言語サポート) ⭐
|
|
466
638
|
|
|
467
639
|
### リファレンス
|
|
640
|
+
|
|
468
641
|
- [クイックリファレンス](./docs/reference/quick-reference.md) - コマンド一覧、チートシート ⭐
|
|
469
642
|
- [設定値リファレンス](./docs/reference/config.md) - `.michi/config.json`の全設定値の説明
|
|
470
643
|
|
|
471
644
|
### コントリビューター向け
|
|
645
|
+
|
|
472
646
|
- [コントリビューションガイド](./CONTRIBUTING.md) - 貢献方法
|
|
473
647
|
- [開発環境セットアップ](./docs/contributing/development.md) - 開発者向けセットアップ
|
|
474
648
|
- [リリース手順](./docs/contributing/release.md) - バージョンアップ・NPM公開手順
|
|
@@ -476,7 +650,6 @@ npm run create-project -- \
|
|
|
476
650
|
|
|
477
651
|
すべてのドキュメントは [docs/README.md](./docs/README.md) から参照できます。
|
|
478
652
|
|
|
479
|
-
|
|
480
653
|
## CI/CD
|
|
481
654
|
|
|
482
655
|
このプロジェクトでは、GitHub Actionsを使用してCI/CDパイプラインを構築しています。
|
|
@@ -503,6 +676,7 @@ npm run create-project -- \
|
|
|
503
676
|
**設定手順**: [NPM_TOKEN設定ガイド](./docs/contributing/npm-token-setup.md)
|
|
504
677
|
|
|
505
678
|
**設定内容**:
|
|
679
|
+
|
|
506
680
|
1. NPMアカウントでAutomation Tokenを生成
|
|
507
681
|
2. GitHub Secretsに`NPM_TOKEN`を追加
|
|
508
682
|
|
|
@@ -560,26 +734,28 @@ Copyright (c) 2025 sk8metalme
|
|
|
560
734
|
|
|
561
735
|
ドキュメント内で使用している記号の意味:
|
|
562
736
|
|
|
563
|
-
| 記号
|
|
564
|
-
|
|
565
|
-
| `<feature>`
|
|
566
|
-
| `<project-id>`
|
|
567
|
-
| `<project-name>` | プロジェクト名
|
|
568
|
-
| `<phase>`
|
|
569
|
-
| `<tasks>`
|
|
570
|
-
| `<doc-type>`
|
|
571
|
-
| `<jira-key>`
|
|
737
|
+
| 記号 | 説明 | 例 |
|
|
738
|
+
| ---------------- | -------------------- | -------------------------------- |
|
|
739
|
+
| `<feature>` | 機能名 | user-auth, health-check-endpoint |
|
|
740
|
+
| `<project-id>` | プロジェクトID | michi, 20240115-payment-api |
|
|
741
|
+
| `<project-name>` | プロジェクト名 | Michi, プロジェクトA |
|
|
742
|
+
| `<phase>` | フェーズ名 | requirements, design, tasks |
|
|
743
|
+
| `<tasks>` | タスクID | FE-1,BE-1, STORY-1 |
|
|
744
|
+
| `<doc-type>` | ドキュメント種類 | requirements, design, tasks |
|
|
745
|
+
| `<jira-key>` | JIRAプロジェクトキー | MICHI, PRJA |
|
|
572
746
|
|
|
573
747
|
### 凡例と具体例の読み方
|
|
574
748
|
|
|
575
749
|
ドキュメント内のコマンド例は「凡例」と「具体例」を併記しています:
|
|
576
750
|
|
|
577
751
|
**凡例**: 汎用的なパターン(記号を使用)
|
|
752
|
+
|
|
578
753
|
```bash
|
|
579
754
|
/kiro:spec-requirements <feature>
|
|
580
755
|
```
|
|
581
756
|
|
|
582
757
|
**具体例**: 実際の使用例
|
|
758
|
+
|
|
583
759
|
```bash
|
|
584
760
|
/kiro:spec-requirements user-auth
|
|
585
761
|
```
|
|
@@ -592,19 +768,20 @@ Copyright (c) 2025 sk8metalme
|
|
|
592
768
|
|
|
593
769
|
feature名は以下の場所で使用されるため、**英語・小文字・ハイフン区切り**が必須です:
|
|
594
770
|
|
|
595
|
-
| 使用箇所
|
|
596
|
-
|
|
597
|
-
| ディレクトリ名
|
|
598
|
-
| GitHub URL
|
|
599
|
-
| Confluenceラベル | `user-auth`
|
|
600
|
-
| JIRA Epic検索
|
|
601
|
-
| ブランチ名
|
|
771
|
+
| 使用箇所 | 例 | 制約理由 |
|
|
772
|
+
| ---------------- | ------------------------------------- | ---------------------- |
|
|
773
|
+
| ディレクトリ名 | `.kiro/specs/user-auth/` | ファイルシステム互換性 |
|
|
774
|
+
| GitHub URL | `.../specs/user-auth/requirements.md` | URLセーフ |
|
|
775
|
+
| Confluenceラベル | `user-auth` | ラベル検索・フィルタ |
|
|
776
|
+
| JIRA Epic検索 | `labels = "user-auth"` | JQLクエリ |
|
|
777
|
+
| ブランチ名 | `michi/feature/user-auth` | Git命名規則 |
|
|
602
778
|
|
|
603
779
|
#### 命名ルール
|
|
604
780
|
|
|
605
781
|
**形式**: 英語、kebab-case(ハイフン区切り)、小文字のみ
|
|
606
782
|
|
|
607
783
|
**ルール**:
|
|
784
|
+
|
|
608
785
|
- 2-4単語推奨
|
|
609
786
|
- 英数字とハイフン(`-`)のみ使用
|
|
610
787
|
- スペース、アンダースコア、日本語は不可
|
|
@@ -612,14 +789,14 @@ feature名は以下の場所で使用されるため、**英語・小文字・
|
|
|
612
789
|
|
|
613
790
|
#### 変換例
|
|
614
791
|
|
|
615
|
-
| spec-init(日本語説明)
|
|
616
|
-
|
|
617
|
-
| ユーザー認証機能
|
|
618
|
-
| OAuth 2.0を使った認証
|
|
619
|
-
| 支払い処理機能
|
|
620
|
-
| ヘルスチェックエンドポイント | `health-check-endpoint`
|
|
621
|
-
| 商品検索API
|
|
622
|
-
| 在庫管理システム
|
|
792
|
+
| spec-init(日本語説明) | spec-requirements以降(feature名) |
|
|
793
|
+
| ---------------------------- | ---------------------------------- |
|
|
794
|
+
| ユーザー認証機能 | `user-auth` |
|
|
795
|
+
| OAuth 2.0を使った認証 | `oauth-auth` |
|
|
796
|
+
| 支払い処理機能 | `payment` |
|
|
797
|
+
| ヘルスチェックエンドポイント | `health-check-endpoint` |
|
|
798
|
+
| 商品検索API | `product-search-api` |
|
|
799
|
+
| 在庫管理システム | `inventory-management` |
|
|
623
800
|
|
|
624
801
|
#### 変換のコツ
|
|
625
802
|
|
|
@@ -631,11 +808,13 @@ feature名は以下の場所で使用されるため、**英語・小文字・
|
|
|
631
808
|
#### 良い例・悪い例
|
|
632
809
|
|
|
633
810
|
✅ **良い例**:
|
|
811
|
+
|
|
634
812
|
- `user-auth` - 短く明確
|
|
635
813
|
- `payment-processing` - 具体的
|
|
636
814
|
- `health-check` - 標準的な用語
|
|
637
815
|
|
|
638
816
|
❌ **悪い例**:
|
|
817
|
+
|
|
639
818
|
- `ユーザー認証` - 日本語(URL/ラベルに不適)
|
|
640
819
|
- `user_auth` - アンダースコア(kebab-caseではない)
|
|
641
820
|
- `UserAuth` - CamelCase(kebab-caseではない)
|