Php Conventions Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require --dev ecphp/php-conventions
   

   Add to composer.json under require-dev if not using globally.

2. First Use Case Run the convention checker against a Laravel project:

   ./vendor/bin/php-conventions check src
   

   Focus on the src directory (or app/ in Laravel) to avoid false positives in vendor/ or config/.

3. Where to Look First

   • Ruleset: Check ecphp/php-conventions ruleset (if available) for supported checks.
   • Laravel-Specific: Prioritize rules like:
     • PSR12 (Laravel follows PSR-12 by default).
     • NoHardcodedValues (useful for config/database strings).
     • LaravelSpecific (e.g., Route::get formatting, use ordering).

Implementation Patterns

Workflows

1. Pre-Commit Hook Integrate with Laravel’s pre-commit or use husky + php-conventions:

   # .husky/pre-commit
   ./vendor/bin/php-conventions check src --no-cache
   

   • Why? Catch violations early without manual runs.

2. CI/CD Pipeline Add to Laravel’s GitHub Actions (.github/workflows/php.yml):

   - name: Run PHP Conventions