Come escludere file da PHP CodeSniffer

Quando lavori con PHP CodeSniffer e lo stai facendo nel terminale, probabilmente stai cercando di generare errori in qualcosa di diverso dal tuo IDE.

Voglio dire, se fosse così, lo avresti semplicemente in esecuzione nel tuo editor, giusto?

Ma ci sono momenti in cui potresti essere interessato a trovare i problemi nel codice di altre persone. Forse è una dipendenza, forse è un software di terze parti, o forse è un favore.

In ogni caso, se hai impostato la directory del progetto in un modo che utilizza Composer per includere PHP CodeSniffer e stai utilizzando WordPress Coding Standards, probabilmente dovrai escludere i file da PHP CodeSniffer durante l’esecuzione di programma.

Ed è così che puoi farlo.

Prima di entrare nei comandi necessari, presumo che tu abbia una configurazione di directory simile a questa:

Una potenziale struttura di directory.

Cioè, hai:

• un mucchio di file PHP (e sottodirectory contenenti file PHP),
• un file composer.json per portare PHP CodeSniffer nel progetto
• una directory del fornitore che include le dipendenze per PHP CodeSniffer

Se hai installato WordPress Coding Standards ma non li hai impostati per PHP CodeSniffer, emetti questo comando:

$ ./vendor/bin/phpcs --config-set installed_paths ~/path/to/wpcs

Quindi ecco il problema:

Vuoi escludere i file da PHP CodeSniffer, ma hai molti file da annusare (vale a dire da quando hai introdotto la directory del fornitore). Come si escludono i file da PHP CodeSniffer pur ottenendo i risultati desiderati?

Hai bisogno di alcuni comandi aggiuntivi:

1. assicurati di aver incluso gli standard di codifica di WordPress come parte della configurazione,
2. dire esplicitamente a PHP CodeSniffer di utilizzare lo standard WordPress
3. indica a PHP CodeSniffer quali directory ignorare e quali file elaborare

Suona complicato? Il comando è davvero semplice:

$ ./vendor/bin/phpcs --ignore=*/vendor/* --standard=WordPress .

E il terminale dovrebbe apparire così:

Il risultato netto dello sniffare solo i file PHP per la directory corrente.

A questo punto, dovresti essere in grado di visualizzare gli errori nel tuo terminale (speriamo che non ce ne siano, giusto? 😏) oppure puoi reindirizzarli in un altro file da rivedere in un’altra applicazione o in un secondo momento.