本文将介绍CursorRules,并教导您如何使用。

什么是Rules?

简单的一句话描述:充当着用户和底层沟通的桥梁。你不必每次都要告诉AI怎么做,他会自动在这个规则下执行。
如果说得更直白的话,它充当我们与大模型交互的提示词(prompt)。

Rules的类型有哪些?

规则的类型包括方式,全局规则、项目规则。

全局规则

一般指:全局通过,与项目无关。如使用中文与AI交互、缩进使用2个空格,字符串使用单引号、所有的函数必须写注释。

规则示例

-  使用中文与 AI 进行交互。
-  缩进使用 2 个空格。
-  字符串使用单引号。
-  所有的函数必须写注释。

如何配置?

项目规则

一般指:在项目中使用的规则,项目规则位于.cursor/rules中。每个规则存储为文件并受版本控制。它们可以使用路径模式限定作用域、手动调用或基于相关性包含。

规则示例

主入口文件是 [index.ts](mdc:index.ts),它从 [config.ts](mdc:config.ts) 加载配置。

## 组件
- 组件位于 [app/components](mdc:app/components) 目录中。
- 每个组件应是自包含的,并包含自己的样式。

## 资源
- 静态资源(如图片和字体)存储在 [assets](mdc:assets) 目录中。

## 工具
- 工具函数可以在 [utils](mdc:utils) 目录中找到。

## 测试
- 测试文件位于 [tests](mdc:tests) 目录中,遵循命名约定 `*.test.ts`## 规则
- 所有规则存储在 [.cursor/rules](mdc:.cursor/rules) 目录中。

如何配置?

  • 使用文件配置

  • 使用界面配置

规则使用的类型

规则使用的类型包括:永远使用、通过配置自动使用、通过AI工具识别使用、手动使用。

1、永远执行:每次与AI交流的时候,都会使用的规则。

2、根据匹配文件格式自动附加:当引用匹配glob模式的文件时包含

3、AI工具可用,由AI决定是否包含该规则。必须提供描述

4、手动:仅在使用@ruleName明确提及时包含

rules的生成

生成的方式包括:手动编写、使用cursor AI编写、通过网方下载。

  • 手动编写

  • 使用cursor工具生成

  • 进入官网直接下载

官方提供:https://cursor.directory

官方提供全部是英文,可以通过AI转换成中文

Rules的示例使用

下列是示例视频:

下列是示例截图:

  • 实体

  • 持久层

  • 业务层

  • 控制层

总结

使用cursor规则的优势:

  • 自动执行重复性任务,允许您专注于编写高质量的代码。
  • 统一编码标准,确保统一且可读的代码库。
  • 在使用AI开发过程中,节省错误的提示词。
作者:吴升斌  创建时间:2025-04-27 14:54
最后编辑:吴升斌  更新时间:2025-05-09 17:45