Configuration

Règles personnalisées

Les règles personnalisées influencent la façon dont Bob répond à tes demandes, en alignant les réponses sur tes préférences spécifiques et les exigences du projet. Configure des règles personnalisées pour contrôler le style de code, l'approche de documentation et les processus de décision de Bob.

Que sont les règles personnalisées ?

Les règles personnalisées étendent le comportement par défaut de Bob en définissant des préférences, des contraintes et des directives qui déterminent comment Bob aborde les tâches pour répondre à vos besoins.

Les utilisations courantes incluent :

  • Préférences de style de codage (indentation, conventions de nommage)
  • Formats et normes de documentation
  • Méthodologies et exigences de test
  • Flux de travail et processus de projet
  • Conventions spécifiques à l'équipe

Ajouter des règles personnalisées pour un mode

Vous pouvez ajouter des règles personnalisées aux modes de deux manières :

Via l'interface utilisateur

Configurez des règles qui s'appliquent à tous vos projets :

  1. Cliquez sur les trois points dans le coin supérieur droit de la barre latérale Bob.
  2. Cliquez sur Modes.
  3. Sélectionnez le mode pour lequel vous souhaitez éditer les règles.
  4. Cliquez sur Éditer.
  5. Faites défiler jusqu'à Instructions personnalisées spécifiques au mode (optionnel).
  6. Entrez vos règles.
  7. Cliquez sur Enregistrer.

Via des fichiers de règles spécifiques au mode

Les modes peuvent également avoir des fichiers de règles supplémentaires stockés dans des répertoires sous .bob/rules-{mode-slug}/ :

01-style-guide.md
02-formatting.txt

Les fichiers dans le répertoire sont chargés par ordre alphabétique et combinés avec la propriété customInstructions de votre configuration de mode. Pour plus de détails, voir Modes personnalisés.

En savoir plus sur la standardisation du comportement de Bob avec des règles au niveau du projet.

Portées des règles

Bob prend en charge deux portées de règles qui déterminent où vos règles s'appliquent :

  • Règles globales : S'appliquent automatiquement à tous vos projets
  • Règles d'espace de travail : S'appliquent uniquement dans votre projet actuel

Utilisez les règles globales pour les normes personnelles ou organisationnelles. Utilisez les règles d'espace de travail pour les exigences spécifiques au projet.

Méthodes de configuration

Configuration basée sur des répertoires

Utilisez des répertoires sous .bob/ à la racine de votre espace de travail :

Structure d'espace de travail :

coding-style.md
typescript.md
  • rules/ - Règles générales pour tous les modes
  • rules-agent/ - Règles spécifiques au mode Agent

Structure globale :

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

Créer des règles d'espace de travail :

mkdir -p .bob/rules
echo "# Normes du projet" > .bob/rules/coding-style.md

Créer des règles globales :

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

# Windows
mkdir %USERPROFILE%\.bob\rules
echo # Normes globales > %USERPROFILE%\.bob\rules\coding-standards.md

Priorité des règles

Bob combine les règles de plusieurs sources dans cet ordre :

  1. Règles globales (~/.bob/rules/)
  2. Règles d'espace de travail (.bob/rules/)

Dans chaque niveau, les règles spécifiques au mode sont chargées avant les règles générales. Les règles d'espace de travail peuvent remplacer les règles globales.

Rédiger des règles efficaces

Soyez spécifique et actionnable

Bon : "Utilisez 4 espaces pour l'indentation dans les fichiers JavaScript"

À éviter : "Formatez le code joliment"

Utilisez une structure claire

Organisez les règles par sujet :

# Style de code
- Utilisez camelCase pour les variables
- Utilisez PascalCase pour les classes

# Tests
- Écrivez des tests unitaires pour toutes les fonctions publiques
- Utilisez Jest comme framework de test

# Documentation
- Ajoutez des commentaires JSDoc pour les API publiques

Exemples de règles efficaces

  • "Utilisez toujours des espaces pour l'indentation avec une largeur de 4 espaces"
  • "Utilisez camelCase pour les noms de variables"
  • "Écrivez des tests unitaires pour toutes les nouvelles fonctionnalités"
  • "Expliquez votre raisonnement avant de fournir du code"
  • "Lors de l'ajout de fonctionnalités aux sites web, assurez-vous qu'elles sont responsives et accessibles"

Configuration avancée

Règles spécifiques au mode

Ciblez des modes spécifiques avec des répertoires dédiés :

RépertoireObjectif
rules/Règles générales pour tous les modes
rules-agent/Mode Agent uniquement
rules-plan/Mode Plan uniquement
rules-ask/Mode Ask uniquement
rules-{mode}/N'importe quel mode personnalisé

Utilisation des fichiers AGENTS.md

Pour la standardisation d'équipe, vous pouvez utiliser un fichier AGENTS.md à la racine de votre espace de travail :

# Normes d'équipe
- Suivez les directives de codage de l'entreprise
- Utilisez uniquement les bibliothèques approuvées
- Documentez tous les changements d'API

Détails importants :

  • Chargé automatiquement par défaut
  • Contrôle de version avec votre projet
  • Désactivez avec "bob-code.useAgentRules": false dans les paramètres
  • Chargé après les règles spécifiques au mode, mais avant les règles générales d'espace de travail

Comportement des fichiers

  • Lecture récursive : Bob lit tous les fichiers dans les répertoires de règles, y compris les sous-répertoires
  • Ordre alphabétique : Les fichiers sont traités par ordre alphabétique par nom de fichier
  • Filtrage automatique : Exclut les fichiers de cache (.DS_Store, *.bak, *.cache, *.log, *.tmp, Thumbs.db)
  • Liens symboliques : Pris en charge avec une profondeur maximale de 5
  • Fichiers vides : Ignorés silencieusement

Standardisation d'équipe

Normes au niveau du projet

Utilisez les répertoires .bob/rules/ d'espace de travail sous contrôle de version :

# Ajouter au contrôle de version
git add .bob/rules/
git commit -m "Ajouter des règles personnalisées Bob"

Cela garantit un comportement cohérent entre les membres de l'équipe pour des projets spécifiques.

Normes à l'échelle de l'organisation

Distribuez les règles globales aux membres de l'équipe :

  1. Créez un dépôt de règles partagé
  2. Les membres de l'équipe clonent dans ~/.bob/rules/
  3. Mettez à jour régulièrement pour la cohérence

Approche hybride

Vous pouvez combiner les deux approches :

  • Règles globales pour les normes organisationnelles
  • Règles d'espace de travail pour les exigences spécifiques au projet
  • Les règles d'espace de travail remplacent les règles globales si nécessaire
Comment trouvez-vous ce sujet ?