Schreiben von PHP -Git -Hooks mit statischer Bewertung

Git Hooks: Automatisierung von Entwicklungsaufgaben mit PHP und statischer Bewertung

Für erfahrene Git -Benutzer sind Git -Hooks wahrscheinlich bekannt. Für die Uneingeweihten sind Git -Hooks Skripte, die durch bestimmte Git -Ereignisse (Commit, Push, Empfangen usw.) ausgelöst werden und auf dem Client und Server ausgeführt werden. Während sie traditionell in Bash geschrieben sind, können sie verschiedene Sprachen verwenden. PHP, obwohl sie nicht ideal für Shell Scripting, ist dank der statischen Überprüfung von Samuel Parkinson besser geeignet geworden. Mit dieser Bibliothek können Sie Git -Hooks nativ in PHP schreiben und optional Kernklassen nutzen.

Git-Hooks bieten zahlreiche Vorteile, darunter Lining, Leitungsnachrichten, Durchsetzung von Codierungsstandards und Ausführungskomponisten. Die statische Überprüfung verbessert dies durch Bereitstellung eines PHP-zentrierten Ansatzes.

wichtige Vorteile der statischen Überprüfung:

• native PHP -Git -Hookentwicklung.
• Verbesserte Eignung von PHP zum Erstellen von Git -Hooks.
• Composer-basierte Installation zur einfachen Integration.
• Erstellung von Custom Review Class für bestimmte Anforderungen.
• Automatisierung von Entwicklungsaufgaben, was zu einer besseren Workflow- und Codequalität führt.

Installation:

statische Überprüfung über Komponist installieren: composer require sjparkinson/static-review

Beispiel: Ein Vorkommat-Hook

Untersuchen wir ein Beispiel für Vorkommot-Haken aus dem statischen Überprüfungs-Repository. Dieser Haken zeigt die Kernfunktionalität:

#!/usr/bin/env php
<?php
// ... (Autoloader inclusion and error handling – as in original example) ...

// ... (Class imports – as in original example) ...

$reporter = new Reporter();
$climate  = new CLImate();
$Git      = new GitVersionControl();

$review = new StaticReview($reporter);

// Add reviews (LineEndingsReview, PhpLeadingLineReview, NoCommitTagReview, PhpLintReview, ComposerLintReview – as in original example)

// Review staged files
$review->review($Git->getStagedFiles());

// Report results
if ($reporter->hasIssues()) {
    // ... (Error reporting – as in original example) ...
} else {
    // ... (Success message – as in original example) ...
}

Dieser Haken verwendet mehrere Überprüfungsklassen, um Überprüfungen für inszenierte Dateien durchzuführen. Jede Review Klasse erweitert AbstractReview und implementiert ReviewInterface, und erfordert canReview() (bestimmt, ob eine Überprüfung anwendbar ist) und review() (führt die Überprüfung durch) Methoden.

Erstellen einer benutzerdefinierten Bewertung: Überprüfen Sie var_dump()

Erstellen wir eine benutzerdefinierte Überprüfung, um anhaltende var_dump() Anrufe zu erkennen. Erstellen Sie eine neue Klasse (z. B. VarDumpReview.php) in einer pSR-4-konformen Verzeichnisstruktur (z. B. src/SitePoint/StaticReview/PHP).

<?php
namespace SitePoint\StaticReview\PHP;

// ... (Imports – as in original example) ...

class VarDumpReview extends AbstractReview
{
    public function canReview(FileInterface $file)
    {
        return in_array($file->getExtension(), ['php', 'phtml']);
    }

    public function review(ReporterInterface $reporter, FileInterface $file)
    {
        $cmd = sprintf('grep --fixed-strings --ignore-case --quiet "var_dump" %s', $file->getFullPath());
        $process = $this->getProcess($cmd);
        $process->run();

        if (! $process->isSuccessful()) { // Note: Changed to !isSuccessful()
            $reporter->error('A call to `var_dump()` was found', $this, $file);
        }
    }
}

Diese Überprüfung überprüft PHP -Dateien für var_dump() mit grep. Wenn gefunden, wird ein Fehler gemeldet.

installieren Sie den Haken:

1. Fügen Sie die benutzerdefinierte Überprüfung in Ihrem Hakenskript vor dem Kommando hinzu.
2. Installieren Sie den Haken mit dem Befehlszeilen-Tool der statischen Überprüfung: ./vendor/bin/static-review.php hook:install hooks/example-pre-commit.php .git/hooks/pre-commit

Statische Überprüfung ermöglicht Entwickler, anspruchsvolle Git -Hooks in PHP zu erstellen, die Entwicklungsworkflows und die Codequalität zu verbessern. Seine Anpassbarkeit und Benutzerfreundlichkeit machen es zu einem wertvollen Vorteil für jedes PHP -Projekt.

Das obige ist der detaillierte Inhalt vonSchreiben von PHP -Git -Hooks mit statischer Bewertung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!