← API-Referenz · Zurück zur README
Entwicklung
Paketprüfungen
Installiere die PHP-Abhängigkeiten:
composer install
Führe die Tests aus oder erzeuge einen Coverage-Bericht:
composer test
composer test:coverage
Wende den konfigurierten Codestil an:
composer style
Die Pest-Suites decken verschiedene Verträge ab:
| Suite | Abdeckung |
|---|---|
tests/Feature | Standardwerte, Überschreibungen, Löschen, fehlende Daten und Eigentümerschaft |
tests/Unit/Casts | Standard-JSON, benutzerdefinierte Casts, Morph Maps und Laravel Data |
tests/Unit/KeyTypes | Zeichenfolgen-, Ganzzahl-, Backed-Enum- und Pure-Unit-Enum-Schlüssel |
tests/Unit/PrimaryKeyTypes | Ganzzahlige, Zeichenfolgen-, UUID- und ULID-IDs übergeordneter Modelle |
tests/Unit/QueryCount | Anzahl der Lese- und Schreibabfragen einschließlich Eager Loading |
tests/Architecture | Namespaces, Typen, Striktheit und Laravel-Architekturregeln |
Dokumentationsprüfungen
Die Docusaurus-Seite benötigt Node.js 20 oder neuer. Installiere ihre Abhängigkeiten im Verzeichnis
docs:
npm ci
| Aufgabe | Befehl |
|---|---|
| Lokale Seite starten | npm run start |
| TypeScript prüfen | npm run typecheck |
| Übersetzungen prüfen | npm run check:i18n |
| Produktions-Build erstellen | npm run build |
Der Produktions-Build validiert interne Links für jede konfigurierte Locale.
Dokumentationsseiten liegen in docs/docs. Jede Seite verwendet Front Matter für die Reihenfolge in
der Seitenleiste, eine Navigationszeile am Anfang, relative Links zwischen Anleitungen und einen
Abschnitt Siehe auch am Ende.
Jede Locale außer der Standard-Locale liegt in
docs/i18n/<locale>/docusaurus-plugin-content-docs/current. Jede Locale muss dieselben Seitenpfade wie
docs/docs enthalten. Der Befehl npm run check:i18n prüft dies vor einem Produktions-Build.
Mitwirken
Beachte den Leitfaden für Beiträge, bevor du einen Pull Request öffnest.
Sicherheit
Melde Sicherheitsprobleme vertraulich an [email protected].
Mitwirkende
Erstellt von Andrey Helldar und den Projektmitwirkenden.
Siehe auch
- Erste Schritte — das Paket in einer Laravel-Anwendung installieren.
- Konfiguration — die veröffentlichten Paketdateien verstehen.
- API-Referenz — die öffentliche API vor Verhaltensänderungen prüfen.