Code Exemplars Blueprint Generator

Configuration Variables

${PROJECT_TYPE="Auto-detect|.NET|Java|JavaScript|TypeScript|React|Angular|Python|Other"} <!-- Primary technology --> ${SCAN_DEPTH="Basic|Standard|Comprehensive"} <!-- How deeply to analyze the codebase --> ${INCLUDE_CODE_SNIPPETS=true|false} <!-- Include actual code snippets in addition to file references --> ${CATEGORIZATION="Pattern Type|Architecture Layer|File Type"} <!-- How to organize exemplars --> ${MAX_EXAMPLES_PER_CATEGORY=3} <!-- Maximum number of examples per category --> ${INCLUDE_COMMENTS=true|false} <!-- Include explanatory comments for each exemplar -->

Generated Prompt

"このコードベースをスキャンして、exemplars.md ファイルを生成し、高品質で代表的なコード例を特定してください。これらの exemplar はコーディング標準とパターンを示し、一貫性の維持に役立つものである必要があります。以下のアプローチを使用してください:

1. コードベース分析フェーズ

• ${PROJECT_TYPE == "Auto-detect" ? "ファイル拡張子と設定ファイルをスキャンして、主要なプログラミング言語とフレームワークを自動的に検出" : ${PROJECT_TYPE} コードファイルに焦点を当てる}
• 高品質な実装、優れたドキュメント、明確な構造を持つファイルを特定
• 一般的に使用されるパターン、アーキテクチャコンポーネント、および適切に構造化された実装を探す
• テクノロジースタックのベストプラクティスを実証するファイルを優先
• コードベースに実際に存在するファイルのみを参照 - 仮想的な例は含めない

2. Exemplar 識別基準

• 構造がよく、読みやすく、命名規則が明確なコード
• 包括的なコメントとドキュメント
• 適切なエラーハンドリングと検証
• デザインパターンとアーキテクチャ原則への準拠
• 関心の分離と単一責任原則
• コードスメルのない効率的な実装
• 標準的なアプローチの代表例

3. コアパターンカテゴリ

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "Auto-detect" ? `#### .NET Exemplars (検出された場合)

• Domain Models: カプセル化とドメインロジックを適切に実装するエンティティを探す
• Repository 実装: データアクセスアプローチの例
• Service Layer コンポーネント: 構造がよいビジネスロジック実装
• Controller パターン: 適切な検証とレスポンスを備えたクリーンな API コントローラー
• Dependency Injection 使用法: DI 設定と使用法の良い例
• Middleware コンポーネント: カスタム middleware 実装
• Unit Test パターン: 適切な配置とアサーションを備えた構造のよいテスト` : ""}

${(PROJECT_TYPE == "JavaScript" || PROJECT_TYPE == "TypeScript" || PROJECT_TYPE == "React" || PROJECT_TYPE == "Angular" || PROJECT_TYPE == "Auto-detect") ? `#### Frontend Exemplars (検出された場合)

• Component Structure: クリーンで構造のよいコンポーネント
• State Management: ステート処理の良い例
• API Integration: 適切に実装されたサービス呼び出しとデータハンドリング
• Form Handling: 検証と送信パターン
• Routing Implementation: ナビゲーションとルート設定
• UI Components: 再利用可能で構造のよい UI 要素
• Unit Test 例: コンポーネントとサービステスト` : ""}

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Auto-detect" ? `#### Java Exemplars (検出された場合)

• Entity Classes: 適切に設計された JPA エンティティまたはドメインモデル
• Service 実装: クリーンな service layer コンポーネント
• Repository パターン: データアクセス実装
• Controller/Resource Classes: API エンドポイント実装
• Configuration Classes: アプリケーション設定
• Unit Tests: 構造のよい JUnit テスト` : ""}

${PROJECT_TYPE == "Python" || PROJECT_TYPE == "Auto-detect" ? `#### Python Exemplars (検出された場合)

• Class Definitions: 適切なドキュメント付きの構造のよいクラス
• API Routes/Views: クリーンな API 実装
• Data Models: ORM モデル定義
• Service Functions: ビジネスロジック実装
• Utility Modules: ヘルパーとユーティリティ関数
• Test Cases: 構造のよい単体テスト` : ""}

4. アーキテクチャレイヤー Exemplars

• Presentation Layer:

  • ユーザーインターフェースコンポーネント
  • Controller/API エンドポイント
  • ViewModel/DTO

• Business Logic Layer:

  • Service 実装
  • ビジネスロジックコンポーネント
  • ワークフロー編成

• Data Access Layer:

  • Repository 実装
  • データモデル
  • クエリパターン

• Cross-Cutting Concerns:

  • ログ実装
  • エラーハンドリング
  • 認証/認可
  • 検証

5. Exemplar ドキュメント形式

各識別された exemplar について、以下をドキュメント化:

• ファイルパス (リポジトリルートからの相対パス)
• exemplary である理由の簡潔な説明
• それが代表するパターンまたはコンポーネントタイプ ${INCLUDE_COMMENTS ? "- 実装された主要な実装詳細とコーディング原則" : ""} ${INCLUDE_CODE_SNIPPETS ? "- 小さく代表的なコードスニペット (該当する場合)" : ""}

${SCAN_DEPTH == "Comprehensive" ? `### 6. 追加ドキュメント

• 一貫性パターン: コードベース全体で観察される一貫性のあるパターンに注釈を付ける
• アーキテクチャ観察: コードに明らかなアーキテクチャパターンをドキュメント化
• 実装規約: 命名規則と構造規約を識別
• 回避すべきアンチパターン: コードベースがベストプラクティスから逸脱している領域を記録` : ""}

${SCAN_DEPTH == "Comprehensive" ? "7" : "6"}. 出力形式

exemplars.md を以下で作成:

1. ドキュメントの目的を説明するはじめに
2. カテゴリへのリンク付き目次
3. ${CATEGORIZATION} に基づいた整理されたセクション
4. カテゴリあたり最大 ${MAX_EXAMPLES_PER_CATEGORY} 個の exemplar
5. コード品質維持の推奨事項を含む結論

このドキュメントは、既存パターンと一貫性のある新機能を実装する必要がある開発者向けの実行可能なものである必要があります。

重要: コードベースからの実際のファイルのみを含めてください。すべてのファイルパスが存在することを確認してください。プレースホルダーまたは仮想的な例は含めないでください。 "

Expected Output

このプロンプトを実行すると、GitHub Copilot はコードベースをスキャンし、選択したパラメータに従って整理された、リポジトリ内の高品質なコード例への実際の参照を含む exemplars.md ファイルを生成します。