So schließen Sie Dateien von PHP CodeSniffer aus

Wenn Sie mit PHP CodeSniffer arbeiten und dies im Terminal tun, versuchen Sie wahrscheinlich, Fehler in etwas anderem als Ihrer IDE auszugeben.

Ich meine, wenn das der Fall wäre, würdest du es einfach in deinem Editor laufen lassen, oder?

Aber es gibt Zeiten, in denen Sie vielleicht daran interessiert sind, die Probleme im Code anderer Leute zu finden. Vielleicht ist es eine Abhängigkeit, vielleicht ist es eine Software eines Drittanbieters oder vielleicht ist es ein Gefallen.

Was auch immer der Fall ist, wenn Sie das Projektverzeichnis so eingerichtet haben, dass Composer verwendet wird, um PHP CodeSniffer einzubinden, und Sie die WordPress Coding Standards verwenden, müssen Sie wahrscheinlich Dateien von PHP CodeSniffer ausschließen, wenn Sie das ausführen Programm.

Und so können Sie das tun.

Bevor ich zu den erforderlichen Befehlen komme, gehe ich davon aus, dass Sie ein Verzeichnis wie das folgende eingerichtet haben:

Eine mögliche Verzeichnisstruktur.

Das heißt, Sie haben:

• eine Reihe von PHP-Dateien (und Unterverzeichnissen, die PHP-Dateien enthalten),
• eine composer.json -Datei zum Einbringen von PHP CodeSniffer in das Projekt
• ein Herstellerverzeichnis, das die Abhängigkeiten für PHP CodeSniffer enthält

Wenn Sie die WordPress Coding Standards installiert, aber nicht für PHP CodeSniffer eingestellt haben, geben Sie diesen Befehl ein:

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

Also hier ist das Problem:

Sie möchten Dateien von PHP CodeSniffer ausschließen, haben aber viele Dateien zu schnüffeln (nämlich seit Sie das Vendor-Verzeichnis eingeführt haben). Wie schließen wir Dateien von PHP CodeSniffer aus und erhalten trotzdem die gewünschten Ergebnisse?

Sie benötigen ein paar zusätzliche Befehle:

1. Stellen Sie sicher, dass Sie die WordPress Coding Standards als Teil der Konfiguration eingeschlossen haben,
2. Weisen Sie PHP CodeSniffer ausdrücklich an, den WordPress-Standard zu verwenden
3. Teilen Sie PHP CodeSniffer mit, welche Verzeichnisse ignoriert und welche Dateien verarbeitet werden sollen

Klingt kompliziert? Der Befehl ist wirklich einfach:

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

Und das Terminal sollte am Ende so aussehen:

Das Nettoergebnis des Sniffens von nur PHP-Dateien für das aktuelle Verzeichnis.

An diesem Punkt sollten Sie in der Lage sein, die Fehler in Ihrem Terminal anzuzeigen (hoffentlich gibt es keine, oder? 😏) oder Sie können sie in eine andere Datei leiten, um sie in einer anderen Anwendung oder zu einem späteren Zeitpunkt zu überprüfen.