Que fait Code Style Enforcer ?
Cette compétence garantit que le code respecte les conventions stylistiques et les motifs spécifiques au projet que les linters automatisés peuvent négliger.
Quand Utiliser Cette Compétence
- L'utilisateur demande une revue ou des améliorations de style
- Assurer la cohérence dans toute la base de code
- Intégration de nouveau code ou de nouveaux contributeurs
- Revue de code avant validation
- L'utilisateur mentionne "style", "cohérence", "formatage" ou "conventions"
Instructions
1. Détecter les Guides de Style du Projet
Recherchez les fichiers de configuration de style :
JavaScript/TypeScript :
.eslintrc.*- Configuration ESLint.prettierrc.*- Configuration Prettiertsconfig.json- Options du compilateur TypeScript.editorconfig- Configuration de l'éditeur
Python :
.pylintrc,pylint.cfg- Pylintpyproject.toml- Configuration Black, isort.flake8- Configuration Flake8setup.cfg- Configurations de divers outils
Ruby :
.rubocop.yml- Configuration RuboCop
Go :
go.fmtappliqué (standard).golangci.yml- GolangCI-Lint
Java :
checkstyle.xml- Checkstyle.editorconfig
Général :
CONTRIBUTING.md- Directives de contributionSTYLE_GUIDE.md- Guide de style du projet.editorconfig- Paramètres multi-éditeurs
Utilisez Glob pour trouver ces fichiers et Read pour comprendre les préférences de style du projet.
2. Analyser les Motifs de Code Existants
Échantillonnez le code existant pour comprendre les conventions implicites :
Organisation des fichiers :
- Motifs de structure de répertoires
- Conventions de nommage des fichiers (camelCase, kebab-case, snake_case)
- Organisation des imports/exports
Structure du code :
- Ordre des classes/fonctions
- Placement des méthodes publiques vs privées
- Emplacement des déclarations de constantes/variables
Formatage :
- Indentation (espaces vs tabulations, taille)
- Limites de longueur de ligne
- Utilisation des lignes vides
- Styles de commentaires
Nommage :
- Nommage des variables (camelCase, snake_case)
- Nommage des classes (PascalCase, capitalisation)
- Nommage des constantes (UPPER_CASE, etc.)
- Motifs de nommage des fichiers
Utilisez Grep pour trouver des motifs communs dans des fichiers similaires.
3. Au-Delà des Linters : Vérifier les Motifs
Concentrez-vous sur les problèmes de style que les outils automatisés négligent souvent :
Cohérence du Nommage :
- Variables booléennes : préfixes
is,has,should - Gestionnaires d'événements : motifs
handle*,on* - Accesseurs/mutateurs : cohérence
get*,set* - Nommage des collections : pluriel vs singulier
- Acronymes : capitalisation cohérente
Organisation du Code :
- Fonctions connexes regroupées
- Structure de fichier cohérente entre les modules
- Ordre logique (public avant privé, etc.)
- Séparation des préoccupations
Commentaires et Documentation :
- Complétude des JSDoc/docstrings
- Cohérence du style de commentaire
- Format TODO/FIXME
- Commentaires en ligne vs blocs
Motifs d'Import/Export :
- Ordre des imports (externes, internes, relatifs)
- Exports nommés vs par défaut
- Cohérence de la déstructuration
- Motifs d'alias
Gestion des Erreurs :
- Format cohérent des messages d'erreur
- Utilisation des classes d'erreur
- Motifs Try/catch
- Format de journalisation
Utilisation des Types (TypeScript/langages typés) :
- Types explicites vs inférés
- Préférence
interfacevstype - Nommage générique (T, K, V vs descriptif)
- Gestion de null/undefined
4. Identifier les Anti-Patterns Courants
Signalez les odeurs de code et les anti-patterns :
Nombres Magiques :
// Mauvais
if (status === 200) { }
// Bon
const HTTP_OK = 200;
if (status === HTTP_OK) { }
Vérifications Null Incohérentes :
// Incohérent
if (user === null) { }
if (!data) { }
if (typeof result === 'undefined') { }
// Cohérent
if (user === null) { }
if (data === null) { }
if (result === undefined) { }
Ternaires Imbriqués :
// Difficile à lire
const value = a ? b ? c : d : e;
// Mieux
let value;
if (a) {
value = b ? c : d;
} else {
value = e;
}
Listes de Paramètres Longues :
# Difficile à maintenir
def create_user(name, email, age, address, phone, ...):
# Mieux
def create_user(user_data: UserData):
5. Vérifier les Conventions Spécifiques au Projet
Recherchez les motifs uniques à ce projet :
- Nommage personnalisé pour des domaines spécifiques (ex. "repo" vs "repository")
- Bibliothèques préférées pour les tâches courantes
- Motifs architecturaux (MVC, couche service, etc.)
- Nommage et structure des fichiers de test
- Motifs de configuration
Lisez CONTRIBUTING.md, README.md ou des documents similaires pour des directives explicites.
6. Générer des Recommandations de Style
Pour chaque problème, fournissez :
Code actuel :
function getData(id) {
const d = fetch('/api/users/' + id);
return d;
}
Problème :
- Nommage incohérent (
getDatavs d'autres fonctions utilisantfetch*) - Nom de variable à une seule lettre (
d) - Concaténation de chaînes au lieu de littéraux de gabarit
Recommandé :
function fetchUser(id) {
const userData = fetch(`/api/users/${id}`);
return userData;
}
7. Prioriser les Problèmes
Classez par impact :
Haute Priorité (Cohérence) :
- Incohérences de nommage entre fonctions similaires
- Indentation ou formatage mixte
- Gestion des erreurs incohérente
Priorité Moyenne (Lisibilité) :
- Nombres/chaînes magiques
- Noms de variables peu clairs
- Documentation manquante
Faible Priorité (Agréable à avoir) :
- Formatage des commentaires
- Ordre des imports
- Lignes vides supplémentaires
8. Suggérer des Outils Automatisés
Recommandez des outils pour appliquer les styles :
JavaScript/TypeScript :
npm install --save-dev prettier eslint
npx prettier --write .
npx eslint --fix .
Python :
pip install black isort flake8
black .
isort .
Go :
go fmt ./...
golangci-lint run
Ruby :
gem install rubocop
rubocop -a
9. Créer ou Mettre à Jour EditorConfig
Suggérez .editorconfig s'il est manquant :
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.{js,ts,jsx,tsx}]
indent_style = space
indent_size = 2
[*.py]
indent_style = space
indent_size = 4
[*.go]
indent_style = tab
10. Liste de Vérification pour la Revue de Style
Lors de la revue de code pour le style :
- Le nommage suit les conventions du projet
- L'indentation et le formatage sont cohérents
- Les imports sont organisés correctement
- Commentaires là où nécessaire, pas excessifs
- Pas de nombres ou chaînes magiques
- La gestion des erreurs est cohérente
- L'organisation des fichiers correspond à la structure du projet
- Pas d'odeurs de code évidentes
- Les annotations de type sont cohérentes (si applicable)
- Les tests suivent les conventions de test
Meilleures Pratiques
- Cohérence avant la perfection : Suivez les motifs existants même s'ils ne sont pas idéaux
- Documenter les décisions : Ajoutez des guides de style pour les cas ambigus
- Automatiser quand c'est possible : Utilisez Prettier, Black, gofmt, etc.
- Soyez pragmatique : Ne refactorisez pas du code fonctionnel juste pour le style
- Accord d'équipe : Alignez-vous sur les styles qui comptent
- Amélioration incrémentale : Corrigez les styles dans les fichiers touchés, pas tous à la fois
- Lisibilité d'abord : Le style est au service de la lisibilité, pas l'inverse
Conflits de Style Courants
Tabulations vs Espaces
- Vérifiez
.editorconfigou les fichiers existants - En cas de doute, utilisez la majorité du projet
Style de Guillemets (Simples vs Doubles)
- JavaScript : Simples (
') courantes - Python : Les deux, soyez cohérent
- Go : Toujours doubles (
") - Suivez la config du linter si présente
Points-Virgules (JavaScript)
- Vérifiez la majorité du code existant
- Si mélangés, suggérez Prettier pour appliquer
Longueur de Ligne
- Limites courantes : 80, 100, 120 caractères
- Vérifiez la config du linter ou
.editorconfig
Ordre des Imports
- Généralement : bibliothèque standard, externe, interne, relatif
- Utilisez des outils automatisés (isort, organize imports)
Fichiers d'Appui
reference/style-guides.md: Liens vers les guides de style populairesexamples/before-after.md: Exemples de code montrant les améliorations