Voraussetzungen
1. Eine Laravel-Installation (vorausgesetzt, du hast bereits ein Laravel-Projekt eingerichtet)
2. Composer installiert
Schritt 1: Installation von Laravel Pint
composer require laravel/pint --devSchritt 2: Konfiguration
Nach der Installation kannst du die Standardkonfigurationsdatei veröffentlichen, um Laravel Pint nach deinen Bedürfnissen anzupassen:
php artisan vendor:publish --tag=pint-config
Dies erstellt eine pint.json Datei im Stammverzeichnis deines Projekts.
Tipp
Anpassen der Konfiguration ->
Bearbeite die pint.json Datei, um spezifische Regeln oder Verzeichnisse festzulegen, die Pint berücksichtigen soll. Zum Beispiel:
{
"preset": "laravel",
"rules": {
"array_syntax": {"syntax": "short"},
"no_unused_imports": true
},
"paths": [
"app",
"config",
"routes",
"tests"
]
}Schritt 3: Nutzung von Laravel Pint
Um den Code-Stil zu prüfen und automatisch zu korrigieren, führe den folgenden Befehl aus:
./vendor/bin/pintTipp
Nur Überprüfung ->
Wenn du den Code-Stil nur überprüfen möchtest, ohne Änderungen vorzunehmen, kannst du den --test Schalter verwenden:
./vendor/bin/pint --testSchritt 4: Integration in den Entwicklungs-Workflow
Du kannst Laravel Pint in deinen Git-Workflow integrieren, indem du einen Pre-Commit Hook hinzufügst, der sicherstellt, dass der Code-Stil vor jedem Commit überprüft wird.
Mache die Datei ausführbar:
#!/bin/sh
./vendor/bin/pint --test
if [ $? -ne 0 ]; then
echo "Code style issues found. Please fix them before committing."
exit 1
fichmod +x .git/hooks/pre-commit4.2 Continuous Integration (CI)
Füge Laravel Pint zu deiner CI/CD-Pipeline hinzu. Hier ist ein Beispiel für eine GitHub Actions Konfigurationsdatei (.github/workflows/pint.yml):
name: Laravel Pint
on: [push, pull_request]
jobs:
pint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
- run: composer install
- run: ./vendor/bin/pint --testTipp
Anpassung an eigene Coding Standards
Du kannst die Regeln in der pint.json Datei an deine eigenen Coding-Standards anpassen, um sicherzustellen, dass dein Code den spezifischen Anforderungen deines Projekts entspricht.
Tipp 4.3:
Erweiterte Konfiguration
Du solltest nun in der Lage sein, Laravel Pint in deinem Laravel-Projekt zu installieren und zu nutzen. Durch die Verwendung von Laravel Pint kannst du sicherstellen, dass dein Code-Stil konsistent und lesbar bleibt, was die Wartbarkeit und Qualität deines Codes verbessert.
Falls du weitere Fragen hast oder auf Probleme stößt, lass es mich wissen!
Tipp
Wenn du komplexere Konfigurationen benötigst, kannst du die rules-Sektion in der pint.json Datei erweitern, um spezifische Code-Stil-Regeln festzulegen.
"rules": {
"single_quote": true,
"no_trailing_whitespace": true,
"indentation_type": {"spaces": 4}
}
Kommentare 0
Noch keine Kommentare. Seien Sie der Erste!