Konfigurasi

Aturan khusus

Aturan khusus mempengaruhi cara Bob merespons permintaanmu, menyelaraskan output dengan preferensi spesifik dan persyaratan proyekmu. Konfigurasi aturan khusus untuk mengontrol gaya coding Bob, pendekatan dokumentasi, dan proses pengambilan keputusan.

Apa itu aturan khusus?

Aturan khusus memperluas perilaku default Bob dengan mendefinisikan preferensi, batasan, dan panduan yang mengarahkan cara Bob mendekati tugas sesuai kebutuhanmu.

Penggunaan umum meliputi:

  • Preferensi gaya coding (indentasi, konvensi penamaan)
  • Format dan standar dokumentasi
  • Metodologi dan persyaratan pengujian
  • Alur kerja dan proses proyek
  • Konvensi khusus tim

Menambahkan aturan khusus untuk mode

Kamu bisa menambahkan aturan khusus ke mode dengan dua cara:

Melalui UI

Konfigurasi aturan yang berlaku di semua proyekmu:

  1. Klik tiga titik di pojok kanan atas sidebar Bob.
  2. Klik Modes.
  3. Pilih mode yang ingin kamu edit aturannya.
  4. Klik Edit.
  5. Gulir ke Mode-specific custom instructions (opsional).
  6. Ketik aturanmu.
  7. Klik Save.

Melalui file aturan khusus mode

Mode juga bisa memiliki file aturan tambahan yang disimpan di direktori:

  • Metode yang direkomendasikan (struktur direktori):
    01-style-guide.md
    02-formatting.txt
  • Metode alternatif (file tunggal):
    .bobrules-{mode-slug}

Metode direktori lebih diprioritaskan jika keduanya ada. File dalam direktori dimuat secara alfabetis dan digabungkan dengan properti customInstructions dari konfigurasi mode-mu. Untuk detail lebih lanjut, lihat Mode khusus.

Pelajari lebih lanjut tentang menstandarisasi perilaku Bob menggunakan aturan tingkat proyek.

Cakupan aturan

Bob mendukung dua cakupan aturan yang menentukan di mana aturanmu berlaku:

  • Aturan global: Berlaku secara otomatis di semua proyekmu
  • Aturan workspace: Berlaku hanya dalam proyekmu saat ini

Gunakan aturan global untuk standar pribadi atau organisasi-lebar. Gunakan aturan workspace untuk persyaratan khusus proyek.

Metode konfigurasi

Konfigurasi berbasis file

Pendekatan paling sederhana menggunakan file tunggal di root workspace-mu:

  • .bobrules - Aturan workspace umum
  • .bobrules-agent - Aturan untuk mode Agent
  • .bobrules-{modeSlug} - Aturan untuk mode apa pun

Buat file .bobrules:

# Di root proyekmu
echo "Gunakan 4 spasi untuk indentasi" > .bobrules

Konfigurasi berbasis direktori

Untuk organisasi yang lebih baik, gunakan direktori:

Struktur workspace:

coding-style.md
typescript.md
  • rules/ - Aturan umum untuk semua mode
  • rules-agent/ - Aturan khusus mode Agent

Struktur global:

Linux/macOS: ~/.bob/rules/ Windows: %USERPROFILE%\.bob\rules\

Buat aturan workspace:

mkdir -p .bob/rules
echo "# Standar proyek" > .bob/rules/coding-style.md

Buat aturan global:

# Linux/macOS
mkdir -p ~/.bob/rules
echo "# Standar global" > ~/.bob/rules/coding-standards.md

# Windows
mkdir %USERPROFILE%\.bob\rules
echo # Standar global > %USERPROFILE%\.bob\rules\coding-standards.md

Prioritas aturan

Bob menggabungkan aturan dari beberapa sumber dalam urutan ini:

  1. Aturan global (~/.bob/rules/)
  2. Aturan workspace (.bob/rules/)

Di dalam setiap level, aturan khusus mode dimuat sebelum aturan umum. Aturan workspace dapat mengganti aturan global.

Spesifik dan dapat ditindaklanjuti

Baik: "Gunakan 4 spasi untuk indentasi di file JavaScript"

Hindari: "Format kode dengan baik"

Gunakan struktur yang jelas

Organisasikan aturan berdasarkan topik:

# Gaya Kode
- Gunakan camelCase untuk variabel
- Gunakan PascalCase untuk kelas

# Pengujian
- Tulis unit test untuk semua fungsi publik
- Gunakan Jest sebagai framework pengujian

# Dokumentasi
- Tambahkan komentar JSDoc untuk API publik

Contoh aturan yang efektif

  • "Selalu gunakan spasi untuk indentasi, dengan lebar 4 spasi"
  • "Gunakan camelCase untuk nama variabel"
  • "Tulis unit test untuk semua fungsi baru"
  • "Jelaskan alasanmu sebelum memberikan kode"
  • "Saat menambahkan fitur ke website, pastikan responsif dan aksesibel"

Konfigurasi lanjutan

Aturan khusus mode

Target mode tertentu dengan direktori yang didedikasikan:

DirektoriTujuan
rules/Aturan umum untuk semua mode
rules-agent/Hanya mode Agent
rules-plan/Hanya mode Plan
rules-ask/Hanya mode Ask
rules-{mode}/Mode khusus mana pun

Menggunakan file AGENTS.md

Untuk standardisasi tim, kamu bisa menggunakan file AGENTS.md di root workspace-mu:

# Standar Tim
- Ikuti panduan coding perusahaan
- Gunakan hanya library yang disetujui
- Dokumentasikan semua perubahan API

Detail utama:

  • Dimuat secara otomatis secara default
  • Kontrol versi dengan proyekmu
  • Nonaktifkan dengan "bob-code.useAgentRules": false di pengaturan
  • Dimuat setelah aturan khusus mode tetapi sebelum aturan workspace umum

Perilaku file

  • Pembacaan rekursif: Bob membaca semua file di direktori aturan, termasuk subdirektori
  • Urutan alfabetis: File diproses dalam urutan alfabetis berdasarkan nama file
  • Penyaringan otomatis: Mengecualikan file cache (.DS_Store, *.bak, *.cache, *.log, *.tmp, Thumbs.db)
  • Symbolic link: Didukung dengan kedalaman maksimum 5
  • File kosong: Dilewati secara diam-diam

Standardisasi tim

Standar tingkat proyek

Gunakan direktori .bob/rules/ workspace di bawah kontrol versi:

# Tambahkan ke kontrol versi
git add .bob/rules/
git commit -m "Tambahkan aturan khusus Bob"

Ini memastikan perilaku yang konsisten di seluruh anggota tim untuk proyek tertentu.

Standar seluruh organisasi

Distribusikan aturan global ke anggota tim:

  1. Buat repositori aturan bersama
  2. Anggota tim mengklon ke ~/.bob/rules/
  3. Perbarui secara berkala untuk konsistensi

Pendekatan hybrid

Kamu bisa menggabungkan kedua pendekatan:

  • Aturan global untuk standar organisasi
  • Aturan workspace untuk persyaratan khusus proyek
  • Aturan workspace mengganti aturan global saat diperlukan
Bagaimana topik ini?