Ob man alleine an einem Projekt arbeit oder im Team: Code sollte übersichtlich und einheitlich formatiert sein. Fragen wie
- Kommen geschweifte Klammern ans Zeilenende oder an den Anfang der nächsten Zeile?
- Werden TRUE und false groß oder klein geschrieben?
- In welcher Reihenfolge stehen private, public und protected in einer Klasse?
sind durchaus kontrovers. Aber selbst wenn man sich beim Programmieren alle Mühe gibt sämtliche Absprachen einzuhalten, so wird es dennoch Abweichungen geben. Damit ihr dies in PHP-Projekten nicht händisch machen müsst, gibt es ein paar nette Werkzeuge.
Die Tools
- Als Editor kommt Atom zum Einsatz und wird durch das Paket atom-beautify ergänzt.
- Die eigentliche Arbeit übernimmt der PHP-CS-Fixer, aber der lässt sich auch von (anderen) IDEs nutzen.
- Die Konfigurationsdatei erstellt ihr mit Hilfe von: https://mlocati.github.io/php-cs-fixer-configurator/
Je nachdem ob ihr mit Windows, Linux oder Mac OS arbeitet, verläuft die Installation anders, aber die jeweiligen Projektseiten liefern dazu alles.
Der Workflow
Ihr habt nun zwei Möglichkeiten euren Code überarbeiten zu lassen: innerhalb des Editors oder auf der Kommandozeile. Atom könnt ihr nun automatisch beim Speichern den CS-Fixer ausführen lassen oder ihr macht dies manuell.
Das Ergebnis
Damit ihr wisst warum sich das alles lohnt 😉
Vorher
Nachher
