cursor的.cursorrules详解

在这里插入图片描述

文章目录

- - 1. 文件位置与作用
  - 2. 基本语法规则
  - 3. 常用规则类型与示例
  - - 3.1 忽略文件/目录
    - 3.2 限制代码生成范围
    - 3.3 自定义补全建议
    - 3.4 安全规则
  - 4. 高级用法
  - - 4.1 条件规则
    - 4.2 正则表达式匹配
    - 4.3 继承规则
  - 5. 示例文件
  - 6. 注意事项

Cursor 是一款基于 AI 的智能代码编辑器，其 .cursorrules 文件用于自定义代码生成、自动补全和其他 AI 行为的规则，关于cursor就不详细介绍了，懂得都懂。以下是关于 .cursorrules 的详细用法和规则说明：

1. 文件位置与作用

位置：.cursorrules 文件应放在项目根目录下（类似 .gitignore）。
作用：通过该文件，你可以控制 AI 在代码生成、补全时的行为，例如：
- 忽略特定文件或目录。
- 定义代码生成的风格规则。
- 限制 AI 对某些代码的操作（如禁止修改关键文件）。

2. 基本语法规则

通配符支持：使用 * 匹配任意字符，** 匹配多级目录。
注释：以 # 开头的行是注释。
规则优先级：规则从上到下匹配，后面的规则可能覆盖前面的。

3. 常用规则类型与示例

3.1 忽略文件/目录

目的：阻止 AI 读取或修改某些文件。

语法：

ignore: path/to/file
ignore: **/tests/*
ignore: *.config.js

示例：

# 忽略所有测试文件
ignore: **/*.test.js
# 忽略 node_modules 目录
ignore: node_modules/

3.2 限制代码生成范围

目的：控制 AI 生成的代码类型。

语法：

restrict: "生成代码时仅使用函数式编程"
restrict: "避免使用全局变量"
restrict: "代码需符合 ESLint 规则"

示例：

# 强制生成 TypeScript 类型
restrict: "请为所有函数参数和返回值添加 TypeScript 类型"

3.3 自定义补全建议

目的：定义自动补全的偏好。

语法：

suggest: "优先使用箭头函数"
suggest: "使用 async/await 替代 Promise.then"

示例：

# 在 React 组件中优先使用 Hooks
suggest: "在 React 组件中使用 useState 和 useEffect"

3.4 安全规则

目的：防止 AI 修改敏感代码。

语法：

protected: src/core/auth.js
protected: **/database/migrations/*

示例：

# 保护 API 密钥相关文件
protected: **/config/secrets.js

4. 高级用法

4.1 条件规则

根据文件类型应用不同规则：

[*.py]
restrict: "使用类型注解（Type Hints）"[*.js]
restrict: "遵循 Airbnb JavaScript 风格指南"

4.2 正则表达式匹配

使用正则表达式精准匹配路径：
```
ignore-regex: ^.*/legacy/.*\.js$
```

4.3 继承规则

引用其他规则文件（需确认 Cursor 是否支持）：
```
extend: .team_rules
```

5. 示例文件

# .cursorrules# 忽略测试文件和配置文件
ignore: **/*.test.js
ignore: **/config/*.json# 限制生成规则
restrict: "使用 ES6+ 语法"
restrict: "避免使用 var"# 保护关键文件
protected: src/utils/encryption.js# 针对 Python 文件的规则
[*.py]
suggest: "优先使用 f-string 格式化字符串"