@aramassa/ai-rules 0.9.6 → 0.9.8

package/artifact/instructions/rules/test/e2e-cmd.md

@@ -0,0 +1,323 @@
+---
+type: test
+category: e2e-test
+focus: command-line-testing
+applyTo: "todo_plans/**/e2e-cmd.md"
+---
+
+# E2E コマンドラインテスト計画ガイドライン
+
+## 概要
+
+このドキュメントは、`todo_plans/${ISSUE_NUMBER}/e2e-cmd.md` ファイルに記載すべき E2E テストの追加/更新/削除内容に関するガイドラインです。
+
+## 基本原則
+
+### コマンドライン完結の原則
+
+**E2E テストは、原則としてコマンドライン（CLI）上で完結するもののみを対象とします。**
+
+**対象となるテスト**:
+- CLI ツールの動作確認
+- API サーバーの HTTP リクエスト/レスポンス検証（curl、httpie などを使用）
+- ビルドプロセスの実行確認
+- スクリプトの実行と出力検証
+- ファイル操作の確認
+
+**対象外となるテスト**:
+- ブラウザ UI のインタラクション（Playwright、Selenium などを使うもの）
+- デスクトップアプリケーションの GUI 操作
+- モバイルアプリケーションのテスト
+- コマンドラインから実行できないインタラクティブな操作
+
+### なぜコマンドライン完結なのか
+
+- **再現性**: コマンドは完全に記録でき、誰でも同じ手順で実行可能
+- **自動化**: CI/CD パイプラインで容易に実行可能
+- **保守性**: テストスクリプトがシンプルで理解しやすい
+- **環境依存性の最小化**: ブラウザやGUIツールのバージョン差異を避けられる
+
+## e2e-cmd.md の記載内容
+
+### ファイル構成
+
+`todo_plans/${ISSUE_NUMBER}/e2e-cmd.md` ファイルには、以下の内容を記載します：
+
+```markdown
+# E2E テスト計画: [機能名]
+
+## 追加すべきテスト
+
+### テスト1: [テスト名]
+- **目的**: [何を検証するか]
+- **対象ファイル**: [プロジェクトルートからのフルパス]
+- **コマンド**:
+  ```bash
+  # セットアップ
+  npm run build
+  
+  # テスト実行
+  ./dist/cli.js command --option value
+  
+  # 期待する結果
+  # - 終了コード: 0
+  # - 標準出力: "Success message"
+  ```
+- **検証ポイント**:
+  - [ ] 終了コードが正しい
+  - [ ] 標準出力/標準エラー出力が期待通り
+  - [ ] ファイル生成が正しく行われる
+
+## 更新すべきテスト
+
+### テスト2: [既存テスト名]
+- **現在の問題**: [なぜ更新が必要か]
+- **対象ファイル**: docs-ai/e2e-test/[既存ファイル名]
+- **変更内容**:
+  - 変更前: `old command`
+  - 変更後: `new command --new-option`
+- **理由**: [変更理由]
+
+## 削除すべきテスト
+
+### テスト3: [削除するテスト名]
+- **対象ファイル**: docs-ai/e2e-test/[ファイル名]
+- **削除理由**: [なぜ不要になったか]
+```
+
+### 記載のポイント
+
+#### 1. 追加すべきテスト
+
+新機能や改善により、新たに動作確認が必要になったテストを記載します。
+
+**必須項目**:
+- テスト名（何をテストするか明確に）
+- 目的（このテストで何を保証するか）
+- 対象ファイル（プロジェクトルートからのフルパス）
+- 実行コマンド（コピペで実行可能な形式）
+- 検証ポイント（チェックリスト形式）
+
+**良い例**:
+```markdown
+### テスト: CLI のヘルプ表示
+
+- **目的**: CLI が正しくヘルプメッセージを表示することを確認
+- **対象ファイル**: packages/cli/dist/index.js
+- **コマンド**:
+  ```bash
+  cd /home/runner/work/ai-rules/ai-rules
+  ./packages/cli/dist/index.js --help
+  ```
+- **検証ポイント**:
+  - [ ] 終了コード 0
+  - [ ] 使用方法が表示される
+  - [ ] オプション一覧が表示される
+```
+
+**悪い例**:
+```markdown
+### ヘルプのテスト
+- ヘルプが表示されることを確認
+- コマンド: `cli --help`
+```
+
+#### 2. 更新すべきテスト
+
+既存の E2E テストの変更が必要な場合に記載します。
+
+**記載すべき内容**:
+- 既存テストファイルのフルパス（docs-ai/e2e-test/ 配下）
+- 変更前後のコマンド
+- 変更理由
+
+**例**:
+```markdown
+### テスト: presets コマンドの引数変更
+
+- **現在の問題**: 新しいオプション `--format` が追加されたが、既存テストでカバーされていない
+- **対象ファイル**: docs-ai/e2e-test/presets-command-e2e.md
+- **変更内容**:
+  - 変更前: `./dist/cli.js presets`
+  - 変更後: `./dist/cli.js presets --format json`
+- **理由**: JSON 形式の出力を検証するため
+```
+
+#### 3. 削除すべきテスト
+
+不要になったテストや、機能削除により実行できなくなったテストを記載します。
+
+**記載すべき内容**:
+- 削除対象ファイルのフルパス
+- 削除理由
+
+**例**:
+```markdown
+### テスト: 旧形式の config ファイル読み込み
+
+- **対象ファイル**: docs-ai/e2e-test/legacy-config-e2e.md
+- **削除理由**: 旧形式のサポートを終了したため、このテストは不要
+```
+
+## コマンド記述のベストプラクティス
+
+### 1. 絶対パスの使用
+
+```bash
+# ✅ 良い例: プロジェクトルートからの明示的なパス
+cd /home/runner/work/ai-rules/ai-rules
+./dist/cli.js command
+
+# ❌ 悪い例: 相対パスのみ
+./cli.js command
+```
+
+### 2. 環境変数の明示
+
+```bash
+# ✅ 良い例: 必要な環境変数を明示
+NODE_ENV=test ./dist/cli.js test-command
+
+# ❌ 悪い例: 環境変数が暗黙的
+./dist/cli.js test-command
+```
+
+### 3. 前提条件の記載
+
+```bash
+# ✅ 良い例: セットアップ手順を含める
+# 前提: ビルド済みであること
+npm run build
+
+# テスト実行
+./dist/cli.js command
+
+# ❌ 悪い例: 前提条件が不明
+./dist/cli.js command
+```
+
+### 4. 期待結果の明記
+
+```bash
+# ✅ 良い例: 期待する出力を明記
+# 期待する結果:
+# - 終了コード: 0
+# - 標準出力に "Success" を含む
+# - ファイル dist/output.json が生成される
+
+# ❌ 悪い例: 期待結果が不明
+./dist/cli.js command
+```
+
+### 5. エラーケースの検証
+
+```bash
+# ✅ 良い例: エラーケースも記載
+# エラーケース: 無効な引数
+./dist/cli.js command --invalid-option ; echo "exit code: $?"
+# 期待: 終了コード 1、エラーメッセージ出力
+
+# ❌ 悪い例: 正常系のみ
+./dist/cli.js command
+```
+
+## E2E テストドキュメントへの反映
+
+`todo_plans/${ISSUE_NUMBER}/e2e-cmd.md` に記載した内容は、実装完了後に `docs-ai/e2e-test/` ディレクトリ配下の適切なファイルに反映します。
+
+### 反映先の決定
+
+- **既存機能の拡張**: 既存の E2E テストファイルに追記
+- **新機能**: 新しい E2E テストファイルを作成（命名規則: `[機能名]-e2e.md`）
+- **大規模な変更**: 既存ファイルを分割または再構成
+
+### 反映時の注意点
+
+1. **ファイルパスはプロジェクトルートからのフルパス**で記載
+2. **コマンドはコピペで実行可能**な形式で記載
+3. **セクション構成**は既存ファイルに合わせる：
+   - 前提条件
+   - 全体ビルド・テスト
+   - パッケージ別テスト
+   - コマンドライン検証
+   - エラーケーステスト
+   - クリーンアップ
+
+## チェックリスト
+
+e2e-cmd.md を作成する際の確認事項：
+
+- [ ] すべてのテストがコマンドライン上で完結する
+- [ ] ファイルパスはプロジェクトルートからのフルパスで記載されている
+- [ ] コマンドがコピペで実行可能である
+- [ ] 期待結果（終了コード、出力内容など）が明記されている
+- [ ] セットアップ手順が含まれている
+- [ ] クリーンアップ手順が必要な場合は記載されている
+- [ ] 既存の E2E テストファイルとの関連が明確である
+
+## 関連ドキュメント
+
+- **E2E テストガイドライン**: artifact/instructions/rules/test/e2e-cli-execution.md
+- **E2E テストディレクトリ**: docs-ai/e2e-test/README.md
+- **計画ワークフロー**: artifact/prompts/development/plan-fix.prompt.md
+
+## 例
+
+### 完全な e2e-cmd.md の例
+
+```markdown
+# E2E テスト計画: presets コマンド拡張
+
+## 追加すべきテスト
+
+### テスト1: JSON 形式での出力
+
+- **目的**: presets コマンドが JSON 形式で出力できることを確認
+- **対象ファイル**: packages/cli/dist/cli.js
+- **コマンド**:
+  ```bash
+  cd /home/runner/work/ai-rules/ai-rules
+  npm run build
+  ./dist/cli.js presets --format json
+  ```
+- **検証ポイント**:
+  - [ ] 終了コード 0
+  - [ ] 標準出力が有効な JSON である
+  - [ ] JSON に "presets" 配列が含まれる
+
+### テスト2: サブディレクトリのプリセット検出
+
+- **目的**: presets/ 配下のサブディレクトリ内のプリセットも検出できることを確認
+- **対象ファイル**: packages/cli/dist/cli.js
+- **コマンド**:
+  ```bash
+  cd /home/runner/work/ai-rules/ai-rules
+  npm run build
+  
+  # サブディレクトリを作成してテスト
+  mkdir -p presets/custom
+  echo "test: true" > presets/custom/test.yaml
+  
+  ./dist/cli.js presets
+  
+  # クリーンアップ
+  rm -rf presets/custom
+  ```
+- **検証ポイント**:
+  - [ ] 終了コード 0
+  - [ ] "custom/test.yaml" がリストに含まれる
+
+## 更新すべきテスト
+
+### テスト3: 既存の presets 一覧表示テスト
+
+- **現在の問題**: 新しい `--format` オプションが追加されたが、既存テストでカバーされていない
+- **対象ファイル**: docs-ai/e2e-test/presets-command-e2e.md
+- **変更内容**:
+  - セクション「基本的な presets 一覧表示」の後に、「JSON 形式での出力」セクションを追加
+- **理由**: 新機能のテストを既存の E2E テストファイルに統合
+
+## 削除すべきテスト
+
+なし
+```

package/artifact/prompts/development/plan-fix.prompt.md

@@ -105,13 +105,30 @@ cat > "todo_plans/${ISSUE_NUMBER}/index.md" <<'EOF'
   - `testing.md`: テスト戦略・テストケース
   - `risks.md`: リスク評価と対策
   - `notes.md`: 設計メモ・その他補足
+  - `e2e-cmd.md`: E2E テスト（追加/更新/削除すべきコマンドラインテスト。詳細は artifact/instructions/rules/test/e2e-cmd.md を参照）
+
+## 関連ファイルの記載ルール
+
+計画ファイル内で関連ファイルやディレクトリを参照する場合は、**必ずプロジェクトルートからのフルパス**で記載してください。
+
+**良い例**:
+- `artifact/instructions/rules/test/e2e-cmd.md`
+- `todo_plans/123/index.md`
+- `packages/core/src/index.ts`
+
+**悪い例**:
+- `e2e-cmd.md`（相対パスが不明確）
+- `./index.md`（現在のディレクトリが不明確）
+- `src/index.ts`（どのパッケージか不明）
 EOF
 
 cat > "todo_plans/${ISSUE_NUMBER}/details.md" <<'EOF'
 # 補足（自由記述）
 
 ※補足はこのファイルに「全部」書く必要はありません。
-`todo_plans/${ISSUE_NUMBER}/` 配下に、用途別にファイルを増やしてOKです（例: `testing.md`, `risks.md`, `notes.md`）。
+`todo_plans/${ISSUE_NUMBER}/` 配下に、用途別にファイルを増やしてOKです（例: `testing.md`, `risks.md`, `notes.md`, `e2e-cmd.md`）。
+
+**重要**: ファイル内で関連ファイルを参照する際は、プロジェクトルートからのフルパスで記載してください。
 
 ## 背景
 
@@ -308,8 +325,11 @@ echo "Next: Start Agent Coding with base branch plan/${ISSUE_NUMBER}"
 
 - **index.md**: 人間が読む前提で、要点だけに絞る（Issue 本文と一致させる正本）
 - **補足ファイル**: 長い背景/Phase/受け入れ基準などは `todo_plans/${ISSUE_NUMBER}/` 配下に分割して置く（`details.md` はその一例）
+- **e2e-cmd.md**: E2E テストの追加/更新/削除内容を記載（原則としてコマンドライン上で完結するテストのみ対象）
+  - 詳細は `artifact/instructions/rules/test/e2e-cmd.md` を参照
 - **Phase 分け**: 1つの Phase が 2-3時間で完了する規模に分割
 - **受け入れ基準**: 検証可能な形で明記
+- **ファイルパスの記載**: 関連ファイルは必ずプロジェクトルートからのフルパスで記載
 
 #### Issue 作成時
 
@@ -433,9 +453,10 @@ git push
 
 ### 関連ドキュメント
 
-- プランニングワークフロー マニュアル（planning-workflow.md）
-- Git ブランチ命名規則（git-rules.md）
-- todo_plans への記載項目（todo_planning.md）
+- プランニングワークフロー マニュアル（artifact/instructions/planning-workflow.md）
+- Git ブランチ命名規則（artifact/instructions/git-rules.md）
+- todo_plans への記載項目（artifact/instructions/todo_planning.md）
+- E2E コマンドラインテスト計画（artifact/instructions/rules/test/e2e-cmd.md）
 
 ### まとめ