Comprendere i risultati strutturati

AI Diff Review fornisce risultati strutturati e organizzati che facilitano la comprensione di quali problemi sono stati trovati e come affrontarli. A differenza dei commenti generici di revisione del codice, questi risultati sono categorizzati e prioritizzati, aiutandoti a concentrarti su ciò che conta di più.

Categorie di risultati

I risultati sono organizzati in sei categorie principali, ognuna con uno scopo specifico:

Problemi critici

Questi sono problemi gravi che potrebbero rompere la funzionalità o causare problemi significativi in produzione. Esempi includono:

  • Eccezioni di puntatore nullo in attesa di verificarsi
  • Errori di logica che potrebbero causare comportamento errato
  • Gestione degli errori mancante che potrebbe far crashare l'applicazione
  • Modifiche che rompono API o interfacce

Livelli di severità: CRITICO, AVVERTENZA, INFO

Preoccupazioni di sicurezza

Vulnerabilità e rischi di sicurezza potenziali che potrebbero essere sfruttati. Questa è una delle categorie più importanti, poiché i problemi di sicurezza possono avere conseguenze gravi. Esempi includono:

  • Vulnerabilità di iniezione SQL
  • Rischi di cross-site scripting (XSS)
  • Segreti o credenziali esposti
  • Autenticazione o autorizzazione non sicura
  • Archiviazione o trasmissione di dati non sicura

Livelli di severità: CRITICO, AVVERTENZA, INFO

I problemi di sicurezza CRITICI attivano sempre il blocco del gate di commit quando il gate è abilitato.

Qualità del codice

Problemi relativi a manutenibilità, leggibilità e aderenza alle best practice. Sebbene questi potrebbero non causare problemi immediati, possono rendere il codice più difficile da mantenere nel tempo. Esempi includono:

  • Duplicazione del codice
  • Funzioni complesse che dovrebbero essere refactorizzate
  • Convenzioni di denominazione inconsistenti
  • Documentazione mancante
  • Messaggi di errore scadenti

Livelli di severità: AVVERTENZA, INFO

Note sulle prestazioni

Opportunità per migliorare l'efficienza e l'ottimizzazione. Questi risultati ti aiutano a scrivere codice più veloce ed efficiente in termini di risorse. Esempi includono:

  • Algoritmi o strutture di dati inefficienti
  • Query di database non necessarie
  • Perdite di memoria o risorse
  • Concatenazione di stringhe inefficiente
  • Opportunità di caching mancanti

Livelli di severità: AVVERTENZA, INFO

Raccomandazioni sui test

Suggerimenti per migliorare la copertura e la qualità dei test. Questi aiutano a garantire che il tuo codice sia ben testato e affidabile. Esempi includono:

  • Casi di test mancanti per nuova funzionalità
  • Casi limite che dovrebbero essere testati
  • Miglioramenti della qualità dei test
  • Raccomandazioni per test di integrazione

Livelli di severità: AVVERTENZA, INFO

Suggerimenti

Miglioramenti e potenziamenti generali che potrebbero rendere il tuo codice migliore. Questi sono spesso opzionali ma possono migliorare la qualità del codice. Esempi includono:

  • Utilizzo di funzionalità di linguaggio più moderne
  • Semplificazione di espressioni complesse
  • Denominazione delle variabili migliore
  • Miglioramenti nell'organizzazione del codice

Livelli di severità: AVVERTENZA, INFO

Livelli di severità

Ogni risultato ha un livello di severità che indica la sua importanza:

CRITICO

Questi sono problemi gravi che dovrebbero essere affrontati immediatamente. Rappresentano rischi reali per funzionalità, sicurezza o integrità dei dati. I risultati CRITICI in Preoccupazioni di sicurezza o Problemi critici possono bloccare i commit quando il gate è abilitato.

AVVERTENZA

Questi sono problemi importanti che dovrebbero essere affrontati presto. Sebbene non siano immediatamente critici, rappresentano problemi che potrebbero causare problemi in futuro o indicare aree che necessitano attenzione.

INFO

Questi sono suggerimenti e problemi minori. Vale la pena considerarli ma non sono urgenti. I risultati INFO contribuiscono meno al punteggio del gate di commit e sono spesso miglioramenti opzionali.

Comprendere i dettagli dei risultati

Ogni risultato include:

  • File: Il file dove è stato trovato il problema
  • Riga: Il numero di riga specifico (se applicabile)
  • Descrizione: Spiegazione dettagliata del problema e perché è importante
  • Tipo: A quale categoria appartiene il risultato
  • Severità: Quanto è grave il problema

Usare i risultati efficacemente

Prioritizzare per severità

Inizia affrontando i risultati CRITICI, poi AVVERTENZA, poi INFO. Questo assicura che tu corregga prima i problemi più importanti.

Concentrarsi sulla sicurezza

Le Preoccupazioni di sicurezza dovrebbero sempre essere prese sul serio, anche se sono contrassegnate come AVVERTENZA o INFO. I problemi di sicurezza possono avere conseguenze gravi e dovrebbero essere affrontati prontamente.

Usare il contesto

Clicca sui risultati per navigare al codice specifico. Comprendere il contesto ti aiuta a prendere decisioni informate su se e come affrontare ogni problema.

Filtrare e cercare

Usa le capacità di filtraggio e ricerca per concentrarti su tipi specifici di problemi. Ad esempio, filtra solo Preoccupazioni di sicurezza quando fai una revisione focalizzata sulla sicurezza.

Imparare dai pattern

Se vedi lo stesso tipo di risultato ripetutamente, potrebbe indicare un pattern nella tua codebase che necessita di essere affrontato. Usa questa intuizione per migliorare le tue pratiche di codifica.

Falsi positivi

Come qualsiasi strumento automatizzato, AI Diff Review può occasionalmente segnalare cose che in realtà non sono problemi. Quando incontri un falso positivo:

  • Considera se il risultato ha merito anche se non è critico
  • Usa il tuo giudizio—conosci meglio la tua codebase
  • Se è un pattern, considera se il tuo codice potrebbe essere più chiaro
  • Ricorda che l'IA sta cercando di aiutare, anche se non ha sempre ragione

Conclusione

I risultati strutturati facilitano la comprensione e l'azione sull'analisi di AI Diff Review. Comprendendo le categorie e i livelli di severità, puoi prioritizzare i tuoi sforzi e concentrarti su ciò che conta di più.

Ricorda che i risultati sono suggerimenti basati su best practice e pattern comuni. Usali come guida, ma applica sempre il tuo giudizio basato sul tuo contesto e requisiti specifici.

L'obiettivo è migliorare la qualità del codice nel tempo, non raggiungere la perfezione immediatamente. Affronta prima i problemi critici, poi lavora su avvertimenti e suggerimenti man mano che il tempo lo consente.

Pronto a iniziare a migliorare la qualità del tuo codice? Installa AI Diff Review e vedi quali intuizioni può fornire per la tua codebase.