Comprendre les résultats structurés

AI Diff Review fournit des résultats structurés et organisés qui facilitent la compréhension des problèmes trouvés et la façon de les résoudre. Contrairement aux commentaires génériques de révision de code, ces résultats sont catégorisés et priorisés, vous aidant à vous concentrer sur ce qui compte le plus.

Catégories de résultats

Les résultats sont organisés en six catégories principales, chacune servant un objectif spécifique :

Problèmes critiques

Ce sont des problèmes graves qui pourraient casser la fonctionnalité ou causer des problèmes significatifs en production. Exemples :

  • Exceptions de pointeur null en attente
  • Erreurs de logique qui pourraient causer un comportement incorrect
  • Gestion d'erreur manquante qui pourrait faire planter l'application
  • Changements cassants aux APIs ou interfaces

Niveaux de sévérité : CRITIQUE, AVERTISSEMENT, INFO

Préoccupations de sécurité

Vulnérabilités et risques de sécurité potentiels qui pourraient être exploités. C'est l'une des catégories les plus importantes, car les problèmes de sécurité peuvent avoir des conséquences graves. Exemples :

  • Vulnérabilités d'injection SQL
  • Risques de cross-site scripting (XSS)
  • Secrets ou identifiants exposés
  • Authentification ou autorisation non sécurisée
  • Stockage ou transmission de données non sécurisé

Niveaux de sévérité : CRITIQUE, AVERTISSEMENT, INFO

Les problèmes de sécurité CRITIQUES déclenchent toujours le blocage de la porte de commit lorsque la porte est activée.

Qualité du code

Problèmes liés à la maintenabilité, la lisibilité et l'adhésion aux meilleures pratiques. Bien qu'ils ne causent pas de problèmes immédiats, ils peuvent rendre le code plus difficile à maintenir au fil du temps. Exemples :

  • Duplication de code
  • Fonctions complexes qui devraient être refactorisées
  • Conventions de nommage inconsistantes
  • Documentation manquante
  • Messages d'erreur médiocres

Niveaux de sévérité : AVERTISSEMENT, INFO

Notes de performance

Opportunités d'améliorer l'efficacité et l'optimisation. Ces résultats vous aident à écrire du code plus rapide et plus efficace en ressources. Exemples :

  • Algorithmes ou structures de données inefficaces
  • Requêtes de base de données inutiles
  • Fuites de mémoire ou de ressources
  • Concaténation de chaînes inefficace
  • Opportunités de mise en cache manquantes

Niveaux de sévérité : AVERTISSEMENT, INFO

Recommandations de test

Suggestions pour améliorer la couverture et la qualité des tests. Celles-ci aident à garantir que votre code est bien testé et fiable. Exemples :

  • Cas de test manquants pour la nouvelle fonctionnalité
  • Cas limites qui devraient être testés
  • Améliorations de la qualité des tests
  • Recommandations de tests d'intégration

Niveaux de sévérité : AVERTISSEMENT, INFO

Suggestions

Améliorations et améliorations générales qui pourraient rendre votre code meilleur. Celles-ci sont souvent optionnelles mais peuvent améliorer la qualité du code. Exemples :

  • Utilisation de fonctionnalités de langage plus modernes
  • Simplification d'expressions complexes
  • Meilleur nommage de variables
  • Améliorations de l'organisation du code

Niveaux de sévérité : AVERTISSEMENT, INFO

Niveaux de sévérité

Chaque résultat a un niveau de sévérité qui indique son importance :

CRITIQUE

Ce sont des problèmes graves qui devraient être résolus immédiatement. Ils représentent de vrais risques pour la fonctionnalité, la sécurité ou l'intégrité des données. Les résultats CRITIQUES dans Préoccupations de sécurité ou Problèmes critiques peuvent bloquer les commits lorsque la porte est activée.

AVERTISSEMENT

Ce sont des problèmes importants qui devraient être résolus bientôt. Bien qu'ils ne soient pas immédiatement critiques, ils représentent des problèmes qui pourraient causer des problèmes à l'avenir ou indiquer des domaines qui nécessitent une attention.

INFO

Ce sont des suggestions et des problèmes mineurs. Ils valent la peine d'être considérés mais ne sont pas urgents. Les résultats INFO contribuent moins à la notation de la porte de commit et sont souvent des améliorations optionnelles.

Comprendre les détails des résultats

Chaque résultat inclut :

  • Fichier : Le fichier où le problème a été trouvé
  • Ligne : Le numéro de ligne spécifique (si applicable)
  • Description : Explication détaillée du problème et pourquoi il est important
  • Type : À quelle catégorie appartient le résultat
  • Sévérité : À quel point le problème est grave

Utiliser les résultats efficacement

Prioriser par sévérité

Commencez par résoudre les résultats CRITIQUES, puis AVERTISSEMENT, puis INFO. Cela garantit que vous corrigez d'abord les problèmes les plus importants.

Se concentrer sur la sécurité

Les Préoccupations de sécurité devraient toujours être prises au sérieux, même si elles sont marquées comme AVERTISSEMENT ou INFO. Les problèmes de sécurité peuvent avoir des conséquences graves et devraient être résolus rapidement.

Utiliser le contexte

Cliquez sur les résultats pour naviguer vers le code spécifique. Comprendre le contexte vous aide à prendre des décisions éclairées sur si et comment résoudre chaque problème.

Filtrer et rechercher

Utilisez les capacités de filtrage et de recherche pour vous concentrer sur des types spécifiques de problèmes. Par exemple, filtrez uniquement les Préoccupations de sécurité lors d'une révision axée sur la sécurité.

Apprendre des modèles

Si vous voyez le même type de résultat répétitivement, cela pourrait indiquer un modèle dans votre codebase qui nécessite une attention. Utilisez cette insight pour améliorer vos pratiques de codage.

Faux positifs

Comme tout outil automatisé, AI Diff Review peut occasionnellement signaler des choses qui ne sont pas réellement des problèmes. Lorsque vous rencontrez un faux positif :

  • Considérez si le résultat a du mérite même s'il n'est pas critique
  • Utilisez votre jugement—vous connaissez le mieux votre codebase
  • Si c'est un modèle, considérez si votre code pourrait être plus clair
  • Rappelez-vous que l'IA essaie d'aider, même si elle n'a pas toujours raison

Conclusion

Les résultats structurés facilitent la compréhension et l'action sur l'analyse d'AI Diff Review. En comprenant les catégories et les niveaux de sévérité, vous pouvez prioriser vos efforts et vous concentrer sur ce qui compte le plus.

Rappelez-vous que les résultats sont des suggestions basées sur les meilleures pratiques et les modèles courants. Utilisez-les comme guide, mais appliquez toujours votre propre jugement basé sur votre contexte et vos exigences spécifiques.

L'objectif est d'améliorer la qualité du code au fil du temps, pas d'atteindre la perfection immédiatement. Résolvez d'abord les problèmes critiques, puis travaillez sur les avertissements et suggestions selon le temps disponible.

Prêt à commencer à améliorer la qualité de votre code ? Installez AI Diff Review et voyez quels insights il peut fournir pour votre codebase.