Aggiunta di più standard di codifica con Composer

Una cosa è usare PHP CodeSniffer manualmente, ma se stai usando un’utilità come GrumPHP per controllare il tuo lavoro prima di inviarlo al repository, allora probabilmente vorrai usare la versione che stai installando con il tuo progetto.

Ciò presuppone che:

1. Stai installando PHP CodeSniffer localmente nel tuo progetto,
2. Si desidera installare un insieme specifico di standard di codifica da eseguire sul codice.

Ricorda, questo viene fatto anche nel contesto di voler eseguire script automatizzati durante il processo di commit e in un ambiente locale (rispetto a un’impostazione globale) con Composer.

Composer offre la possibilità di scrivere script durante l’esecuzione. Dal manuale :

Uno script, nei termini di Composer, può essere un callback PHP (definito come metodo statico) o qualsiasi comando eseguibile dalla riga di comando. Gli script sono utili per eseguire il codice personalizzato di un pacchetto o i comandi specifici del pacchetto durante il processo di esecuzione di Composer.

Per installare più standard di codifica con Composer in modo da poter fare ciò che facciamo con GrumPHP e qualsiasi processo di pre-commit, dobbiamo sfruttare gli script pre-install-cmd e pre-update-cmd. In questo modo si assicurerà che gli standard di codifica appropriati siano impostati per il binario a livello di progetto di PHP CodeSniffer.

Caso in questione :

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
},

Nota nell’esempio sopra, mi sto assicurando di aggiungere gli standard di codifica di WordPress a PHP CodeSniffer.

Ma puoi aggiungere più versioni di standard di codifica, in questo modo:

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
},

E puoi aggiungere qualsiasi altro standard che hai permettendoti di puntare lo script nella posizione corretta in cui sono installati.

Una volta fatto, gli standard verranno applicati a PHP CodeSniffer e verranno eseguiti sia durante l’ installazione che durante l’ aggiornamento dei processi di Composer.