mcpField
B
blueprint-rules

blueprint-rules

github.com/laurigatesAgent 工作流5957 次安装1 天前更新
代码仓库

关于 blueprint-rules

blueprint-rules 是用于管理项目模块化规则的 Skill,面向维护 Claude 项目指令的团队。它支持创建和编辑规则、按文件路径限定适用范围,并与 CLAUDE.md 双向同步。

主要功能

  1. 01列出项目级和用户级规则
  2. 02创建与编辑模块化规则
  3. 03按路径限定规则适用范围
  4. 04从 PRD 生成规则
  5. 05与 CLAUDE.md 同步并验证

适用场景

  1. 01为特定文件类型添加规则
  2. 02从项目 PRD 整理要求
  3. 03将 CLAUDE.md 拆分为规则文件
  4. 04检查规则的路径模式与冲突

安装

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

$npx skills add https://github.com/laurigates/claude-plugins --skill blueprint-rules

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

详细介绍

管理项目的模块化规则。规则是 .claude/rules/ 中的 Markdown 文件,为 Claude 提供特定上下文的指令。

何时使用此技能

在以下情况下使用此技能……在以下情况下使用替代方案……
需要在 .claude/rules/ 中创建或编辑模块化规则使用 /blueprint:claude-md 编写单文件项目指令
想要列出所有项目级和用户级规则使用 /blueprint:generate-rules 根据 PRD 自动生成规则
需要为特定文件类型添加路径专属规则只需要查看 CLAUDE.md 结构
管理用户级规则(~/.claude/rules/)需要将规则与现有 CLAUDE.md 同步

规则层级(优先级从低到高)

层级位置范围
用户级~/.claude/rules/*.md适用于所有项目的个人规则
项目规则.claude/rules/*.md(不含 paths)本项目中的所有文件
路径专属规则.claude/rules/*.md(含 paths)仅适用于匹配的文件

项目规则优先于用户级规则。处理匹配的文件时,会有条件地加载路径专属规则。

步骤:

  1. 检查 Blueprint 状态:

    • 读取 docs/blueprint/manifest.json
    • 检查是否启用了模块化规则
    • 如果未启用,询问是否启用:
      Use AskUserQuestion:
      question: "尚未启用模块化规则。是否要启用?"
      options:
        - "Yes, create .claude/rules/ structure" → 启用并继续
        - "No, use single CLAUDE.md" → 退出
      
  2. 确定操作(使用 AskUserQuestion):

    question: "What would you like to do with modular rules?"
    options:
      - "List existing rules" → show project and user-level rules
      - "Add a new rule" → create new rule file
      - "Edit existing rule" → modify rule
      - "Generate rules from PRDs" → auto-generate from requirements
      - "Manage user-level rules" → personal rules in ~/.claude/rules/
      - "Sync rules with CLAUDE.md" → bidirectional sync
      - "Validate rules" → check for issues
    
  3. 列出现有规则:

    • 递归扫描 .claude/rules/ 中的 .md 文件
    • 扫描 ~/.claude/rules/ 中的用户级规则
    • 解析 frontmatter 中的 paths 字段(如果有范围限定)
    • 显示:
      📜 模块化规则
      
      用户级规则(~/.claude/rules/ — 个人规则,适用于所有项目):
      - preferences.md - 个人编码风格
      - workflow.md - 个人工作流习惯
      
      项目全局规则(适用于所有文件):
      - development.md - TDD 工作流和约定
      - testing.md - 测试要求
      
      路径专属规则(适用于特定路径):
      - frontend/react.md - paths: ["src/components/**/*.{ts,tsx}"]
      - backend/api.md - paths: ["src/api/**/*.ts"]
      
      总计:6 条规则(2 条用户级、2 条全局、2 条路径专属)
      
  4. 添加新规则(使用 AskUserQuestion):

    question: "What type of rule would you like to create?"
    options:
      - "Development workflow" → development.md template
      - "Testing requirements" → testing.md template
      - "Code style/conventions" → code-style.md template
      - "Architecture patterns" → architecture.md template
      - "Language-specific" → prompt for language
      - "Framework-specific" → prompt for framework
      - "Custom" → blank template with guidance
    

    然后询问:

    question: "Should this rule apply to all files or specific paths?"
    options:
      - "All files (global)" → no paths frontmatter
      - "Specific file patterns" → prompt for glob patterns
    
  5. 规则文件模板:

    全局规则模板:

    # {Rule Name}
    
    ## Overview
    {Brief description of when this rule applies}
    
    ## Requirements
    - {Requirement 1}
    - {Requirement 2}
    
    ## Examples
    {Code examples if applicable}
    

    范围限定规则模板(带有 paths frontmatter):

    ---
    paths:
      - "src/components/**/*.{ts,tsx}"
    ---
    
    # {Rule Name}
    
    ## Overview
    {Brief description - applies only to matched paths}
    
    ## Requirements
    - {Requirement 1}
    - {Requirement 2}
    

    支持花括号展开:*.{ts,tsx} 可同时匹配 .ts 和 .tsx 文件。 Glob 模式遵循标准语法:** 表示递归匹配,* 表示单层匹配。

  6. 根据 PRD 生成规则:

    • 读取 docs/prds/ 中的所有 PRD
    • 提取关键需求和约束
    • 按领域分组(测试、架构、编码标准)
    • 生成规则文件:
      • rules/from-prd-testing.md - PRD 中的测试要求
      • rules/from-prd-architecture.md - 架构决策
      • rules/from-prd-conventions.md - 编码约定
  7. 将规则与 CLAUDE.md 同步:

    • 解析现有 CLAUDE.md 章节
    • 与 .claude/rules/ 中的规则进行比较
    • 提供同步选项:
      question: "希望如何同步?"
      options:
        - "CLAUDE.md → rules (拆分为模块化文件)"
        - "Rules → CLAUDE.md (合并)"
        - "Merge both (合并不重复的内容)"
      
  8. 验证规则:

    • 检查 frontmatter 中的语法错误
    • 验证 paths 字段中的 glob 模式
    • 检查是否存在冲突规则
    • 提示范围过宽或过窄的规则
    • 报告:
      ✅ 规则验证
      
      已检查:4 条规则
      有效:4 条
      警告:1 条
        - frontend/react.md:paths 模式可能过宽
      
      未发现错误。
      
  9. 更新清单:

    • 将创建/修改规则添加到 generated_artifacts.rules
    • 更新 updated_at 时间戳
  10. 报告:

    ✅ 规则管理完成!
    
    {Action summary}
    
    当前规则:{count} 个文件
    - 全局:{count}
    - 限定范围:{count}
    
    运行 `/blueprint:status` 查看完整配置。
    
  11. 提示下一步操作(使用 AskUserQuestion):

    question: "规则已更新。接下来你想做什么?"
    options:
      - label: "更新 CLAUDE.md(推荐)"
        description: "重新生成概览以反映规则变更"
      - label: "添加另一条规则"
        description: "创建其他特定领域的规则"
      - label: "检查 blueprint 状态"
        description: "运行 /blueprint:status 查看完整配置"
      - label: "暂时先到这里"
        description: "退出 - 规则已立即生效"
    

    根据选择执行:

    • "更新 CLAUDE.md" → 运行 /blueprint:claude-md
    • "添加另一条规则" → 从第 4 步(添加新规则)重新开始
    • "检查 blueprint 状态" → 运行 /blueprint:status
    • "暂时先到这里" → 退出

常见规则模式:

规则类型建议路径作用范围模式
React 组件rules/frontend/react.md["**/*.{tsx,jsx}"]
API 处理程序rules/backend/api.md["src/{api,routes}/**/*"]
数据库模型rules/backend/models.md["src/{models,db}/**/*"]
测试文件rules/testing.md["**/*.{test,spec}.*"]
文档rules/docs.md["**/*.md", "docs/**/*"]
配置文件rules/config.md["*.config.{js,ts,mjs}", ".env*"]

评论

支持 Markdown