配置
自訂規則
自訂規則影響 Bob 如何回應您的請求,使輸出與您的特定偏好和專案需求保持一致。配置自訂規則以控制 Bob 的編碼風格、文件方法和決策流程。
什麼是自訂規則?
自訂規則透過定義偏好、約束和指南來擴展 Bob 的預設行為,這些指南指導 Bob 如何處理任務以符合您的需求。
常見用途包括:
- 編碼風格偏好(縮排、命名慣例)
- 文件格式和標準
- 測試方法和需求
- 專案工作流程和流程
- 團隊特定慣例
為模式添加自訂規則
您可以透過兩種方式為模式添加自訂規則:
透過使用者介面
配置適用於所有專案的規則:
- 點擊 Bob 側邊欄右上角的三個點。
- 點擊模式。
- 選擇您想要編輯規則的模式。
- 點擊編輯。
- 捲動到特定於模式的自訂指示(可選)。
- 輸入您的規則。
- 點擊儲存。
透過特定於模式的規則檔案
模式也可以有儲存在 .bob/rules-{mode-slug}/ 目錄中的其他規則檔案:
01-style-guide.md
02-formatting.txt
目錄中的檔案按字母順序載入,並與模式配置中的 customInstructions 屬性組合。有關更多詳細資訊,請參閱自訂模式。
深入了解使用專案層級規則標準化 Bob 的行為。
規則範圍
Bob 支援兩種規則範圍,決定您的規則適用於何處:
- 全域規則:自動適用於所有專案
- 工作區規則:僅適用於目前專案
使用全域規則用於個人或組織範圍的標準。使用工作區規則用於專案特定需求。
配置方法
基於目錄的配置
在工作區根目錄的 .bob/ 下使用目錄:
工作區結構:
coding-style.md
typescript.md
rules/- 所有模式的一般規則rules-agent/- Agent 模式特定規則
全域結構:
Linux/macOS:~/.bob/rules/
Windows:%USERPROFILE%\.bob\rules\
建立工作區規則:
mkdir -p .bob/rules
echo "# 專案標準" > .bob/rules/coding-style.md建立全域規則:
# Linux/macOS
mkdir -p ~/.bob/rules
echo "# 全域標準" > ~/.bob/rules/coding-standards.md
# Windows
mkdir %USERPROFILE%\.bob\rules
echo # 全域標準 > %USERPROFILE%\.bob\rules\coding-standards.md規則優先順序
Bob 按以下順序組合來自多個來源的規則:
- 全域規則(
~/.bob/rules/) - 工作區規則(
.bob/rules/)
在每個層級內,特定於模式的規則在一般規則之前載入。工作區規則可以覆寫全域規則。
撰寫有效的規則
具體且可操作
好的:「在 JavaScript 檔案中使用 4 個空格進行縮排」
避免:「很好地格式化程式碼」
使用清晰的結構
按主題組織規則:
# 程式碼風格
- 對變數使用 camelCase
- 對類別使用 PascalCase
# 測試
- 為所有公開函式撰寫單元測試
- 使用 Jest 作為測試框架
# 文件
- 為公開 API 添加 JSDoc 註解有效規則的範例
- 「始終使用空格進行縮排,寬度為 4 個空格」
- 「對變數名稱使用 camelCase」
- 「為所有新函式撰寫單元測試」
- 「在提供程式碼之前解釋您的推理」
- 「在向網站添加功能時,確保它們具有回應性和無障礙性」
進階配置
特定於模式的規則
使用專用目錄定位特定模式:
| 目錄 | 用途 |
|---|---|
rules/ | 所有模式的一般規則 |
rules-agent/ | 僅 Agent 模式 |
rules-plan/ | 僅 Plan 模式 |
rules-ask/ | 僅 Ask 模式 |
rules-{mode}/ | 任何自訂模式 |
使用 AGENTS.md 檔案
為了團隊標準化,您可以在工作區根目錄中使用 AGENTS.md 檔案:
# 團隊標準
- 遵循公司編碼指南
- 僅使用已核准的程式庫
- 記錄所有 API 變更關鍵細節:
- 預設自動載入
- 與專案一起進行版本控制
- 使用設定中的
"bob-code.useAgentRules": false停用 - 在特定於模式的規則之後但在一般工作區規則之前載入
檔案行為
- 遞迴讀取:Bob 讀取規則目錄中的所有檔案,包括子目錄
- 字母順序:檔案按檔案名稱的字母順序處理
- 自動過濾:排除快取檔案(
.DS_Store、*.bak、*.cache、*.log、*.tmp、Thumbs.db) - 符號連結:支援最大深度為 5
- 空檔案:靜默跳過
團隊標準化
專案層級標準
在版本控制下使用工作區 .bob/rules/ 目錄:
# 添加到版本控制
git add .bob/rules/
git commit -m "添加 Bob 自訂規則"這確保了特定專案的團隊成員之間的一致行為。
組織範圍標準
向團隊成員分發全域規則:
- 建立共享規則儲存庫
- 團隊成員複製到
~/.bob/rules/ - 定期更新以保持一致性
混合方法
您可以結合兩種方法:
- 組織標準的全域規則
- 專案特定需求的工作區規則
- 需要時工作區規則覆寫全域規則
這個主題如何?