Einrichtung und Nutzung von Laravel Pint

Voraussetzungen

1. Eine Laravel-Installation (vorausgesetzt, du hast bereits ein Laravel-Projekt eingerichtet) 2. Composer installiert

Schritt 1: Installation von Laravel Pint

Installiere Laravel Pint mithilfe von Composer:

shell

composer require laravel/pint --dev

Schritt 2: Konfiguration

Nach der Installation kannst du die Standardkonfigurationsdatei veröffentlichen, um Laravel Pint nach deinen Bedürfnissen anzupassen:

shell

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:

php

{
    "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:

php

./vendor/bin/pint

Tipp

Nur Überprüfung ->
Wenn du den Code-Stil nur überprüfen möchtest, ohne Änderungen vorzunehmen, kannst du den --test Schalter verwenden:

php

./vendor/bin/pint --test

Schritt 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:

shell

#!/bin/sh

./vendor/bin/pint --test

if [ $? -ne 0 ]; then
    echo "Code style issues found. Please fix them before committing."
    exit 1
fi

php

chmod +x .git/hooks/pre-commit

4.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):

blade

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 --test

Tipp

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.

Info

Regelmäßige Ausführung
Führe Laravel Pint regelmäßig aus, um sicherzustellen, dass dein Code konsistent bleibt. Dies kann durch Einbindung in deinen täglichen Entwicklungs-Workflow oder durch Verwendung von Git Hooks erfolgen.

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.

php

"rules": {
    "single_quote": true,
    "no_trailing_whitespace": true,
    "indentation_type": {"spaces": 4}
}