Writing PHP Git Hooks with Static Review

Git Hooks: Automating Development Tasks with PHP and Static Review

For seasoned Git users, Git hooks are likely familiar. For the uninitiated, Git hooks are scripts triggered by specific Git events (commit, push, receive, etc.), running on both client and server. While traditionally written in Bash, they can utilize various languages. PHP, though not ideal for shell scripting, has become more suitable thanks to Static Review by Samuel Parkinson. This library lets you write Git hooks natively in PHP, optionally leveraging core classes.

Git hooks offer numerous benefits, including linting, spell-checking commit messages, enforcing coding standards, and running Composer. Static Review enhances this by providing a PHP-centric approach.

Key Advantages of Static Review:

• Native PHP Git hook development.
• Improved suitability of PHP for creating Git hooks.
• Composer-based installation for easy integration.
• Custom review class creation for specific needs.
• Automation of development tasks, leading to better workflow and code quality.

Installation:

Install Static Review via Composer: composer require sjparkinson/static-review

Example: A Pre-Commit Hook

Let's examine a pre-commit hook example from the Static Review repository. This hook demonstrates the core functionality:

#!/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) ...
}

This hook utilizes several review classes to perform checks on staged files. Each Review class extends AbstractReview and implements ReviewInterface, requiring canReview() (determines if a review is applicable) and review() (performs the review) methods.

Creating a Custom Review: Checking for var_dump()

Let's build a custom review to detect lingering var_dump() calls. Create a new class (e.g., VarDumpReview.php) within a PSR-4 compliant directory structure (e.g., 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);
        }
    }
}

This review checks PHP files for var_dump() using grep. If found, an error is reported.

Installing the Hook:

1. Add the custom review to your pre-commit hook script.
2. Install the hook using Static Review's command-line tool: ./vendor/bin/static-review.php hook:install hooks/example-pre-commit.php .git/hooks/pre-commit

Static Review empowers developers to create sophisticated Git hooks in PHP, enhancing development workflows and code quality. Its customizability and ease of use make it a valuable asset for any PHP project.

The above is the detailed content of Writing PHP Git Hooks with Static Review. For more information, please follow other related articles on the PHP Chinese website!