PYZ: PhpStorm Plugin für Spryker
9. Februar 2022 / Jochen Gartner
Unsere Developer Teams lieben Spryker. Als »Breakout« 2021 vor der Tür stand – die Woche bei Turbine Kreuzberg, in der die tägliche Arbeit ruht und wir gemeinsam neue, eigene Projekte vorantreiben – war zu erwarten, dass sich mindestens ein Team mit Spryker beschäftigen würde. Und das nicht zu wenig: Eines unserer Teams setzte sich zur Aufgabe, allen, die regelmäßig mit Spryker entwickeln, das Leben ein wenig leichter zu machen. Herausgekommen ist ein neues IDE-Plugin namens PYZ, das jetzt zum Download bereitsteht – und als Open Source-Projekt offen für alle ist, die sich daran beteiligen möchten.
Wer regelmäßig mit Spryker entwickelt, kennt das Spiel. Möchte man Spryker-Core-Funktionalitäten auf Projektebene erweitern, müssen immer wieder die gleichen Schritte durchlaufen werden:
- die richtige Verzeichnisstruktur anlegen,
- eine neue Datei erstellen,
- die Core-Datei erweitern
- und schließlich die Core-Datei importieren (indem man ein Alias verwendet, weil sie sich denselben Namen teilt).
In der Regel dauert das zwar nur wenige Sekunden, ist aber fehleranfällig und mühsam.
Deshalb hat ein Team von PHP-Entwicklern bei Turbine Kreuzberg PYZ entwickelt. Dabei handelt es sich um ein IDE-Plugin, das mit PhpStorm und IntelliJ IDEA Ultimate kompatibel ist. Das Plugin übernimmt all diese Aufgaben und spart wertvolle Zeit und Nerven. PYZ ermöglicht es Spryker-Entwickler:innen, Spryker-Core-Dateien mit nur einem Klick zu erweitern. Außerdem ermöglicht das Plugin die Navigation von ZED-Stubs und Gateway-Controllern und umgekehrt – etwas, das in Spryker vollständig entkoppelt ist und über HTTP-Aufrufe erfolgt, die keine IDE nachvollziehen kann.
1/2
2/2
Das Team hat PYZ als Lernprojekt während Breakout 2021 entwickelt – und zwar bereits mit dem Gedanken, es der Spryker-Community als Open-Source-Software zur Verfügung zu stellen. Wer möchte, ist herzlich eingeladen, daran aktiv mitzuarbeiten! Also: Erstellt jederzeit einen Pull-Request oder meldet Fehler, wenn etwas nicht wie vorgesehen funktioniert.
PYZ wurde von Christian Müllenhagen, Daniar Asanov, Jochen Gartner, Lev Stejngardt und Özkan Yilmaz entwickelt.
PYZ – Ein PhpStorm Plugin für Spryker-Entwickler:innen
- Erweitern von Spryker-Core Klassen, Schnittstellen und xml-Dateien auf Projektebene (Rechtsklick > Extend in PYZ / CTRL-ALT-E)
- Goto-Handling für Zed-Stub-Aufrufe und deren Gateway-Controller-Aktionen (URLs sind klickbar)
- Auflösen der Verwendung von Gateway-Controller-Aktionen in Zed-Stub-Aufrufen
Verwendung
- Dateien lassen sich auf Projektebene erweitern, indem man den Kontextmenüpunkt »Erweitern in PYZ« verwendet. Er wird nur für Dateien angezeigt, die sich in einem der Spryker Vendor-Verzeichnisse befinden.
- Dateien können stapelweise erweitert werden, indem man mehrere Dateien auf einmal auswählt.
- Das PYZ-Verzeichnis und der Basis-Namensraum lassen sich unter Einstellungen > Werkzeuge > PYZ-Plugin konfigurieren.
Jochen Gartner, Senior Developer
jochen.gartner@turbinekreuzberg.com