Qualità del codice con Laravel Pint 5 (1)

Qualità del codice con Laravel Pint

By on Wed Nov 8 in Laravel, PHP


Introduzione

Mantenere uno standard di qualità del codice in un progetto, in particolare quando si collabora con più sviluppatori, può rappresentare una sfida significativa. Ogni sviluppatore può avere il proprio stile di codifica, i propri standard e i propri livelli di competenza. Per garantire l’uniformità e l’organizzazione del codice, è fondamentale incorporare uno strumento che faccia rispettare gli standard di codifica, migliori la leggibilità del codice e risolva problemi come l’indentazione, gli spazi mancanti e le parentesi graffe mal posizionate.

In questo articolo vi presento uno strumento chiamato Laravel Pint da integrare nel nostro flusso di lavoro di sviluppo backend di Laravel per ottenere qualità e sostenibilità del codice. Questa integrazione è diventata parte del mio processo di sviluppo a causa della sua assenza in Laravel 8.x; tuttavia è stato incorporato come componente principale a partire da Laravel 9.x.

Installazione

Secondo la documentazione ufficiale di Laravel, “Pint viene installato automaticamente con tutte le nuove applicazioni Laravel, quindi si può iniziare a usarlo subito”. Tuttavia, se si utilizza una versione precedente di Laravel, è possibile installare Laravel Pint con Composer utilizzando il seguente comando:

composer require laravel/pint --dev

Per ulteriori informazioni, è possibile consultare il file README su GitHub o la documentazione ufficiale di Laravel.

Configurazione

Sebbene Pint non richieda alcuna configurazione, è possibile personalizzare il suo comportamento in base alle proprie esigenze. Per farlo, creare un file pint.json nella cartella principale del progetto. Questo file consente di personalizzare la (pre)impostazione (un insieme di regole) che Pint utilizza per risolvere i problemi di stile del codice. Per esempio:


{ "preset": "laravel" }

Un’altra preimpostazione disponibile è “psr12”.
È anche possibile attivare o disattivare regole specifiche, escludere cartelle o file specifici in base a schemi o percorsi esatti.

Inoltre, è possibile definire un proprio insieme di regole e personalizzare il modo in cui Pint risolve i problemi del codice. Poiché Pint è costruito sulla base di PHP-CS-Fixer, è possibile consultare l’elenco delle regole disponibili sulla pagina GitHub di PHP-CS-Fixer.

Correggere il codice con Pint

L’esecuzione di Pint sul proprio progetto è semplice. Basta usare il seguente comando:

./vendor/bin/pint

È possibile personalizzare il comportamento di Pint utilizzando varie opzioni, come ad esempio:

  1. Per eseguire Pint in modalità verbosa, utilizzare il seguente comando:
   ./vendor/bin/pint -v
  1. Eseguire Pint su una cartella specifica (ad esempio, “app”):
   ./vendor/bin/pint app/
  1. Limitare Pint a modificare solo i file con modifiche uncommitted:
   ./vendor/bin/pint --dirty

Eseguire questi comandi dalla cartella principale del progetto. A seconda dell’ambiente (ad esempio, macchina virtuale o container), potrebbe essere necessario recuperare i file modificati.

Per maggiori dettagli sulle opzioni più utilizzate, consultare la documentazione ufficiale di Laravel.

Automatizzare Pint con le azioni GitHub

Un approccio efficace è quello di integrare Pint nel progetto GitHub utilizzando le GitHub Actions. In questo modo, si può garantire che Pint venga eseguito a ogni push del repository.
Questo processo automatico consente di individuare e risolvere tempestivamente i problemi.

Per ottenere questo risultato, seguire i seguenti passaggi:

  1. Creare un flusso di lavoro GitHub Actions che includa l’esecuzione di Pint.
  2. Configurare il flusso di lavoro in modo che si attivi in caso di push al repository.

Per una guida dettagliata sull’impostazione di GitHub Actions per Laravel Pint, consultare la sezione Integrazione di Pint con GitHub Actions.

Conclusione

Il mantenimento della qualità del codice è un aspetto cruciale dello sviluppo del software, soprattutto quando si lavora con un team su un progetto di grandi dimensioni. Laravel Pint, con la sua facile installazione, le opzioni di configurazione e le potenti capacità di correzione del codice, è un’aggiunta preziosa al flusso di lavoro dello sviluppo. Applicando gli standard di codifica, migliorando la leggibilità del codice e automatizzando il processo di verifica della qualità del codice, Laravel Pint assicura che il codice rimanga pulito e coerente.

Che stiate lavorando a un progetto Laravel o a qualsiasi altra applicazione basata su PHP, l’integrazione di Laravel Pint può migliorare significativamente la vostra esperienza di codifica e la qualità complessiva del vostro software. Prendete in considerazione l’idea di integrare Laravel Pint nel vostro kit di strumenti di sviluppo per godere di una collaborazione più fluida, di un codice manutenibile e di una qualità del codice più elevata.