@sk8metal/michi-cli 0.10.1 → 0.11.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.
Files changed (104) hide show
  1. package/README.md +77 -847
  2. package/dist/scripts/phase-runner.js +1 -1
  3. package/dist/scripts/phase-runner.js.map +1 -1
  4. package/dist/scripts/utils/multi-repo-validator.d.ts +18 -0
  5. package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
  6. package/dist/scripts/utils/multi-repo-validator.js +42 -0
  7. package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
  8. package/dist/scripts/utils/tasks-format-validator.js +3 -3
  9. package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
  10. package/docs/README.md +20 -83
  11. package/docs/getting-started/configuration.md +379 -0
  12. package/docs/getting-started/installation.md +59 -0
  13. package/docs/getting-started/quick-start.md +76 -0
  14. package/docs/guides/ai-tools.md +311 -0
  15. package/docs/guides/atlassian-integration.md +116 -0
  16. package/docs/guides/claude-code.md +155 -0
  17. package/docs/guides/multi-repo.md +117 -0
  18. package/docs/guides/workflow.md +382 -0
  19. package/docs/reference/ai-commands.md +92 -0
  20. package/docs/reference/cli.md +756 -0
  21. package/docs/reference/environment-variables.md +192 -0
  22. package/docs/troubleshooting.md +543 -0
  23. package/package.json +1 -1
  24. package/scripts/phase-runner.ts +1 -1
  25. package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
  26. package/scripts/utils/multi-repo-validator.ts +50 -0
  27. package/scripts/utils/tasks-format-validator.ts +3 -3
  28. package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
  29. package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
  30. package/templates/claude/commands/michi/e2e-plan.md +1 -1
  31. package/templates/claude/commands/michi/spec-design.md +2 -2
  32. package/templates/claude/commands/michi/spec-tasks.md +156 -0
  33. package/templates/claude/commands/michi/test-planning.md +1 -1
  34. package/templates/claude/commands/michi/validate-design.md +3 -3
  35. package/templates/claude/commands/michi-multi-repo/impl-all.md +30 -1
  36. package/templates/claude/commands/michi-multi-repo/propagate-specs.md +14 -1
  37. package/templates/claude/commands/michi-multi-repo/spec-review.md +16 -2
  38. package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
  39. package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
  40. package/templates/claude-agent/rules/code-size-monitor.md +26 -0
  41. package/templates/claude-agent/rules/code-size-rules.md +32 -0
  42. package/templates/codex/AGENTS.override.md +1 -1
  43. package/templates/codex/rules/README.md +2 -2
  44. package/templates/cursor/commands/michi/spec-tasks.md +117 -0
  45. package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
  46. package/docs/context.md +0 -59
  47. package/docs/michi-development/contributing/development.md +0 -341
  48. package/docs/michi-development/contributing/release.md +0 -365
  49. package/docs/michi-development/design/config-unification.md +0 -733
  50. package/docs/michi-development/design/design-config-current-state.md +0 -330
  51. package/docs/michi-development/design/design-config-implementation.md +0 -628
  52. package/docs/michi-development/design/design-config-migration.md +0 -952
  53. package/docs/michi-development/design/design-config-security.md +0 -771
  54. package/docs/michi-development/design/design-config-solution.md +0 -583
  55. package/docs/michi-development/design/design-config-testing.md +0 -892
  56. package/docs/michi-development/testing/manual-verification-flow.md +0 -871
  57. package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
  58. package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
  59. package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
  60. package/docs/michi-development/testing-strategy.md +0 -87
  61. package/docs/plan.md +0 -275
  62. package/docs/user-guide/getting-started/github-token-setup.md +0 -510
  63. package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
  64. package/docs/user-guide/getting-started/quick-start.md +0 -212
  65. package/docs/user-guide/getting-started/setup.md +0 -819
  66. package/docs/user-guide/guides/agent-skills-integration.md +0 -222
  67. package/docs/user-guide/guides/customization.md +0 -537
  68. package/docs/user-guide/guides/internationalization.md +0 -540
  69. package/docs/user-guide/guides/migration-guide.md +0 -138
  70. package/docs/user-guide/guides/multi-project.md +0 -368
  71. package/docs/user-guide/guides/multi-repo-guide.md +0 -1590
  72. package/docs/user-guide/guides/phase-automation.md +0 -419
  73. package/docs/user-guide/guides/workflow.md +0 -574
  74. package/docs/user-guide/hands-on/README.md +0 -142
  75. package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
  76. package/docs/user-guide/hands-on/claude-setup.md +0 -452
  77. package/docs/user-guide/hands-on/cursor-setup.md +0 -353
  78. package/docs/user-guide/hands-on/troubleshooting.md +0 -964
  79. package/docs/user-guide/hands-on/verification-checklist.md +0 -439
  80. package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -1078
  81. package/docs/user-guide/reference/config.md +0 -589
  82. package/docs/user-guide/reference/multi-repo-api.md +0 -771
  83. package/docs/user-guide/reference/quick-reference.md +0 -297
  84. package/docs/user-guide/reference/security-test-payloads.md +0 -50
  85. package/docs/user-guide/reference/tasks-template.md +0 -550
  86. package/docs/user-guide/release/ci-setup-java.md +0 -114
  87. package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
  88. package/docs/user-guide/release/ci-setup-php.md +0 -102
  89. package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
  90. package/docs/user-guide/release/ci-setup.md +0 -188
  91. package/docs/user-guide/release/release-flow.md +0 -476
  92. package/docs/user-guide/templates/test-specs/README.md +0 -173
  93. package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
  94. package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
  95. package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
  96. package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
  97. package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
  98. package/docs/user-guide/testing/integration-tests.md +0 -312
  99. package/docs/user-guide/testing/tdd-cycle.md +0 -349
  100. package/docs/user-guide/testing/test-execution-flow.md +0 -396
  101. package/docs/user-guide/testing/test-failure-handling.md +0 -521
  102. package/docs/user-guide/testing/test-planning-flow.md +0 -185
  103. package/docs/user-guide/testing-strategy.md +0 -185
  104. package/docs/verification-guide.md +0 -518
@@ -1,439 +0,0 @@
1
- # 検証チェックリスト
2
-
3
- このドキュメントでは、Michiワークフローの各ステップが正しく動作しているかを確認するためのチェックリストを提供します。
4
-
5
- ## 📋 チェックリストの使い方
6
-
7
- 各フェーズの作業後に、対応するセクションのチェック項目を確認してください。すべての項目が✅であれば、次のフェーズに進めます。
8
-
9
- ## セットアップの確認
10
-
11
- ### 環境セットアップ
12
-
13
- - [ ] Node.js 20.x以上がインストールされている
14
- ```bash
15
- node --version # v20.0.0以上
16
- ```
17
-
18
- - [ ] npm 10.x以上がインストールされている
19
- ```bash
20
- npm --version # 10.0.0以上
21
- ```
22
-
23
- - [ ] Git(またはJujutsu)がインストールされている
24
- ```bash
25
- git --version # または jj --version
26
- ```
27
-
28
- - [ ] GitHub CLIがインストールされている
29
- ```bash
30
- gh --version
31
- ```
32
-
33
- - [ ] GitHub CLIが認証されている
34
- ```bash
35
- gh auth status
36
- # ✅ Logged in to github.com
37
- ```
38
-
39
- ### Michiのインストール確認
40
-
41
- - [ ] Michiがインストールされている
42
- ```bash
43
- michi --version # 0.2.0以上
44
- ```
45
-
46
- - [ ] Michiコマンドが実行できる
47
- ```bash
48
- michi --help
49
- # Usage: michi [options] [command] が表示される
50
- ```
51
-
52
- ### プロジェクトファイルの確認
53
-
54
- - [ ] `.kiro/project.json` が存在する
55
- ```bash
56
- ls -la .kiro/project.json
57
- ```
58
-
59
- - [ ] `.kiro/settings/templates/` が存在する
60
- ```bash
61
- ls -la .kiro/settings/templates/
62
- # requirements.md, design.md, tasks.md が存在
63
- ```
64
-
65
- - [ ] `.kiro/steering/` が存在する(オプション: `/kiro:steering`コマンドで作成)
66
- ```bash
67
- ls -la .kiro/steering/
68
- # セットアップ直後は存在しない。必要に応じて /kiro:steering コマンドで作成
69
- # 作成後は product.md, tech.md, structure.md が存在
70
- ```
71
-
72
- - [ ] 環境別ルールファイルが存在する(Cursor IDEの場合)
73
- ```bash
74
- ls -la .cursor/rules/
75
- # atlassian-mcp.mdc, github-ssot.mdc, multi-project.mdc が存在
76
- ```
77
-
78
- - [ ] 環境別コマンドファイルが存在する(Cursor IDEの場合)
79
- ```bash
80
- ls -la .cursor/commands/michi/
81
- # confluence-sync.md, project-switch.md が存在
82
- ```
83
-
84
- ### 環境変数の確認
85
-
86
- - [ ] `.env` ファイルが存在する
87
- ```bash
88
- ls -la .env
89
- ```
90
-
91
- - [ ] `.env` の権限が600である
92
- ```bash
93
- stat -f "%Lp %N" .env # macOS
94
- # 600 .env が表示される
95
- ```
96
-
97
- - [ ] GitHub認証情報が設定されている
98
- ```bash
99
- grep GITHUB_TOKEN .env
100
- # GITHUB_TOKEN=ghp_xxx
101
- ```
102
-
103
- - [ ] (オプション)Atlassian認証情報が設定されている
104
- ```bash
105
- grep ATLASSIAN .env
106
- # ATLASSIAN_URL, ATLASSIAN_EMAIL, ATLASSIAN_API_TOKEN
107
- ```
108
-
109
- ## Phase 0: 初期化 (spec-init)
110
-
111
- ### spec-init実行後
112
-
113
- - [ ] `.kiro/specs/<feature>/` ディレクトリが作成された
114
- ```bash
115
- ls -la .kiro/specs/health-check-endpoint/
116
- ```
117
-
118
- - [ ] `spec.json` ファイルが生成された
119
- ```bash
120
- cat .kiro/specs/health-check-endpoint/spec.json
121
- ```
122
-
123
- - [ ] `spec.json` に必要なフィールドが含まれている
124
- ```bash
125
- # 以下のフィールドが存在するか確認:
126
- # - feature: "health-check-endpoint"
127
- # - status: "draft"
128
- # - createdAt: "..."
129
- # - phases: {...}
130
- ```
131
-
132
- ### 期待される出力
133
-
134
- ```json
135
- {
136
- "feature": "health-check-endpoint",
137
- "status": "draft",
138
- "createdAt": "2025-01-15T10:00:00Z",
139
- "phases": {
140
- "requirements": "pending",
141
- "design": "pending",
142
- "tasks": "pending",
143
- "implementation": "pending"
144
- }
145
- }
146
- ```
147
-
148
- ## Phase 1: 要件定義 (spec-requirements + phase:run)
149
-
150
- ### spec-requirements実行後
151
-
152
- - [ ] `requirements.md` ファイルが生成された
153
- ```bash
154
- ls -la .kiro/specs/health-check-endpoint/requirements.md
155
- ```
156
-
157
- - [ ] `requirements.md` に必要なセクションが含まれている
158
- ```bash
159
- grep "ビジネス要件" .kiro/specs/health-check-endpoint/requirements.md
160
- grep "機能要件" .kiro/specs/health-check-endpoint/requirements.md
161
- grep "非機能要件" .kiro/specs/health-check-endpoint/requirements.md
162
- ```
163
-
164
- ### phase:run requirements実行後
165
-
166
- - [ ] Confluenceページが作成された
167
- ```bash
168
- # spec.jsonを確認
169
- grep requirementsPageId .kiro/specs/health-check-endpoint/spec.json
170
- # "requirementsPageId": "123456789"
171
- ```
172
-
173
- - [ ] `spec.json` が更新された(requirementsフェーズ)
174
- ```bash
175
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.phases.requirements'
176
- # "completed"
177
- ```
178
-
179
- - [ ] `spec.json` にConfluence情報が記録された
180
- ```bash
181
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.confluence.requirementsPageId'
182
- # "123456789"
183
- ```
184
-
185
- ### Confluenceページの確認
186
-
187
- - [ ] Confluenceページが正しく作成されている
188
- - タイトル: `[プロジェクト名] health-check-endpoint - 要件定義`
189
- - ラベル: `project:xxx`, `feature:health-check-endpoint`, `phase:requirements`
190
- - 本文: requirements.mdの内容が反映されている
191
-
192
- ## Phase 2: 設計 (spec-design + phase:run)
193
-
194
- ### spec-design実行後
195
-
196
- - [ ] `design.md` ファイルが生成された
197
- ```bash
198
- ls -la .kiro/specs/health-check-endpoint/design.md
199
- ```
200
-
201
- - [ ] `design.md` に必要なセクションが含まれている
202
- ```bash
203
- grep "アーキテクチャ" .kiro/specs/health-check-endpoint/design.md
204
- grep "API設計" .kiro/specs/health-check-endpoint/design.md
205
- ```
206
-
207
- ### phase:run design実行後
208
-
209
- - [ ] Confluenceページが作成された
210
- ```bash
211
- grep designPageId .kiro/specs/health-check-endpoint/spec.json
212
- # "designPageId": "123456790"
213
- ```
214
-
215
- - [ ] `spec.json` が更新された(designフェーズ)
216
- ```bash
217
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.phases.design'
218
- # "completed"
219
- ```
220
-
221
- - [ ] `spec.json` にConfluence情報が記録された
222
- ```bash
223
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.confluence.designPageId'
224
- # "123456790"
225
- ```
226
-
227
- ### Confluenceページの確認
228
-
229
- - [ ] Confluenceページが正しく作成されている
230
- - タイトル: `[プロジェクト名] health-check-endpoint - 設計書`
231
- - ラベル: `project:xxx`, `feature:health-check-endpoint`, `phase:design`
232
- - 本文: design.mdの内容が反映されている
233
-
234
- ## Phase 3: タスク分割 (spec-tasks + phase:run)
235
-
236
- ### spec-tasks実行後
237
-
238
- - [ ] `tasks.md` ファイルが生成された
239
- ```bash
240
- ls -la .kiro/specs/health-check-endpoint/tasks.md
241
- ```
242
-
243
- - [ ] `tasks.md` に全6フェーズが含まれている
244
- ```bash
245
- grep "Phase 0: 要件定義" .kiro/specs/health-check-endpoint/tasks.md
246
- grep "Phase 1: 設計" .kiro/specs/health-check-endpoint/tasks.md
247
- grep "Phase 2: 実装" .kiro/specs/health-check-endpoint/tasks.md
248
- grep "Phase 3: 試験" .kiro/specs/health-check-endpoint/tasks.md
249
- grep "Phase 4: リリース準備" .kiro/specs/health-check-endpoint/tasks.md
250
- grep "Phase 5: リリース" .kiro/specs/health-check-endpoint/tasks.md
251
- ```
252
-
253
- - [ ] 各フェーズにラベルが含まれている
254
- ```bash
255
- grep "Phase 0:.*(Requirements)" .kiro/specs/health-check-endpoint/tasks.md
256
- grep "Phase 1:.*(Design)" .kiro/specs/health-check-endpoint/tasks.md
257
- grep "Phase 2:.*(Implementation)" .kiro/specs/health-check-endpoint/tasks.md
258
- # ...
259
- ```
260
-
261
- ### phase:run tasks実行後
262
-
263
- - [ ] JIRA Epicが作成された
264
- ```bash
265
- grep epicKey .kiro/specs/health-check-endpoint/spec.json
266
- # "epicKey": "DEMO-100"
267
- ```
268
-
269
- - [ ] JIRA Storiesが作成された
270
- ```bash
271
- grep stories .kiro/specs/health-check-endpoint/spec.json
272
- # "stories": ["DEMO-101", "DEMO-102", ...]
273
- ```
274
-
275
- - [ ] `spec.json` が更新された(tasksフェーズ)
276
- ```bash
277
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.phases.tasks'
278
- # "completed"
279
- ```
280
-
281
- - [ ] `spec.json` にJIRA情報が記録された
282
- ```bash
283
- cat .kiro/specs/health-check-endpoint/spec.json | jq '.jira'
284
- # { "epicKey": "DEMO-100", "stories": [...] }
285
- ```
286
-
287
- ### JIRAの確認
288
-
289
- - [ ] JIRA Epicが正しく作成されている
290
- - Epic Key: `DEMO-100`(例)
291
- - Summary: `[プロジェクト名] health-check-endpoint`
292
- - Labels: `feature:health-check-endpoint`
293
-
294
- - [ ] JIRA Storiesが正しく作成されている
295
- - 全6フェーズのStoryが存在する
296
- - 各Storyに適切なラベルが付与されている:
297
- - `Requirements`
298
- - `Design`
299
- - `Implementation`
300
- - `Testing`
301
- - `Release-Preparation`
302
- - `Release`
303
-
304
- - [ ] 各StoryがEpicにリンクされている
305
- ```bash
306
- # JIRAでEpicを開き、リンクされたStoryを確認
307
- open "https://your-domain.atlassian.net/browse/DEMO-100"
308
- ```
309
-
310
- ## Phase 4-6: 実装・テスト・リリース
311
-
312
- ### 実装準備
313
-
314
- - [ ] GitHubブランチが作成された
315
- ```bash
316
- jj bookmark list
317
- # michi/feature/health-check-endpoint が存在
318
- ```
319
-
320
- - [ ] コミットが作成された
321
- ```bash
322
- jj log -r '@-'
323
- # feat: health-check-endpoint の実装開始 [DEMO-103]
324
- ```
325
-
326
- ### 実装(TDD)
327
-
328
- - [ ] テストコードが先に作成された
329
- ```bash
330
- ls -la src/test/java/.../HealthControllerTest.java
331
- ```
332
-
333
- - [ ] 実装コードが作成された
334
- ```bash
335
- ls -la src/main/java/.../HealthController.java
336
- ```
337
-
338
- - [ ] テストが成功する
339
- ```bash
340
- npm test
341
- # または mvn test / gradle test
342
- ```
343
-
344
- ## トラブルシューティング用チェック
345
-
346
- ### phase:runコマンドがエラーになる
347
-
348
- - [ ] Markdownファイル(requirements.md, design.md, tasks.md)が存在する
349
- ```bash
350
- ls -la .kiro/specs/health-check-endpoint/*.md
351
- ```
352
-
353
- - [ ] `.env` ファイルに認証情報が設定されている
354
- ```bash
355
- cat .env | grep -E "(ATLASSIAN|GITHUB|JIRA)"
356
- ```
357
-
358
- - [ ] JIRA Issue Type IDsが正しく設定されている
359
- ```bash
360
- grep JIRA_ISSUE_TYPE .env
361
- # JIRA_ISSUE_TYPE_STORY=10036
362
- # JIRA_ISSUE_TYPE_SUBTASK=10037
363
- ```
364
-
365
- ### Confluenceページが作成されない
366
-
367
- - [ ] Atlassian認証情報が正しい
368
- ```bash
369
- # REST APIで確認
370
- curl -u $ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN \
371
- $ATLASSIAN_URL/rest/api/content
372
- ```
373
-
374
- - [ ] Confluenceスペースが存在する
375
- ```bash
376
- # .envで指定したスペースが存在するか確認
377
- grep CONFLUENCE_PRD_SPACE .env
378
- ```
379
-
380
- ### JIRAが作成されない
381
-
382
- - [ ] JIRAプロジェクトキーが正しい
383
- ```bash
384
- grep JIRA_PROJECT_KEYS .env
385
- ```
386
-
387
- - [ ] JIRA Issue Type IDsが正しい
388
- ```bash
389
- # REST APIで確認
390
- curl -u $ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN \
391
- $ATLASSIAN_URL/rest/api/3/issuetype
392
- ```
393
-
394
- - [ ] tasks.mdのフォーマットが正しい
395
- ```bash
396
- # フェーズヘッダーの形式を確認
397
- grep "^## Phase" .kiro/specs/health-check-endpoint/tasks.md
398
- # ## Phase 0: 要件定義(Requirements)
399
- # ## Phase 1: 設計(Design)
400
- # ...
401
- ```
402
-
403
- ## 完了確認
404
-
405
- すべてのチェックが✅になったら、ワークフローは正常に完了しています。
406
-
407
- ### 最終確認
408
-
409
- - [ ] `.kiro/specs/<feature>/` に4つのファイルが存在する
410
- - `spec.json`
411
- - `requirements.md`
412
- - `design.md`
413
- - `tasks.md`
414
-
415
- - [ ] Confluenceページが2つ作成された
416
- - 要件定義ページ
417
- - 設計書ページ
418
-
419
- - [ ] JIRAが作成された
420
- - 1つのEpic
421
- - 複数のStories(全6フェーズ)
422
-
423
- - [ ] GitHubブランチが作成された
424
-
425
- - [ ] 実装準備が完了した
426
-
427
- おつかれさまでした!すべてのフェーズが正常に完了しました。🎉
428
-
429
- ## 📚 関連ドキュメント
430
-
431
- - [ワークフロー体験ガイド](./workflow-walkthrough.md)
432
- - [トラブルシューティング](./troubleshooting.md)
433
- - [ワークフローガイド](../guides/workflow.md)
434
- - [クイックリファレンス](../reference/quick-reference.md)
435
-
436
-
437
-
438
-
439
-