Shopware Extension Verifier: Ein umfassender Leitfaden für Entwickler

Die Entwicklung von Shopware-Erweiterungen bringt die Verantwortung mit sich, die Qualität des Codes, die Kompatibilität und die Einhaltung der Best Practices sicherzustellen. Glücklicherweise bietet Shopware ein leistungsstarkes Werkzeug: Extension Verifier. Mit diesem Tool können Entwickler ihre Plugins einfach validieren und formatieren, Korrekturen automatisieren und sicherstellen, dass der Code den Shopware-Richtlinien entspricht.

In diesem Handbuch erfahren Sie, wie Sie den Shopware Extension Verifier in Ihrem Entwicklungsprozess einrichten und verwenden können.

Was ist Shopware Extension Verifier?

Der Shopware Extension Verifier ist ein Befehlszeilen-Tool, das zur Analyse und Verbesserung von Shopware-Plugins entwickelt wurde. Es hilft Entwicklern, Probleme zu identifizieren, ihren Code gemäß den Shopware-Standards zu formatieren und sogar häufige Fehler automatisch zu beheben.

Wesentliche Merkmale

• Plugin-Qualität prüfen: Analysieren Sie das Plugin auf veraltete Funktionen und Code-Verletzungen.
• Probleme automatisch beheben: Behebt automatisch bekannte Probleme im Plugin-Code.
• Code formatieren: Formatieren Sie den Code gemäß den offiziellen Richtlinien von Shopware.
• Twig-Vorlagen aktualisieren: Verwenden Sie AI, um Twig-Vorlagen zu aktualisieren und zu verbessern (experimentell).

Installationsanleitung

Docker verwenden (empfohlen)

Sie brauchen nichts lokal zu installieren, sondern führen den Verifier einfach über Docker aus:

docker run --rm ghcr.io/shopwarelabs/extension-verifier:latest

Mit diesem Befehl wird das neueste Image des Erweiterungsprüfers in einem Docker-Container gezogen und ausgeführt.

PHAR verwenden (alternativ)

Wenn Sie nicht mit Docker arbeiten, können Sie die PHAR-Datei herunterladen und sie mit PHP ausführen:

curl -sSL https://github.com/shopwareLabs/extension-verifier/releases/latest/download/sw-extension-verifier.phar -o verifier.phar
php verifier.phar [command] [path]

Verfügbare Befehle und ihre Funktionen

1. prüfen

Zweck: Analysieren Sie Ihr Shopware-Plugin auf veraltete Funktionen, Verstöße gegen Codierungsstandards und bewährte Verfahren.

Verwendung:

sw-extension-verifier check [path] [flags]

Flaggen:

Docker-Beispiel:

docker run --rm -v "$(pwd)/MyPlugin:/app" ghcr.io/shopwarelabs/extension-verifier:latest check /app

2. reparieren

Zweck: Behebt automatisch bekannte Probleme in Ihrem Plugin-Code.

Verwendung:

sw-extension-verifier fix [path]

Docker-Beispiel:

docker run --rm -v "$(pwd)/MyPlugin:/app" ghcr.io/shopwarelabs/extension-verifier:latest fix /app

3. das Format

Zweck: Formatiert Ihren Plugin-Code so, dass er dem Codierungsstil und der Struktur von Shopware entspricht.

Verwendung:

sw-extension-verifier format [path]

Docker-Beispiel:

docker run --rm -v "$(pwd)/MyPlugin:/app" ghcr.io/shopwarelabs/extension-verifier:latest format /app

4. twig-upgrade (experimentell)

Zweck: Einsatz von KI zur Unterstützung bei der Aktualisierung von Twig-Vorlagen auf neuere Syntax oder bewährte Verfahren.

Verwendung:

sw-extension-verifier twig-upgrade [path]

Docker-Beispiel:

docker run --rm -v "$(pwd)/MyPlugin:/app" ghcr.io/shopwarelabs/extension-verifier:latest twig-upgrade /app

5. die Fertigstellung

Zweck: Aktiviert die automatische Vervollständigung der Befehlszeile für Ihre Shell.

Verwendung:

sw-extension-verifier completion [bash|zsh|fish|powershell]

6. Hilfe

Zweck: Zeigt detaillierte Hilfe und Verwendung für einen bestimmten Befehl an.

Verwendung:

sw-extension-verifier help [command]

Best Practices für die Verwendung von Shopware Extension Verifier

• Führen Sie die Prüfung vor der Einreichung durch: Stellen Sie sicher, dass Ihr Plugin für den Shopware Store bereit ist.
• Verwenden Sie das Format regelmäßig: Behalten Sie die Konsistenz und den Stil des Codes bei.
• Fix nutzen: Sparen Sie Zeit, indem Sie bekannte Probleme von der Überprüfung automatisch beheben lassen.
• Sichern Sie vor der Verwendung von twig-upgrade: Da es sich um ein experimentelles Programm handelt, sollten Sie immer zuerst eine Sicherungskopie Ihres Codes erstellen.

Beispiel aus der Praxis

Angenommen, Ihr Plugin befindet sich unter:

E:/sw6/plugin/MoorlCmsTwig

Öffnen Sie Git Bash oder PowerShell und navigieren Sie zum Plugin-Verzeichnis:

Git Bash Beispiel:

cd "/e/sw6/plugin"
docker run --rm -v "$(pwd)/MoorlCmsTwig:/app" ghcr.io/shopwarelabs/extension-verifier:latest check /app

PowerShell-Beispiel:

cd "E:\sw6\plugin"
docker run --rm -v "${PWD}/MoorlCmsTwig:/app" ghcr.io/shopwarelabs/extension-verifier:latest check /app

Schlussfolgerung

Der Shopware Extension Verifier ist ein leistungsstarkes Dienstprogramm für alle Entwickler, die mit Shopware-Plugins arbeiten. Egal, ob Sie ein Plugin für den Shopware Store vorbereiten oder interne Erweiterungen pflegen, dieses Tool kann Ihren Arbeitsablauf erheblich verbessern, Probleme frühzeitig erkennen und die Einhaltung der Shopware-Standards sicherstellen.

Bitte kontaktieren Sie uns unter manish@bay20.com oder rufen Sie uns unter +91-8800519180 / +91-9582784309 an, wenn Sie Unterstützung im Zusammenhang mit Shopware benötigen. Sie können auch die Shopware-Entwicklungsseite besuchen, um die von uns angebotenen Dienstleistungen zu überprüfen.