mcpField
C
code-exemplars-blueprint-generator

code-exemplars-blueprint-generator

github.com/github开发40.5k8.8k 次安装今天更新
代码仓库

关于 code-exemplars-blueprint-generator

这是供 GitHub Copilot 使用的可配置提示词，用于扫描代码库并生成 exemplars.md，整理具有代表性的代码模式。开发者可设置项目类型、扫描深度、分类方式及代码片段选项。

主要功能

  1. 01自动检测或指定项目类型
  2. 02选择扫描深度
  3. 03按模式、架构层或文件分类
  4. 04选择是否包含代码片段和注释
  5. 05限制每类示例数量

适用场景

  1. 01记录仓库中的代表性实现
  2. 02帮助开发者遵循现有代码模式
  3. 03梳理代码库中的惯例

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill code-exemplars-blueprint-generator

安装后在 Claude Code 中输入/code-exemplars-blueprint-generator确认已加载。

详细介绍

代码范例蓝图生成器

配置变量

${PROJECT_TYPE="自动检测|.NET|Java|JavaScript|TypeScript|React|Angular|Python|其他"} ${SCAN_DEPTH="基础|标准|全面"} ${INCLUDE_CODE_SNIPPETS=true|false} ${CATEGORIZATION="模式类型|架构层|文件类型"} ${MAX_EXAMPLES_PER_CATEGORY=3} ${INCLUDE_COMMENTS=true|false}

生成的提示词

"扫描此代码库并生成一个 exemplars.md 文件，用于识别高质量、具有代表性的代码示例。这些范例应展示我们的编码标准和模式，以帮助保持一致性。使用以下方法：

1. 代码库分析阶段
  • ${PROJECT_TYPE == "自动检测" ? "通过扫描文件扩展名和配置文件，自动检测主要编程语言和框架" : 聚焦于 ${PROJECT_TYPE} 代码文件}
  • 识别具有高质量实现、良好文档和清晰结构的文件
  • 寻找常用模式、架构组件和结构良好的实现
  • 优先选择能够展示我们技术栈最佳实践的文件
  • 只引用代码库中实际存在的文件——不要使用假设性示例
2. 范例识别标准
  • 结构良好、可读性强、命名规范清晰的代码
  • 全面的注释和文档
  • 适当的错误处理和验证
  • 遵循设计模式和架构原则
  • 关注点分离和单一职责原则
  • 高效实现，没有代码坏味道
  • 代表我们的标准做法
3. 核心模式类别

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "自动检测" ? `#### .NET 范例（如果检测到）

  • 领域模型：找到正确实现封装和领域逻辑的实体
  • 仓储实现：我们数据访问方式的示例
  • 服务层组件：结构良好的业务逻辑实现
  • 控制器模式：具有适当验证和响应的简洁 API 控制器
  • 依赖注入用法：DI 配置和用法的良好示例
  • 中间件组件：自定义中间件实现
  • 单元测试模式：结构良好、具有适当安排和断言的测试` : ""}

${(PROJECT_TYPE == "JavaScript" || PROJECT_TYPE == "TypeScript" || PROJECT_TYPE == "React" || PROJECT_TYPE == "Angular" || PROJECT_TYPE == "自动检测") ? `#### 前端范例（如果检测到）

  • 组件结构：简洁、结构良好的组件
  • 状态管理：状态处理的良好示例
  • API 集成：实现良好的服务调用和数据处理
  • 表单处理：验证和提交模式
  • 路由实现：导航和路由配置
  • UI 组件：可复用、结构良好的 UI 元素
  • 单元测试示例：组件和服务测试` : ""}

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "自动检测" ? `#### Java 范例（如果检测到）

  • 实体类：设计良好的 JPA 实体或领域模型
  • 服务实现：简洁的服务层组件
  • 仓储模式：数据访问实现
  • 控制器/资源类：API 端点实现
  • 配置类：应用程序配置
  • 单元测试：结构良好的 JUnit 测试` : ""}

${PROJECT_TYPE == "Python" || PROJECT_TYPE == "自动检测" ? `#### Python 范例（如果检测到）

  • 类定义：结构良好、具有适当文档的类
  • API 路由/视图：简洁的 API 实现
  • 数据模型：ORM 模型定义
  • 服务函数：业务逻辑实现
  • 工具模块：辅助函数和实用函数
  • 测试用例：结构良好的单元测试` : ""}
4. 架构层范例

  • 表现层：

    • 用户界面组件
    • 控制器/API 端点
    • 视图模型/DTO

  • 业务逻辑层：

    • 服务实现
    • 业务逻辑组件
    • 工作流编排

  • 数据访问层：

    • 仓储实现
    • 数据模型
    • 查询模式

  • 横切关注点：

    • 日志实现
    • 错误处理
    • 认证/授权
    • 验证
5. 范例文档格式

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

  • 文件路径（相对于仓库根目录）
  • 简要说明其为何堪称范例
  • 其所代表的模式或组件类型 ${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} 个范例
  5. 包含维护代码质量建议的结语

本文档应能为需要指导、以按照现有模式实现新功能的开发者提供可操作的信息。

重要：仅包含代码库中的实际文件。验证所有文件路径均存在。不要包含占位或假设性示例。 "

预期输出

运行此提示词后，GitHub Copilot 将扫描你的代码库，并生成一个 exemplars.md 文件，其中包含对仓库中高质量代码示例的真实引用，并按你所选的参数进行组织。

评论

支持 Markdown