SuperAPI AI 工具集

cursor-reference-architecture

编程与开发

查看项目

更新于 10-16 09:08

技能介绍

用途

Cursor Reference Architecture 用于组织 Cursor IDE 项目中的规则、忽略文件、仓库指引和工作区边界,使 AI 辅助遵循既有架构,而不是自行发明架构。它面向需要统一团队 AI 编码行为的仓库,尤其是多项目、多包或对安全与合规有要求的代码库。

主要能力

  • 目录结构参考:给出便于 AI 功能发挥作用的项目布局,例如 .cursor/rules/ 下按主题拆分规则文件,src/ 下按 api、services、db、types、utils、components 分层,并保留 docs/ 供 @Docs 引用。
  • 规则分层架构:分为常开全局规则(项目上下文与约定)、常开安全规则、按 glob 限定的技术规则(React 组件、API 路由、数据库)、以及手动引用规则(部署等)。
  • 索引策略:通过 .cursorignore 排除构建产物、依赖、生成文件、数据资产、环境变量和 IDE 目录;通过 .cursorindexingignore 让大体积参考资料不被索引但仍可通过 @Files 访问。
  • 多项目/单体仓库配置:在 monorepo 中设置共享约定规则,并按 apps/ 与 packages/ 分别限定规则作用域,明确跨包导入约定。
  • 配置清单:说明哪些文件应提交到 Git(.cursor/rules/*.mdc、.cursorignore、.cursorindexingignore),哪些是机器本地配置(settings.json、keybindings.json)。
  • 企业考量:将规则视为代码,要求 PR 评审;建立公司模板仓库;把安全规则映射到合规控制项;保持 docs/ 被索引以便 AI 引用架构决策。

使用方式

  1. 前置条件:已有经批准的仓库架构、归属模型和数据分类策略;有获授权评审 .cursor/rules、忽略文件和共享模板的维护者。
  2. 将持久的工程约定写入经评审的规则文件,把敏感或生成路径放入忽略文件。
  3. 按仓库区域限定规则作用域,避免相互冲突的常开指令。
  4. 在代表性工作区测试规则与索引变更,再在全组织推广。
  5. 通过常规拉取请求评审这些文件,必要时引入安全与架构负责人。

适用场景

  • 单体仓库(monorepo)中需要共享导入约定并为每个应用设置限定规则。
  • 需要将密钥、生成产物、客户导出等敏感路径排除在 AI 上下文与索引之外。
  • 希望把安全约束(如禁止硬编码密钥、使用参数化查询、输入校验)固化为常开规则。
  • 需要将规则变更纳入代码评审与合规映射流程的团队。

限制与错误处理

  • 规则冲突时:缩减为一条权威规则,并在小工作区中测试。
  • 敏感路径被索引时:添加忽略规则,验证排除生效,并按策略评估暴露情况。
  • 共享模板破坏仓库时:回滚配置变更,改用限定范围的仓库覆盖。
  • 资料未提供具体的收费、价格、平台支持范围或效果保证等信息。