@clipboard-health/ai-rules (英语)

为一致的编码标准预建的AI代理规则. 使用基于检索的方法: 在 AGENTS.md 指向复制 .rules/ 需要时代理读取的文件.

目录

• 安装
• 使用量
  • 快速启动
  • 包含/执行规则
  • 更新规则
• 现行规则
• 贡献规则
• 从v1移徙
• 地方发展指挥部

安装

npm install --save-dev @clipboard-health/ai-rules

使用量

快速启动

1. 如果你有一个存在 AGENTS.md 和(或) CLAUDE.md 文件中的文件,将其重命名为 OVERLAY.md。同步脚本附加此文件的内容生成 AGENTS.md 因此它被装入LLM代理上下文.

2. 选择匹配您的工程类型的配置 :

   简介	包括	用于
   common	常见	TypeScript 库, 通用项目
   frontend	常见 + 前端	反应应用程序,网络应用程序
   backend	常见 + 后端	NestJS服务,APIs
   fullstack	常见 + 前端 +后端	单相机、全相机
   datamodeling	数据建模	DBT 数据建模

3. 把它加进你的 package.json数字 :

   {
     "scripts": {
       "sync-ai-rules": "node ./node_modules/@clipboard-health/ai-rules/scripts/sync.js [PROFILE_NAME]",
       "postinstall": "node --run sync-ai-rules"
     }
   }
   

4. 运行 :

   npm install  # Runs postinstall automatically
   

5. 提交生成的文件 :

   git add .rules/ AGENTS.md CLAUDE.md
   git commit -m "feat: add AI coding rules"
   

包含/执行规则

微调使用哪些规则同步 --include 财务报告和审定财务报表 --exclude数字 :

# Backend profile without MongoDB rules
node sync.js backend --exclude backend/mongodb

# Common profile plus one backend rule
node sync.js common --include backend/architecture

# Multiple overrides
node sync.js backend --exclude backend/mongodb backend/postgres --include frontend/testing

不明规则的ID被跳过 警告,所以僵化 --include编号 :--exclude 永不中断安装.

更新您的 package.json 脚本相应:

{
  "scripts": {
    "sync-ai-rules": "node ./node_modules/@clipboard-health/ai-rules/scripts/sync.js backend --exclude backend/mongodb"
  }
}

更新规则

当我们发布新的规则或改进:

# Update the package
npm update @clipboard-health/ai-rules

# The postinstall script automatically syncs the latest files
npm install

# Review the changes
git diff .rules/ AGENTS.md

# Commit the updates
git add .rules/ AGENTS.md CLAUDE.md
git commit -m "chore: update AI coding rules"

规则偶尔被拆分,所以每个都带有更窄的检索触发器. 如果你给个人规则编号 --include 而不是取一个完整类别, 请在升级后检查 diff 是否为新的 id: stale --include 继续解决,所以你失去了 分出规则,没有警告.

现行规则

每个规则的"何时阅读"文本都来自 description 字段在规则文件的 YAML 前题中——用于生成的真理的单一来源 AGENTS.md 指数和下表.

后端

常见

数据建模

前端

贡献规则

一个规则只有在边疆模型没有它会做错事情的情况下才能获得它的地位:剪贴板特有决定,图书库选择,命名,和来之不易的Gotchas. 不要添加教程、通用最佳做法或任何已经执行的线条.

增加或修改一项规则:

1. 编辑或创建规则文件 rules/<category>/ 带有前题 description ("何时读"正文.
2. 运行 npx tsx scripts/populateReadme.ts 重新生成上表(如果漂移,测试失败).
3. 新建类别为目录 rules/;不需要登记.

从v1移徙

v2 替换单曲 AGENTS.md 采用基于检索的方法。 规则文件现在被输入您的重播 .rules/。 。 。 .

1. 更新软件包 :

   npm install --save-dev @clipboard-health/ai-rules@latest
   

2. 运行安装以触发同步 :

   npm install
   

3. 添加 .rules/ 承诺:

   git add .rules/ AGENTS.md CLAUDE.md
   git commit -m "feat!: update ai-rules to v2 retrieval-based approach"
   

地方发展指挥部

见 package.json scripts 用于命令列表.