.cursorignore 文件的主要功能是告诉 Cursor 的 AI 默认忽略某些文件或目录,不将它们纳入代码补全、上下文分析或搜索的默认上下文。 特别是如果数据分析类项目中有一些很大或很多的csv文件,使用.cursorignore 文件就非常有必要。
使用方法
-
创建 .cursorignore 文件:
- 在项目根目录下创建一个名为 .cursorignore 的文件。
- 如果没有这个文件,Cursor 会默认使用 .gitignore 的内容(如果存在)。
-
语法:
- 每行指定一个模式,表示要忽略的文件或目录。
- 支持通配符(*、?)和目录路径。
- 注释以 # 开头。
- 使用 ! 可以反向匹配(包含原本会被忽略的文件)。
-
示例:
plaintext
# 忽略 node_modules 目录 node_modules/ # 忽略所有 .log 文件 *.log # 忽略 dist 目录下的所有文件 dist/ # 忽略特定的配置文件 config.secret.json # 例外:包含 dist 中的 index.js !dist/index.js
Cursor没有内置自动生成 .cursorignore 的命令:不像 .cursorrules 文件可以通过 /Generate Cursor Rules 指令自动生成。但可以输入类似以下提示:
请为我的项目生成一个 .cursorignore 文件,忽略常见的不需要 AI 分析的文件和目录,例如 node_modules、dist、.env、日志文件等。
例外
当使用 @ 上下文(如 @file:.env 或通过界面选择特定文件)明确指定某个文件时,Cursor 会绕过 .cursorignore 的限制,直接加载该文件的内容作为 AI 的上下文。
即使文件或目录被列在 .cursorignore 文件中,如果你通过 主动 @ 上下文(@ context) 明确引用这些文件,Cursor 的 AI 仍然可以访问和使用它们