thomaskekeisen.de

Aus dem Leben eines Bildschirmarbyters

Achtung: Diese Seite enthält Partner- und Werbe-Links. Daher ist diese Seite im Gesamten als Werbeanzeige zu verstehen!

Code immer korrekt formatiert

Ich lege bei Lulububu großen Wert auf wartbaren und sauberen Quellcode. Aus diesem Grund habe ich meine IDE PhpStorm so konfiguriert, dass beim Speichern einer Datei auch automatisch eventuell falsch eingerückter Code entsprechend korrekt formatiert wird. Hier eine kurze Anleitung, wie das funktioniert.

1: Macro aufnehmen

Zuerst muss das Macro aufgenommen werden. Hierzu kann im Menü unter Edit > Macros auf Start Macro recording geklickt werden. Sobald die Aufnahme läuft kann ebenfalls im PhpStorm-Menü unter Code auf Reformat Code geklickt werden. Ist der Code formatiert, muss die Datei anschließend mit einem Klick auf Save all im File -Menü gespeichert werden. Abschließend muss die Macro-Aufnahme über Edit > Macros und einem letzten Klick auf Stop Macro recording beendet werden.

Der Name des Macros kann nach Belieben gewählt werden. Ich habe mich für Autoformat on save entschieden. Hat alles geklappt, sollte das Macro unter Edit > Macros > Edit Macros wie im Screenshot auf der rechten Seite angezeigt werden. Falls zu viele Aktionen im Macro aufgenommen wurden, können diese auch einfach nachträglich über das Minus ( - ) entfernt werden.

Übrigens: PhpStorm erlaubt zwar nicht, Macros über das GUI zu exportieren. Alle Macros liegen aber in der Datei /Users/<Nutzername>/Library/Preferences/PhpStorm<Version>/options/macros.xml und können somit auch gut im Team geteilt werden.

                        macros.xml
                        
                            <application>
                              <component name="ActionMacroManager">
                                <macro name="Autoformat on save">
                                  <action id="ReformatCode" />
                                  <action id="SaveAll" />
                                </macro>
                              </component>
                            </application>

Screenshot Mein "Code formatieren und speichern"-Makro

2: Keymap anpassen

Damit nun aber auch beim Drücken von Cmd (⌘) + S auch tatsächlich der Quellcode entsprechend formatiert wird, muss in den PhpStorm-Einstellungen noch die Keymap angepasst werden. Hierzu muss der Shortcut von Save all entfernt und dem Macro Autoformat on save hinzugefügt werden. Et voilà: Ab jetzt wird bei jedem Drücken von Cmd (⌘) + S der Quellcode formatiert und anschließend gespeichert.

Screenshot Das neu erstellte Macro auf den Tastenbefehl CMD+S gelegt

3: Automatische Formatierung stellenweise deaktivieren

Manchmal kommt es vor, dass die automatische Formatierung keinen Sinn macht oder Code unnötig unlesbar macht. Für diesen Fall bietet PhpStorm die Möglichkeit, die automatische Formatierung über ein Kommentar direkt im Quellcode zu deaktivieren. Diese Funktion lässt sich in den PhpStorm-Einstellungen unter Editor > Code Style unter dem Punkt Formatter Control mit der Funktion Enable formatter markers in comments aktivieren.

Wenn aktiviert, kann Quellcode, der nicht automatisch formatiert werden soll, mit einem // @formatter:off sowie // @formatter:on umschlossen werden. Der Quellcode zwischen den Kommentaren wird dann nicht mehr angefasst.