文章目錄
- 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 格式化字符串"
6. 注意事項
- 文件編碼：確保使用 UTF-8 編碼。
- 緩存問題：修改
.cursorrules后，可能需要重啟 Cursor 或清除緩存。 - 版本兼容性：不同版本的 Cursor 可能支持不同的規則，建議查看官方文檔。
如果需要更具體的規則或驗證當前版本的語法，建議參考 Cursor 的官方文檔：Cursor Documentation。
結束語
Flutter是一個由Google開發的開源UI工具包，它可以讓您在不同平臺上創建高質量、美觀的應用程序，而無需編寫大量平臺特定的代碼。我將學習和深入研究Flutter的方方面面。從基礎知識到高級技巧，從UI設計到性能優化，歡飲關注一起討論學習，共同進入Flutter的精彩世界！
