code-exemplars-blueprint-generator

Code Exemplars Blueprint Generator

配置变量

${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} <!-- 是否为每个范例添加说明性注释 -->

生成的 Prompt

"扫描当前代码库，生成一个 exemplars.md 文件，梳理出高质量且具代表性的代码范例。这些范例应能体现团队的代码规范与设计模式，从而保障代码一致性。请按以下步骤执行：

1. 代码库分析阶段

• ${PROJECT_TYPE == "Auto-detect" ? "通过扫描文件扩展名和配置文件，自动识别主要编程语言及框架" : 重点分析 ${PROJECT_TYPE} 相关代码文件}
• 挑选实现质量高、文档注释完善且结构清晰的文件
• 梳理常用设计模式、架构组件以及结构规范的实现
• 优先选择能体现当前技术栈最佳实践的文件
• 必须仅引用代码库中实际存在的文件，严禁虚构或使用假设性示例

2. 范例筛选标准

• 代码结构清晰、可读性强，命名符合规范
• 含有完善的注释与文档说明
• 具备规范的异常处理与数据校验
• 遵循设计模式与软件架构原则
• 满足单一职责原则与关注点分离（Separation of Concerns）
• 实现高效，无代码坏味道（Code Smells）
• 能够代表团队的标准开发范式

3. 核心模式分类

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "Auto-detect" ? `#### .NET 范例（若检测到）

• 领域模型（Domain Models）：寻找完善实现封装与领域逻辑的实体类
• 仓储实现（Repository Implementations）：展示团队数据访问层范式的示例
• 服务层组件（Service Layer Components）：结构清晰的业务逻辑实现
• Controller 范式（Controller Patterns）：包含完善校验与响应的标准 API Controller
• 依赖注入应用（Dependency Injection Usage）：DI 配置与使用的优秀范例
• 中间件组件（Middleware Components）：自定义 Middleware 实现
• 单元测试范式（Unit Test Patterns）：结构清晰、包含规范 Arrange/Act/Assert 的测试用例` : ""}

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

• 组件结构（Component Structure）：整洁、结构合理的组件
• 状态管理（State Management）：良好的状态处理示例
• API 集成（API Integration）：规范的 Service 请求封装与数据处理
• 表单处理（Form Handling）：表单校验与提交范式
• 路由实现（Routing Implementation）：页面导航与路由配置
• UI 组件（UI Components）：可复用、结构清晰的 UI 控件
• 单元测试范式（Unit Test Examples）：组件与 Service 的测试用例` : ""}

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Auto-detect" ? `#### Java 范例（若检测到）

• 实体类（Entity Classes）：设计良好的 JPA 实体或领域模型
• 服务层实现（Service Implementations）：整洁的服务层组件
• 仓储范式（Repository Patterns）：数据访问层实现
• Controller/Resource 类：API 端点实现
• 配置类（Configuration Classes）：应用配置组件
• 单元测试（Unit Tests）：结构规范的 JUnit 测试` : ""}

${PROJECT_TYPE == "Python" || PROJECT_TYPE == "Auto-detect" ? `#### Python 范例（若检测到）

• 类定义（Class Definitions）：带有完善文档注释、结构清晰的类
• API 路由/视图（API Routes/Views）：整洁的 API 端点实现
• 数据模型（Data Models）：ORM 模型定义
• 服务函数（Service Functions）：业务逻辑实现
• 工具模块（Utility Modules）：Helper 与工具函数
• 测试用例（Test Cases）：结构规范的单元测试` : ""}

4. 架构分层范例

• 表现层（Presentation Layer）：

  • 用户界面组件
  • Controller / API 端点
  • View Model / DTO

• 业务逻辑层（Business Logic Layer）：

  • 服务层实现
  • 业务逻辑组件
  • 工作流编排（Workflow Orchestration）

• 数据访问层（Data Access Layer）：

  • Repository 仓储实现
  • 数据模型
  • 查询范式（Query Patterns）

• 横切关注点（Cross-Cutting Concerns）：

  • 日志记录实现
  • 异常处理
  • 身份认证与授权（AuthN/AuthZ）
  • 数据校验

5. 范例文档输出格式

对每个识别出的范例，记录以下内容：

• 文件路径（相对于仓库根目录）
• 简要说明该代码为何具有示范意义
• 所代表的模式或组件类型
  ${INCLUDE_COMMENTS ? "- 所体现的关键实现细节与编码原则" : ""}
  ${INCLUDE_CODE_SNIPPETS ? "- 具有代表性的精简代码片段（如适用）" : ""}

${SCAN_DEPTH == "Comprehensive" ? `### 6. 补充文档说明

• 一致性模式（Consistency Patterns）：记录全代码库中观察到的高一致性模式
• 架构观测（Architecture Observations）：梳理代码中所体现的架构设计模式
• 实现约定（Implementation Conventions）：识别命名与目录结构约定
• 需规避的反模式（Anti-patterns to Avoid）：指出代码库中偏离最佳实践的区域` : ""}

${SCAN_DEPTH == "Comprehensive" ? "7" : "6"}. 输出格式要求

生成 exemplars.md 文件，包含：

1. 阐明文档目的的引言
2. 附带各分类跳转链接的目录
3. 基于 ${CATEGORIZATION} 组织的分类章节
4. 每个分类下最多保留 ${MAX_EXAMPLES_PER_CATEGORY} 个优质范例
5. 包含代码质量维护建议的总结

该文档应具备强可操作性，能够为开发者在按照既有范式开发新功能时提供明确指导。

重要提醒：仅允许包含代码库中的实际存在文件。请核对确保所有文件路径真实有效。切勿包含占位符或假设性示例。
"

预期输出

运行此 Prompt 后，GitHub Copilot 将扫描你的代码库，并根据你选择的参数生成包含项目中真实优质代码引用的 exemplars.md 文件。