Hones-Auditer

Outil d'audit de qualité du code et des tests pour aider les collaborateurs tech à évaluer la qualité des projets.

Description

Hones-Auditer est un framework qui permet d'auditer automatiquement la qualité du code et des tests d'un projet. L'audit est réalisé par un agent IA qui analyse le projet de manière systématique et génère un rapport détaillé avec des exemples concrets extraits du code source.

Structure du projet

Hones-Auditer/
├── workspace-ia/              # Dossier contenant les projets à auditer
├── .cursor/                   # Configuration Cursor
│   ├── rules/
│   │   └── audit-rules.md     # Règles pour l'agent IA dans ce projet
│   └── commands/
│       └── audit-quality.md   # Commande Cursor pour lancer un audit (/audit-quality)
├── checklist/
│   └── code_quality.md        # Checklist structurée avec critères et guides d'évaluation
├── templates/
│   └── audit_report.md        # Template de rapport markdown
├── scripts/
│   └── audit_instructions.md  # Instructions pour l'agent IA
├── reports/                   # Rapports d'audit générés (exclus du Git)
│   └── README.md              # Documentation du dossier reports
├── .gitignore                # Fichiers exclus du versionnement
└── README.md                  # Ce fichier

Utilisation

1. Préparer le projet à auditer

Placez le projet que vous souhaitez auditer dans le dossier workspace-ia/ :

# Exemple : copier ou créer un lien symbolique vers le projet
cp -r /chemin/vers/mon-projet workspace-ia/
# ou
ln -s /chemin/vers/mon-projet workspace-ia/mon-projet

2. Demander l'audit à l'agent IA

Dans Cursor, demandez à l'agent d'effectuer l'audit :

Audite la qualité du code du projet dans workspace-ia/[nom-du-projet]

ou utilisez la commande Cursor :

/audit-quality [nom-du-projet]

L'agent suivra automatiquement :

• Les règles définies dans .cursor/rules/audit-rules.md
• Les instructions dans scripts/audit_instructions.md
• La checklist dans checklist/code_quality.md
• La commande dans .cursor/commands/audit-quality.md (si utilisée)

3. Consulter le rapport

L'agent générera un rapport markdown dans le dossier reports/ suivant le template templates/audit_report.md. Le nom du fichier suivra le format : rapport-audit-[nom-du-projet]-[date].md.

Le rapport contiendra :

• Un score sur 5 pour chaque critère de qualité
• Une analyse détaillée pour chaque critère
• Des points forts et faibles identifiés
• Des exemples concrets avec citations précises (fichier:ligne)
• Des statistiques pertinentes
• Des recommandations prioritaires

Critères d'évaluation

L'audit évalue les critères suivants :

Tests & CI/CD

• Présence de tests : Le projet contient-il des tests automatisés ?
• Tests passent sur CI : Les tests sont-ils exécutés automatiquement et passent-ils ?
• Linter en place : Un linter/formatter est-il configuré ?
• Linter exécuté automatiquement : Le linter est-il exécuté sur commit ou dans CI ?

Structure & Qualité du code

• Nombre de TODOs : Y a-t-il beaucoup de TODOs/FIXMEs dans le code ?
• Code commenté présent : Y a-t-il du code mort commenté ?
• Nombre de commentaires : Y a-t-il suffisamment de commentaires ?
• Pertinence des commentaires : Les commentaires sont-ils pertinents et utiles ?
• Nommage des fonctions : Les fonctions sont-elles bien nommées ?
• Structure/décomposition des fonctions : Les fonctions sont-elles bien structurées ?
• Typage en place : Le typage est-il utilisé dans le code ?

Chaque critère est noté sur une échelle de 1 à 5 :

• 5/5 : Excellent
• 4/5 : Très bon
• 3/5 : Acceptable
• 2/5 : Insuffisant
• 1/5 : Critique

Format du rapport

Le rapport généré suit la structure suivante :

1. Résumé exécutif : Vue d'ensemble de la qualité du code
2. Section Tests & CI/CD : Évaluation des 4 critères liés aux tests et CI/CD
3. Section Structure & Qualité du code : Évaluation des 7 critères de qualité du code
4. Recommandations prioritaires : Actions à entreprendre en priorité
5. Conclusion : Synthèse finale

Chaque critère inclut :

• Score sur 5
• Analyse détaillée
• Points forts et faibles
• Exemples concrets avec citations (fichier:ligne)
• Statistiques pertinentes

Garanties de qualité

L'agent IA suit des règles strictes pour garantir la fiabilité des audits :

• ✅ Validation systématique : Tous les fichiers cités sont vérifiés avant d'être inclus dans le rapport
• ✅ Exemples réels : Seuls des exemples extraits du code source réel sont utilisés
• ✅ Citations précises : Format fichier:ligne pour chaque exemple
• ✅ Objectivité : Scores basés sur des critères objectifs et observables
• ❌ Pas d'hallucination : Aucun fichier ou ligne de code inventé

Personnalisation

Modifier les critères

Pour ajouter ou modifier des critères d'évaluation, éditez checklist/code_quality.md.

Modifier le format du rapport

Pour changer la structure du rapport, modifiez templates/audit_report.md.

Modifier le processus d'audit

Pour ajuster le processus d'analyse, éditez scripts/audit_instructions.md.

Modifier les règles de l'agent

Pour changer le comportement de l'agent IA dans ce projet, éditez .cursor/rules/audit-rules.md.

Modifier les commandes

Pour ajuster ou créer de nouvelles commandes Cursor réutilisables, éditez ou créez des fichiers dans .cursor/commands/.

Langages supportés

L'outil est conçu pour être indépendant du langage. L'agent détecte automatiquement le langage du projet et adapte ses recherches en conséquence.

Langages couramment supportés :

• Python
• JavaScript/TypeScript
• Java
• Go
• PHP
• Ruby
• C/C++
• Et autres...

Exemple d'utilisation

# 1. Placer le projet à auditer
cp -r mon-projet workspace-ia/

# 2. Dans Cursor, demander à l'agent :
"Audite la qualité du code du projet dans workspace-ia/mon-projet"

# 3. L'agent génère un rapport détaillé avec :
#    - Scores sur 5 pour chaque critère
#    - Exemples concrets extraits du code
#    - Recommandations d'amélioration

Contribution

Pour améliorer l'outil :

1. Ajoutez de nouveaux critères dans checklist/code_quality.md
2. Améliorez les instructions dans scripts/audit_instructions.md
3. Ajustez le template de rapport dans templates/audit_report.md

Notes

• L'audit est réalisé par un agent IA, il peut nécessiter une validation humaine pour certains aspects subjectifs
• Les scores sont indicatifs et doivent être interprétés dans le contexte du projet
• L'outil se concentre sur la qualité du code et des tests, pas sur l'architecture globale ou les choix technologiques

---

Développé pour aider les équipes tech à maintenir et améliorer la qualité du code.