Installieren mehrerer Codierungsstandards

Ich habe in mehreren Beiträgen darüber gesprochen, wie wichtig es ist, Codierungsstandards zu verwenden (für welchen Standard Sie sich auch entscheiden) und wie Sie PHP CodeSniffer (insbesondere mit Visual Studio Code) einrichten.

Es gibt jedoch eine interessante Herausforderung, wenn Sie mehrere Codierungsstandards mit PHPCS konfigurieren möchten. Und das ist auch kein so seltsames Szenario.

Stellen Sie sich vor, Sie haben mehrere verschiedene Projekte, an denen Sie arbeiten – eines verwendet die Codierungsstandards von WordPress, eines verwendet PSR2 und eines verwendet einen anderen Satz von Regeln, die von der Organisation definiert werden, für die Sie arbeiten.

Und Sie möchten sie alle als Optionen zu Ihrer Konfiguration hinzufügen.

Mehrere Codierungsstandards

Um dies zu tun, gehe ich davon aus, dass Sie die Regeln alle in ihren Verzeichnissen festgelegt haben. Zum Beispiel habe ich Regelsätze, die sich in zwei verschiedenen Verzeichnissen in meinem Projects- Verzeichnis befinden (das sich in Sync befindet ).

1. ~/Sync/Projekte/wpcs
2. ~/Sync/Projects/WDS-Coding-Standards

Habe auch PSR2 installiert.

Hier ist die Sache: Auf den ersten Blick sieht es so aus, als würde das gleichzeitige Hinzufügen mehrerer Regelsätze am einfachsten wie folgt aussehen :

$ phpcs --config-set installed_paths ./wpcs,./WDS-Coding-Standards

Selbst wenn die Umgebungsvariablen Ihrer Shell korrekt berücksichtigt werden, gilt dies nicht unbedingt. Stattdessen funktioniert es für die Dauer der Shell-Sitzung, aber es hält nicht, wenn Sie das nächste Mal Ihre IDE, Ihr Terminal oder das integrierte Terminal in Ihrer IDE öffnen, wird es wahrscheinlich nicht halten.

Also, was machen wir?

Einfach: Wenn Sie die Pfade zu Ihren Regeln festlegen, stellen Sie sicher, dass Sie den vollständig qualifizierten Pfad verwenden:

$ phpcs --config-set installed_paths ~/Sync/Projects/wpcs,~/Sync/Projects/WDS-Coding-Standards

Und das tut es. Angenommen, die Umgebungsvariablen sind richtig eingestellt und Sie haben die richtigen Pfade zu Ihren Codierungsstandards angegeben, dann sollten Sie startklar sein.