@sk8metal/michi-cli 0.10.1 → 0.11.0

package/docs/user-guide/templates/test-specs/unit-test-spec-template.md

@@ -1,328 +0,0 @@
-# Unit Test Specification: {{TEST_NAME}}
-
-**Author**: {{AUTHOR}}
-**Date**: {{DATE}}
-**Version**: 1.0
-
-## 1. Overview
-
-### 1.1 Purpose
-{{PURPOSE}}
-
-Example: To verify that individual functions and classes in the {{MODULE_NAME}} module work correctly in isolation.
-
-### 1.2 Scope
-{{SCOPE}}
-
-Example: This test specification covers all public methods of the {{CLASS_NAME}} class and their edge cases.
-
-### 1.3 Testing Tool
-- **Tool**: {{TOOL_NAME}}
-- **Version**: {{VERSION}}
-
-Example:
-- **Tool**: Vitest (Node.js) / JUnit 5 (Java) / PHPUnit (PHP)
-- **Version**: 1.0.0 / 5.10.0 / 10.5.0
-
-## 2. Test Environment
-
-### 2.1 Software Requirements
-- Programming Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
-- Testing Framework: {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
-- Mocking Library: {{MOCKING_LIBRARY}} (if applicable)
-- Dependencies: {{DEPENDENCIES}}
-
-### 2.2 Hardware Requirements
-- Not applicable for unit tests (runs on developer's machine or CI/CD)
-
-### 2.3 Test Data
-- Mock data location: `{{MOCK_DATA_PATH}}`
-- Test fixtures: `{{FIXTURES_PATH}}`
-- Data setup: {{DATA_SETUP_DESCRIPTION}}
-
-## 3. Functions/Classes to Test
-
-### 3.1 Target Components
-List all functions/classes to be tested:
-
-| Component | Type | Description | Priority |
-|-----------|------|-------------|----------|
-| {{COMPONENT_1}} | Function/Class | {{DESCRIPTION_1}} | High/Medium/Low |
-| {{COMPONENT_2}} | Function/Class | {{DESCRIPTION_2}} | High/Medium/Low |
-
-### 3.2 Mocking Strategy
-Describe what external dependencies will be mocked:
-
-| Dependency | Mock Type | Reason |
-|------------|-----------|--------|
-| {{DEPENDENCY_1}} | {{MOCK_TYPE}} | {{REASON}} |
-| {{DEPENDENCY_2}} | {{MOCK_TYPE}} | {{REASON}} |
-
-Example:
-| Dependency | Mock Type | Reason |
-|------------|-----------|--------|
-| Database | Mock object | Avoid external I/O, ensure test isolation |
-| HTTP API | Stub | Control response for predictable testing |
-
-## 4. Test Cases
-
-### Test Case UT-001: {{TEST_CASE_NAME}}
-
-**Description**: {{TEST_CASE_DESCRIPTION}}
-
-Example: Verify that `calculateTotal()` returns the correct sum when given an array of positive numbers.
-
-**Preconditions**:
-- {{PRECONDITION_1}}
-- {{PRECONDITION_2}}
-
-Example:
-- Input array is not null
-- All array elements are valid numbers
-
-**Test Steps**:
-1. {{STEP_1}}
-2. {{STEP_2}}
-3. {{STEP_3}}
-
-Example:
-1. Create an input array: `[10, 20, 30]`
-2. Call `calculateTotal(input)`
-3. Assert that the result equals `60`
-
-**Expected Results**:
-{{EXPECTED_RESULTS}}
-
-Example:
-- Function returns `60`
-- No exceptions are thrown
-
-**Actual Results**:
-[To be filled during test execution]
-
-**Status**: [ ] Pass / [ ] Fail / [ ] Blocked
-
-**Notes**:
-{{NOTES}}
-
----
-
-### Test Case UT-002: {{TEST_CASE_NAME}}
-
-**Description**: {{TEST_CASE_DESCRIPTION}}
-
-**Preconditions**:
-- {{PRECONDITION_1}}
-- {{PRECONDITION_2}}
-
-**Test Steps**:
-1. {{STEP_1}}
-2. {{STEP_2}}
-3. {{STEP_3}}
-
-**Expected Results**:
-{{EXPECTED_RESULTS}}
-
-**Actual Results**:
-[To be filled during test execution]
-
-**Status**: [ ] Pass / [ ] Fail / [ ] Blocked
-
-**Notes**:
-{{NOTES}}
-
----
-
-### Test Case UT-003: Edge Case - {{EDGE_CASE_NAME}}
-
-**Description**: {{EDGE_CASE_DESCRIPTION}}
-
-Example: Verify that `calculateTotal()` handles empty array correctly.
-
-**Preconditions**:
-- {{PRECONDITION}}
-
-**Test Steps**:
-1. {{STEP_1}}
-2. {{STEP_2}}
-
-Example:
-1. Create an empty array: `[]`
-2. Call `calculateTotal([])`
-3. Assert that the result equals `0`
-
-**Expected Results**:
-{{EXPECTED_RESULTS}}
-
-**Actual Results**:
-[To be filled during test execution]
-
-**Status**: [ ] Pass / [ ] Fail / [ ] Blocked
-
-**Notes**:
-{{NOTES}}
-
----
-
-### Test Case UT-004: Error Case - {{ERROR_CASE_NAME}}
-
-**Description**: {{ERROR_CASE_DESCRIPTION}}
-
-Example: Verify that `calculateTotal()` throws an appropriate error when given invalid input.
-
-**Preconditions**:
-- {{PRECONDITION}}
-
-**Test Steps**:
-1. {{STEP_1}}
-2. {{STEP_2}}
-
-Example:
-1. Create an array with non-numeric value: `[10, 'invalid', 30]`
-2. Call `calculateTotal(input)`
-3. Assert that a `TypeError` is thrown
-
-**Expected Results**:
-{{EXPECTED_RESULTS}}
-
-**Actual Results**:
-[To be filled during test execution]
-
-**Status**: [ ] Pass / [ ] Fail / [ ] Blocked
-
-**Notes**:
-{{NOTES}}
-
----
-
-## 5. Test Coverage
-
-### 5.1 Coverage Goals
-- **Target Coverage**: {{TARGET_COVERAGE}}%
-- **Minimum Acceptable Coverage**: {{MIN_COVERAGE}}%
-
-Example:
-- **Target Coverage**: 95%
-- **Minimum Acceptable Coverage**: 80%
-
-### 5.2 Coverage Report Location
-- Report Path: `{{COVERAGE_REPORT_PATH}}`
-- HTML Report: `{{HTML_REPORT_PATH}}`
-
-Example:
-- Report Path: `coverage/lcov.info`
-- HTML Report: `coverage/index.html`
-
-## 6. Test Execution Summary
-
-| ID | Test Name | Status | Executed By | Date | Notes |
-|----|-----------|--------|-------------|------|-------|
-| UT-001 | {{NAME}} | | | | |
-| UT-002 | {{NAME}} | | | | |
-| UT-003 | {{NAME}} | | | | |
-| UT-004 | {{NAME}} | | | | |
-
-## 7. Defects Found
-
-| Defect ID | Severity | Description | Status |
-|-----------|----------|-------------|--------|
-| | High/Medium/Low | | Open/In Progress/Fixed/Closed |
-
-## 8. Sign-off
-
-**Tested By**: _______________
-**Date**: _______________
-**Approved By**: _______________
-**Date**: _______________
-
----
-
-## Appendix A: Code Examples
-
-### Example Test Code (Node.js/Vitest)
-
-```typescript
-import { describe, it, expect, vi } from 'vitest';
-import { calculateTotal } from './calculator';
-
-describe('calculateTotal', () => {
-  it('should return correct sum for positive numbers', () => {
-    const input = [10, 20, 30];
-    const result = calculateTotal(input);
-    expect(result).toBe(60);
-  });
-
-  it('should handle empty array', () => {
-    const result = calculateTotal([]);
-    expect(result).toBe(0);
-  });
-
-  it('should throw error for invalid input', () => {
-    expect(() => calculateTotal([10, 'invalid', 30])).toThrow(TypeError);
-  });
-});
-```
-
-### Example Test Code (Java/JUnit 5)
-
-```java
-import org.junit.jupiter.api.Test;
-import static org.junit.jupiter.api.Assertions.*;
-
-class CalculatorTest {
-    @Test
-    void shouldReturnCorrectSumForPositiveNumbers() {
-        Calculator calc = new Calculator();
-        int[] input = {10, 20, 30};
-        int result = calc.calculateTotal(input);
-        assertEquals(60, result);
-    }
-
-    @Test
-    void shouldHandleEmptyArray() {
-        Calculator calc = new Calculator();
-        int[] input = {};
-        int result = calc.calculateTotal(input);
-        assertEquals(0, result);
-    }
-}
-```
-
-### Example Test Code (PHP/PHPUnit)
-
-```php
-<?php
-use PHPUnit\Framework\TestCase;
-
-class CalculatorTest extends TestCase
-{
-    public function testShouldReturnCorrectSumForPositiveNumbers()
-    {
-        $calculator = new Calculator();
-        $input = [10, 20, 30];
-        $result = $calculator->calculateTotal($input);
-        $this->assertEquals(60, $result);
-    }
-
-    public function testShouldHandleEmptyArray()
-    {
-        $calculator = new Calculator();
-        $input = [];
-        $result = $calculator->calculateTotal($input);
-        $this->assertEquals(0, $result);
-    }
-}
-```
-
-## Appendix B: TDD Principles
-
-### RED-GREEN-REFACTOR Cycle
-1. **RED**: Write a failing test first
-2. **GREEN**: Write minimum code to pass the test
-3. **REFACTOR**: Improve code while keeping tests green
-
-### Important Rule
-**Tests represent specifications. Do NOT modify tests to match implementation.**
-
-- ❌ NG: Implementation doesn't match test, so modify the test
-- ✅ OK: Specification changed, so update the test accordingly

package/docs/user-guide/testing/integration-tests.md

@@ -1,312 +0,0 @@
-# 統合テストガイド
-
-## 概要
-
-Michiプロジェクトの統合テストは、`setup-existing`コマンドの動作を検証するために作成されています。
-
-## テスト構造
-
-```
-src/__tests__/integration/setup/
-├── helpers/
-│   ├── test-project.ts      # テストプロジェクト作成ヘルパー
-│   └── fs-assertions.ts     # ファイルシステムアサーション
-├── cursor.test.ts           # Cursor環境テスト
-├── claude.test.ts           # Claude環境テスト
-├── claude-agent.test.ts     # Claude Agent環境テスト
-└── validation.test.ts       # 引数バリデーションテスト
-```
-
-## テストケース
-
-### 1. 環境別テスト
-
-#### Cursor環境 (`cursor.test.ts`)
-
-- ✅ `.cursor/rules/` ディレクトリ作成
-- ✅ `.cursor/commands/` ディレクトリ作成
-- ✅ `.kiro/` ディレクトリ構造作成
-- ✅ `project.json` 作成とメタデータ検証
-- ✅ `.env` テンプレート作成
-- ✅ テンプレートレンダリング
-- ✅ 言語サポート（ja, en）
-- ✅ Git統合（リモートURL検出）
-- ✅ エラーハンドリング
-
-#### Claude環境 (`claude.test.ts`)
-
-- ✅ `.claude/rules/` ディレクトリ作成
-- ✅ `.kiro/` ディレクトリ構造作成
-- ✅ `project.json` 作成
-- ✅ `.env` テンプレート作成
-- ✅ Cursor固有ディレクトリが作成されないことを確認
-- ✅ 言語サポート
-
-#### Claude Agent環境 (`claude-agent.test.ts`)
-
-- ✅ `.claude/agents/` ディレクトリ作成
-- ✅ `.kiro/` ディレクトリ構造作成
-- ✅ `project.json` 作成
-- ✅ `.env` テンプレート作成
-- ✅ 他の環境固有ディレクトリが作成されないことを確認
-- ✅ 言語サポート（ja, en, zh-TW）
-
-### 2. バリデーションテスト (`validation.test.ts`)
-
-#### 環境選択
-
-- ✅ デフォルト環境（cursor）
-- ✅ `--cursor` フラグ
-- ✅ `--claude` フラグ
-- ✅ `--claude-agent` フラグ
-
-#### 言語バリデーション
-
-- ✅ サポート言語: `ja`, `en`, `zh-TW`
-- ✅ 非サポート言語でエラー
-
-#### プロジェクト名バリデーション
-
-**正常系:**
-
-- ✅ 有効なプロジェクト名
-- ✅ 日本語文字を含むプロジェクト名
-- ✅ 前後の空白はトリム
-
-**異常系:**
-
-- ❌ 空文字列
-- ❌ パストラバーサル文字 (`/`, `\`, `..`)
-- ❌ 制御文字
-- ❌ 100文字超
-
-#### JIRAキーバリデーション
-
-**正常系:**
-
-- ✅ 2-10文字の大文字英字
-- ✅ 小文字は自動的に大文字に変換
-
-**異常系:**
-
-- ❌ 1文字以下
-- ❌ 11文字以上
-- ❌ 数字を含む
-- ❌ 特殊文字を含む
-
-#### Gitリポジトリバリデーション
-
-- ❌ `.git` ディレクトリがない場合エラー
-
-## テスト実行方法
-
-### すべてのテスト実行
-
-```bash
-npm test
-```
-
-### 統合テストのみ実行
-
-```bash
-npm run test:integration:setup
-```
-
-### カバレッジ付き実行
-
-```bash
-npm run test:coverage:setup
-```
-
-### 監視モード
-
-```bash
-npm test -- --watch
-```
-
-### UI モード
-
-```bash
-npm run test:ui
-```
-
-## CI/CD
-
-GitHub Actionsワークフローが `.github/workflows/test-setup.yml` に定義されています。
-
-**実行タイミング:**
-
-- `main`, `develop`, `feature/**` ブランチへのプッシュ
-- `main`, `develop` ブランチへのプルリクエスト
-
-**マトリクス戦略:**
-
-- Node.js 18.x
-- Node.js 20.x
-
-**ステップ:**
-
-1. コードチェックアウト
-2. Node.js セットアップ
-3. 依存関係インストール
-4. 統合テスト実行
-5. カバレッジ生成
-6. カバレッジアップロード（Codecov）
-7. Lint実行
-8. TypeScript型チェック
-
-## トラブルシューティング
-
-### テストが失敗する場合
-
-**症状:** テストプロジェクトの作成に失敗
-
-**原因:** 一時ディレクトリの権限問題
-
-**解決策:**
-
-```bash
-# 一時ディレクトリの権限を確認
-ls -la /tmp
-
-# 手動でクリーンアップ
-rm -rf /tmp/test-project-*
-```
-
----
-
-**症状:** Git初期化エラー
-
-**原因:** Gitがインストールされていない
-
-**解決策:**
-
-```bash
-# Gitインストール確認
-git --version
-
-# macOS
-brew install git
-
-# Ubuntu
-sudo apt-get install git
-```
-
----
-
-**症状:** TypeScriptコンパイルエラー
-
-**原因:** 型定義の不一致
-
-**解決策:**
-
-```bash
-# 型チェック
-npm run type-check
-
-# node_modulesを再インストール
-rm -rf node_modules package-lock.json
-npm install
-```
-
-### カバレッジが低い場合
-
-**目標:** 95%以上のカバレッジ
-
-**確認方法:**
-
-```bash
-npm run test:coverage:setup
-open coverage/lcov-report/index.html
-```
-
-**改善策:**
-
-1. 未テストのエッジケースを追加
-2. エラーハンドリングのテストを追加
-3. モックが不十分な箇所を特定
-
-### CI/CDが失敗する場合
-
-**症状:** GitHub Actionsでテストが失敗
-
-**原因1:** ローカルとCI環境の違い
-
-**解決策:**
-
-```bash
-# ローカルでCI環境を再現
-docker run -it -v $(pwd):/app node:20 bash
-cd /app
-npm ci
-npm run test:integration:setup
-```
-
-**原因2:** タイムアウト
-
-**解決策:** `.github/workflows/test-setup.yml` でタイムアウトを延長
-
-```yaml
-- name: Run integration tests
-  run: npm run test:integration:setup
-  timeout-minutes: 10 # デフォルト: 360分
-```
-
-## ベストプラクティス
-
-### テスト作成時
-
-1. **TDD原則を守る**
-   - テストを先に書く
-   - 最小限の実装で通す
-   - リファクタリング
-
-2. **テストは独立させる**
-   - 各テストは他のテストに依存しない
-   - `beforeEach`, `afterEach` でクリーンアップ
-
-3. **意味のあるテスト名**
-
-   ```typescript
-   // ❌ Bad
-   it("test 1", () => {});
-
-   // ✅ Good
-   it("should create .cursor/rules directory", () => {});
-   ```
-
-4. **アサーションは明確に**
-
-   ```typescript
-   // ❌ Bad
-   expect(result).toBe(true);
-
-   // ✅ Good
-   assertDirectoryExists(
-     join(testProject.path, ".cursor/rules"),
-     "Expected .cursor/rules directory to exist",
-   );
-   ```
-
-### テスト保守時
-
-1. **テストが壊れたら**
-   - 実装の変更が正しいか確認
-   - テストの期待値を更新
-   - リグレッションを防ぐ
-
-2. **新機能追加時**
-   - 必ずテストを追加
-   - カバレッジを確認
-   - エッジケースを考慮
-
-3. **リファクタリング時**
-   - テストが通ることを確認
-   - テストコードもリファクタリング
-   - 重複を削除
-
-## 参考資料
-
-- [Vitest公式ドキュメント](https://vitest.dev/)
-- [テスト戦略](../testing-strategy.md)
-- [開発ガイド](../contributing/development.md)