PHPCBF Skript mit PhpStorm zum automatischen Anpassen des PHP-Codes an den PSR2-Kodierungsstil verwenden

PSR-Standards sind eine gute Sache. Bei der Teamentwicklung haben wir uns auf die Verwendung der PSR-2-Kodierungsstileinheiten geeinigt, aber nicht alle halten sich strikt an PSR-2, wenn sie ihren Code einreichen. Der Hauptgrund dafür ist, dass die Verbindlichkeit mündlicher Vereinbarungen sehr begrenzt ist und das Team nicht einheitlich dasselbe Textverarbeitungsprogramm verwendet; einige verwenden beispielsweise Sublime Text 3, andere PHPStorm, sodass jeder Entwickler seine eigene Vorstellung von Codeformatierung hat. Darüber hinaus kann es bei der manuellen Formatierung schwierig sein, Fehler zu vermeiden, was zu Inkonsistenzen im Code führen kann.

Glücklicherweise gibt es Möglichkeiten, die Einhaltung von PSR-2 zu erzwingen. Eine Möglichkeit besteht darin, das PSR2-Coding-Style-Skript (phpcbf) von PHP Code Beautifier (PHP-CS-Fixer) zu verwenden, einem statischen Analyse-Tool zur Standardisierung des PHP-Codes. PHPCBF kann verwendet werden, um sicherzustellen, dass der Code den PSR2-Einheiten entspricht.

In diesem Artikel wird gezeigt, wie Sie phpcbf mit PhpStorm verwenden, um den PHP-Code automatisch an den PSR2-Kodierungsstil anzupassen.

Voraussetzungen

Um diesem Tutorial folgen zu können, benötigen Sie Folgendes:

• PHPStorm IDE
• Composer
• PHP Code Beautifier (PHP-CS-Fixer)

Installieren von PHP Code Beautifier

Wenn Sie Composer noch nicht installiert haben, können Sie es wie folgt installieren:

curl -sS https://getcomposer.org/installer | php

Sobald Composer installiert ist, können Sie PHP Code Beautifier mit dem folgenden Befehl installieren:

composer global require friendsofphp/php-cs-fixer

Konfigurieren von PhpStorm für die Verwendung von PHP Code Beautifier

Nachdem PHP Code Beautifier installiert ist, müssen Sie PhpStorm so konfigurieren, dass es verwendet wird. Öffnen Sie dazu die Einstellungen von PhpStorm und gehen Sie zur Registerkarte "Editor" > "Code Style". Klicken Sie auf die Schaltfläche "Bearbeiten", um die PHP-Code-Stileinstellungen zu öffnen.

Wählen Sie im Dropdown-Menü "Schemata" die Option "PSR2". Klicken Sie dann auf die Registerkarte "Inspektionen" und aktivieren Sie die Option "PHP Code Sniffer-Validierung".

Verwenden von PHPCBF, um den Code zu formatieren

Um phpcbf zu verwenden, um den Code zu formatieren, öffnen Sie das Terminal und navigieren Sie zu dem Verzeichnis, das den PHP-Code enthält. Geben Sie dann den folgenden Befehl ein:

phpcbf --standard=PSR2 path/to/php/file.php

Dadurch wird der PHP-Code im angegebenen Pfad gemäß dem PSR2-Standard formatiert.

Fazit

In diesem Artikel haben wir gezeigt, wie Sie phpcbf mit PhpStorm verwenden, um den PHP-Code automatisch an den PSR2-Kodierungsstil anzupassen. Durch die Verwendung von phpcbf können Sie sicherstellen, dass Ihr Code den PSR2-Standards entspricht, was zu einem konsistenteren und besser lesbaren Code führt.