Awesome Cursor Rules - GitHub
一份开源配置文件集合,专为提升 Cursor AI 编辑器的开发体验而设计,涵盖自定义规则与行为,帮助开发者构建更高效的 AI 辅助编程环境。
重新定义代码编辑体验
Cursor 是一款基于 AI 的代码编辑工具,它通过智能补全、代码建议、自动修复等功能,显著提升了开发效率。然而,Cursor 的真正潜力在于其高度可定制的.cursorrules文件——这些配置文件允许开发者自定义插件行为、代码补全策略、语法高亮规则等。通过这些规则,开发者能够深度优化其工作流,使 Cursor 成为真正意义上的个人生产力工具。
什么是 .cursorrules 文件?
.cursorrules 文件本质上是一种JSON 格式的配置文件,它定义了 Cursor 插件的行为规则。开发者可以通过这些规则控制代码补全的上下文、触发条件、语法高亮模式等。例如,你可以在规则中指定某种语言的代码格式,或者定义特定函数调用的自动补全行为。
实战:构建你的专属规则集
要使用 .cursorrules 文件,你首先需要在项目根目录下创建一个名为 .cursorrules 的文件。这样,Cursor 就会自动识别并应用这些规则。
{
"rules": {
"typescript": {
"completion": {
"trigger": "type",
"prefix": "type",
"suffix": " = "
}
}
}
}
这个简单的配置文件定义了 TypeScript 类型补全的规则:当输入 type 时,Cursor 将自动补全类型定义,并在其后插入 =,使你更快速地定义变量类型。
优化补全策略
Cursor 的补全策略可以高度定制化。你可以通过设置不同的触发词、触发条件和补全内容,来优化开发体验。例如,如果你经常使用某个特定的库或框架,可以为其定义专属的补全规则。
{
"rules": {
"react": {
"completion": {
"trigger": "react",
"prefix": "import React from 'react';\nimport { useState } from 'react';\n",
"suffix": ""
}
}
}
}
这个规则会在你输入 react 时自动插入 React 的基础导入语句,减少重复的代码输入,提升开发效率。
高级功能:自定义代码片段
除了基本的补全规则,.cursorrules 文件还支持自定义代码片段。你可以为常见的函数调用、类定义、组件结构等创建模板,使代码生成更加智能化。
{
"rules": {
"component": {
"completion": {
"trigger": "comp",
"prefix": "function App() {\n return (\n <div>\n {/* 内容 */}\n </div>\n );\n}\n",
"suffix": ""
}
}
}
}
这个规则会在你输入 comp 时自动插入一个 React 组件的模板,帮助你快速构建组件结构,减少手动输入。
提升语法高亮与格式化能力
Cursor 的语法高亮和格式化功能也可以通过 .cursorrules 文件进行定制。你可以指定某些代码块的格式化规则,比如缩进方式、换行习惯等。
{
"rules": {
"format": {
"typescript": {
"indent": 2,
"newline": true
}
}
}
}
这个规则将 TypeScript 文件的缩进设置为 2 个空格,并启用自动换行功能,使代码结构更加清晰。
与 GitHub Copilot 的协同使用
Cursor 与 GitHub Copilot 的结合,可以进一步提升开发效率。GitHub Copilot 是一款基于 AI 的代码补全工具,它能够根据上下文生成代码片段。在使用 Cursor 的时候,你可以将 GitHub Copilot 的建议与 Cursor 的自定义规则相结合,使代码生成更加精准。
{
"rules": {
"copilot": {
"enabled": true,
"priority": 1
}
}
}
这个规则启用了 GitHub Copilot 的建议功能,并将其设为默认优先级,确保在开发过程中能够充分利用 AI 的代码建议。
配置工具与插件支持
Cursor 支持多种插件,这些插件可以与 .cursorrules 文件协同工作,提供更强大的功能。例如,你可以使用 Windsurf 插件来增强代码补全能力和语法高亮效果。
{
"rules": {
"windsurf": {
"enabled": true,
"language": "typescript"
}
}
}
这个规则启用了 Windsurf 插件,并将其设置为支持 TypeScript,从而让代码编辑体验更加流畅。
极客工具:VS Code 插件与 CLI 工具
除了 Cursor 本身,还有一些极客工具可以进一步提升开发效率。例如,VS Code 插件可以与 Cursor 协同工作,提供更丰富的功能。你可以使用如 Cursor 插件、TypeScript 插件等,来增强代码编辑体验。
{
"extensions": [
"cursor.cursor",
"ms-vscode.vscode-js-profile"
]
}
这个配置文件列出了几个推荐的 VS Code 插件,帮助你更好地利用 Cursor 的功能。
实战技巧:使用模板与快捷键
在使用 Cursor 时,你可以通过模板和快捷键来进一步提升效率。例如,你可以为常见的函数调用定义模板,以便快速生成代码。
{
"templates": {
"useState": "const [state, setState] = useState({});",
"useEffect": "useEffect(() => { }, []);"
}
}
这些模板可以在你输入 useState 或 useEffect 时自动插入,大大减少了手动输入的时间。
生产力提升:自动化与智能建议
通过 .cursorrules 文件,你可以实现自动化代码生成和智能建议。例如,你可以设置规则,让 Cursor 在特定情况下自动应用代码格式化,或者在你输入关键字时自动建议相关代码。
{
"rules": {
"auto-format": {
"enabled": true,
"trigger": "save"
},
"smart-suggestions": {
"enabled": true,
"trigger": "type"
}
}
}
这些规则将自动格式化设置为保存时触发,并启用智能建议功能,使你更专注于代码逻辑而不是格式细节。
未来展望:AI 编程的无限可能
随着 AI 技术的不断进步,像 Cursor 这样的工具正在迅速发展。未来的 AI 编程工具将更加智能化,能够理解更复杂的上下文,提供更精准的代码建议。.cursorrules 文件作为这些工具的核心配置之一,将在其中扮演越来越重要的角色。
与现代 Web 栈的深度集成
在使用 Cursor 的同时,你还可以将它与现代 Web 栈中的工具和框架进行深度集成。例如,Next.js 和 React Server Components 为开发者提供了更高效的前端开发体验,而 TypeScript 和 Tailwind CSS 则为代码质量和样式设计提供了强大的支持。
{
"rules": {
"nextjs": {
"completion": {
"trigger": "next",
"prefix": "import Next from 'next';\n",
"suffix": ""
}
},
"react-server-components": {
"completion": {
"trigger": "server",
"prefix": "import { ServerComponent } from 'react-server';\n",
"suffix": ""
}
}
}
}
这些规则将帮助你更快速地集成 Next.js 和 React Server Components,提升前端开发效率。
深度定制:个性化你的开发环境
Cursor 的 .cursorrules 文件允许你进行深度定制,使你的开发环境更符合个人需求。你可以根据自己的习惯和项目需求,定义不同的规则集。
{
"rules": {
"personal": {
"completion": {
"trigger": "my",
"prefix": "const myFunction = () => {\n // 你的代码\n};",
"suffix": ""
}
}
}
}
这个规则为你的个人开发习惯提供了定制化的支持,使你能够更高效地编写代码。
工具链:从 VS Code 到 CLI
Cursor 不仅是一个编辑器,它还提供了一整套工具链,包括 CLI 工具、VS Code 插件等。你可以使用这些工具链来进一步优化开发流程。
{
"tools": {
"cli": "cursor",
"vscode": "cursor.cursor"
}
}
这些工具链可以帮助你更好地管理项目、自动化任务和提升开发效率。
极客必备:提升 DX 的小技巧
作为一个极客,你总是追求更好的开发体验(DX)。以下是一些提升 DX 的小技巧:
- 使用 .cursorrules 文件自定义代码补全规则。
- 结合 GitHub Copilot 和 Windsurf 插件,实现更智能的代码生成。
- 利用 VS Code 插件,增强编辑器功能。
- 设置自动格式化规则,确保代码风格一致。
- 定义个人模板,减少重复输入。
结语:AI 编程的未来
Cursor 的 .cursorrules 文件为 AI 编程带来了全新的可能性。通过这些规则,你可以实现个性化的开发体验,提升10 倍的开发效率。随着 AI 技术的不断发展,这些工具和配置将进一步优化,为开发者带来更强大的支持。
AI 辅助编程, Cursor, GitHub Copilot, Windsurf, VS Code 插件, .cursorrules, React Server Components, Next.js, TypeScript, Tailwind CSS