shopify/shopify-app-store-review

Was macht shopify-app-store-review?

Führen Sie eine Compliance-Prüfung vor der Einreichung für Ihre Shopify-App durch. Untersucht die Anforderungen des App Stores und zeigt potenzielle Probleme auf, bevor Sie die offizielle Überprüfung einleiten.

Funktionen

• Automatisierte Richtlinienprüfung: Scannt Ihren Code auf Einhaltung der Shopify App Store-Richtlinien, einschließlich Berechtigungen, OAuth-Konfiguration und UI-Elemente.
• Frühzeitige Problemidentifikation: Listet wahrscheinliche Ablehnungsgründe auf, wie fehlende oder falsche Konfigurationen in Ihren App-Dateien.
• Benutzerfreundliche Ausgabe: Gibt klare, handlungsorientierte Empfehlungen in der Konsole aus, direkt referenzierend auf die relevanten Richtlinienabschnitte.
• Integration in den Workflow: Kann nahtlos in CI/CD-Pipelines integriert werden, um vor jedem Deployment eine Prüfung durchzuführen.

Voraussetzungen

• Node.js (Version 16 oder höher)
• Ein Shopify-App-Projekt (entweder Custom- oder Public-App)

Installation

npx shopify/shopify-app-store-review

Verwendung

Führen Sie den Befehl im Wurzelverzeichnis Ihrer Shopify-App aus:

npx shopify/shopify-app-store-review --path ./my-shopify-app

Optional: Sie können auch einen spezifischen Konfigurationspfad angeben:

npx shopify/shopify-app-store-review --config ./shopify.app.toml

Ausgabe

Die Prüfung gibt eine Zusammenfassung der gefundenen Probleme aus, kategorisiert nach Schweregrad (Fehler, Warnung, Hinweis). Jeder Eintrag enthält:

• Problembeschreibung: Was genau nicht den Richtlinien entspricht.
• Betroffene Datei/Codezeile: Konkreter Ort im Code.
• Empfehlung: Wie das Problem behoben werden kann, inklusive Link zur offiziellen Dokumentation.

Beispiel

⚠️ Warnung: Fehlende OAuth-Redirect-URI in der Konfiguration
  Datei: shopify.app.toml, Zeile 15
  Empfehlung: Fügen Sie eine gültige Redirect-URI unter `access_scopes.redirect_uris` hinzu.
  Siehe: https://shopify.dev/docs/apps/authentication/oauth#redirect-uris

Konfiguration

Die Fertigkeit sucht standardmäßig nach einer shopify.app.toml-Datei. Sie können die Konfiguration anpassen, indem Sie eine .shopify-reviewrc-Datei im Wurzelverzeichnis erstellen:

{
  "strict": true,
  "ignorePaths": ["node_modules", "dist"],
  "rules": {
    "scope-consistency": "error",
    "oauth-redirect-uri": "warn"
  }
}

Unterstützte Plattformen

• Lokale Entwicklungsumgebungen
• CI/CD-Systeme (GitHub Actions, GitLab CI, etc.)
• Cloud-IDE-Umgebungen

Fehlerbehebung

• Problem: Befehl wird nicht gefunden. Lösung: Stellen Sie sicher, dass Node.js installiert ist und führen Sie npx shopify/shopify-app-store-review erneut aus.
• Problem: Keine shopify.app.toml gefunden. Lösung: Navigieren Sie zum Wurzelverzeichnis Ihres Shopify-App-Projekts oder geben Sie den Pfad mit --path an.

Lizenz

MIT