code-exemplars-blueprint-generator

Code Exemplars Blueprint Generator

Configuration Variables

${PROJECT_TYPE="Auto-detect|.NET|Java|JavaScript|TypeScript|React|Angular|Python|Other"} <!-- 主要技術類別 -->
${SCAN_DEPTH="Basic|Standard|Comprehensive"} <!-- 分析程式碼庫的深度 -->
${INCLUDE_CODE_SNIPPETS=true|false} <!-- 除了檔案引用外，是否包含實際的程式碼片段 -->
${CATEGORIZATION="Pattern Type|Architecture Layer|File Type"} <!-- 範例程式碼的分類方式 -->
${MAX_EXAMPLES_PER_CATEGORY=3} <!-- 每個分類最多包含的範例數量 -->
${INCLUDE_COMMENTS=true|false} <!-- 是否為每個範例提供說明註解 -->

Generated Prompt

"請掃瞄此程式碼庫，並產生一份 exemplars.md 檔案，用以標示出高品質且具代表性的程式碼範例。這些範例應展示我們的程式碼規範與設計模式，以協助團隊維持一致性。請遵循以下步驟與原則：

1. 程式碼庫分析階段

• ${PROJECT_TYPE == "Auto-detect" ? "透過掃瞄副檔名與設定檔，自動偵測主要的程式語言與框架" : 聚焦於 ${PROJECT_TYPE} 的程式碼檔案}
• 找出實作品質高、文件完善且結構清晰的檔案
• 尋找常用模式、架構元件以及結構良善的實作
• 優先挑選能展示我們技術棧最佳實踐的檔案
• 僅能引用程式碼庫中實際存在的檔案——切勿使用假想或虛構的範例

2. 範例篩選標準

• 結構良善、可讀性高且命名規範清晰的程式碼
• 完整詳細的註解與文件說明
• 妥善的錯誤處理與資料驗證
• 遵循設計模式與架構原則
• 良好的關注點分離（Separation of Concerns）與單一職責原則（Single Responsibility Principle）
• 高效實作，無程式碼壞氣味（Code Smells）
• 能代表我們團隊標準開發方式的程式碼

3. 核心模式分類

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "Auto-detect" ? `#### .NET 範例（若偵測到）

• 領域模型 (Domain Models)：找出妥善實作封裝與領域邏輯的實體 (Entities)
• Repository 實作：展現資料存取方式的範例
• 服務層元件 (Service Layer Components)：結構清晰的商業邏輯實作
• Controller 模式：具備完善驗證與回應機制的乾淨 API Controller
• 相依注入 (Dependency Injection) 使用：DI 設定與活用的良好範例
• 中介軟體元件 (Middleware Components)：自訂 Middleware 實作
• 單元測試模式 (Unit Test Patterns)：排列有序且斷言明確的結構化測試` : ""}

${(PROJECT_TYPE == "JavaScript" || PROJECT_TYPE == "TypeScript" || PROJECT_TYPE == "React" || PROJECT_TYPE == "Angular" || PROJECT_TYPE == "Auto-detect") ? `#### 前端範例（若偵測到）

• 元件結構 (Component Structure)：乾淨且結構良好的元件
• 狀態管理 (State Management)：狀態處理的良好範例
• API 整合：實作完善的服務呼叫與資料處理
• 表單處理 (Form Handling)：驗證與送出模式
• 路由實作 (Routing Implementation)：導覽與路由設定
• UI 元件：可重複使用且結構佳的 UI 元素
• 單元測試範例：元件與服務的測試案例` : ""}

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Auto-detect" ? `#### Java 範例（若偵測到）

• 實體類別 (Entity Classes)：設計良好的 JPA 實體或領域模型
• 服務層實作 (Service Implementations)：乾淨的服務層元件
• Repository 模式：資料存取層實作
• Controller/Resource 類別：API 端點實作
• 設定類別 (Configuration Classes)：應用程式設定
• 單元測試：結構完善的 JUnit 測試` : ""}

${PROJECT_TYPE == "Python" || PROJECT_TYPE == "Auto-detect" ? `#### Python 範例（若偵測到）

• 類別定義 (Class Definitions)：附帶完整文件的結構化類別
• API 路由/檢視 (API Routes/Views)：乾淨的 API 實作
• 資料模型 (Data Models)：ORM 模型定義
• 服務函式 (Service Functions)：商業邏輯實作
• 工具模組 (Utility Modules)：Helper 與 Utility 函式
• 測試案例 (Test Cases)：結構良好的單元測試` : ""}

4. 架構層級範例

• 展示層 (Presentation Layer)：

  • 使用者介面元件
  • Controller / API 端點
  • View Model / DTO

• 商業邏輯層 (Business Logic Layer)：

  • 服務層實作
  • 商業邏輯元件
  • 工作流協調 (Workflow Orchestration)

• 資料存取層 (Data Access Layer)：

  • Repository 實作
  • 資料模型
  • 查詢模式

• 跨領域關注點 (Cross-Cutting Concerns)：

  • 紀錄檔 (Logging) 實作
  • 錯誤處理
  • 身份驗證與授權 (Authentication/Authorization)
  • 資料驗證

5. 範例文件格式

針對每個識別出的範例，請記錄：

• 檔案路徑（相對於儲存庫根目錄）
• 簡述其為何能作為優良範例
• 其所代表的模式或元件類型
  ${INCLUDE_COMMENTS ? "- 所展示的關鍵實作細節與程式碼編寫原則" : ""}
  ${INCLUDE_CODE_SNIPPETS ? "- 簡短且具代表性的程式碼片段（若適用）" : ""}

${SCAN_DEPTH == "Comprehensive" ? `### 6. 補充文件

• 一致性模式：標示整個程式碼庫中觀察到的一致性模式
• 架構觀察：記錄程式碼中展現的架構模式
• 實作慣例：識別命名與結構方面的慣例
• 應避免的反模式 (Anti-patterns)：標示程式碼庫中偏離最佳實踐的區域` : ""}

${SCAN_DEPTH == "Comprehensive" ? "7" : "6"}. 輸出格式

建立 exemplars.md，包含以下內容：

1. 前言：說明本文件的目的
2. 目錄：包含指向各分類的連結
3. 分類章節：依據 ${CATEGORIZATION} 進行組織
4. 範例數量：每個分類最多收錄 ${MAX_EXAMPLES_PER_CATEGORY} 個範例
5. 結語：提出維護程式碼品質的建議事項

本文件應具備可操作性，以便開發人員在實作符合既存模式的新功能時獲得明確指引。

重要提醒：僅能包含程式碼庫中實際存在的檔案。請確認所有檔案路徑皆真實存在。切勿包含占位符或虛構的範例。
"

預期輸出

執行此 Prompt 後，GitHub Copilot 將會掃瞄您的程式碼庫，並根據您選擇的參數，產生一份包含儲存庫中真實且高品質程式碼引用的 exemplars.md 檔案。