Hinzufügen mehrerer Codierungsstandards mit Composer

Es ist eine Sache, PHP CodeSniffer manuell zu verwenden, aber wenn Sie ein Dienstprogramm wie GrumPHP verwenden, um Ihre Arbeit zu überprüfen, bevor Sie sie in das Repository übertragen, möchten Sie wahrscheinlich die Version verwenden, die Sie mit Ihrer installieren Projekt.

Dies setzt Folgendes voraus:

1. Sie installieren PHP CodeSniffer lokal in Ihrem Projekt,
2. Sie möchten einen bestimmten Satz von Codierungsstandards installieren, die mit Ihrem Code ausgeführt werden.

Denken Sie daran, dass dies auch im Zusammenhang mit dem Wunsch geschieht, automatisierte Skripte während des Commit-Prozesses und in einer lokalen Umgebung (im Gegensatz zu einer globalen Einstellung) mit Composer auszuführen.

Composer bietet die Möglichkeit, Skripte während der Ausführung zu schreiben. Aus dem Handbuch :

Ein Skript kann in den Begriffen von Composer entweder ein PHP-Callback (als statische Methode definiert) oder ein beliebiger ausführbarer Befehlszeilenbefehl sein. Skripts sind nützlich, um den benutzerdefinierten Code eines Pakets oder paketspezifische Befehle während des Composer-Ausführungsprozesses auszuführen.

Um mehrere Codierungsstandards mit Composer zu installieren, damit wir das tun können, was wir mit GrumPHP und jedem Pre-Commit-Prozess tun, müssen wir die Skripte pre-install-cmd und pre-update-cmd nutzen. Dadurch wird sichergestellt, dass die richtigen Codierungsstandards für die Binärdatei von PHP CodeSniffer auf Projektebene festgelegt werden.

Fallbeispiel :

"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"
    ],
},

Beachten Sie im obigen Beispiel, dass ich die WordPress-Codierungsstandards zu PHP CodeSniffer hinzufüge.

Sie können jedoch mehrere Versionen von Codierungsstandards hinzufügen, wie folgt:

"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"
    ],
},

Und Sie können alle anderen Standards hinzufügen, die Sie haben, damit Sie das Skript an den richtigen Ort verweisen können, an dem sie installiert sind.

Sobald Sie dies getan haben, werden die Standards auf PHP CodeSniffer angewendet und sowohl während des Installations- als auch des Update – Composer-Prozesses ausgeführt.