Laravel Pint & Code Quality

// Pint comes pre-installed with Laravel 9+ // For older projects, install it: composer require laravel/pint --dev // Run Pint to fix code style ./vendor/bin/pint // Check without fixing (useful for CI) ./vendor/bin/pint --test // Fix specific files or directories ./vendor/bin/pint app/Models ./vendor/bin/pint app/Http/Controllers/UserController.php // Preview changes without applying them ./vendor/bin/pint --dry-run // Show verbose output ./vendor/bin/pint -v // Use specific preset ./vendor/bin/pint --preset psr12

// pint.json { "preset": "laravel", "rules": { "simplified_null_return": true, "braces": false, "new_with_braces": { "anonymous_class": true, "named_class": true }, "no_unused_imports": true, "ordered_imports": { "sort_algorithm": "alpha" }, "single_quote": true, "trailing_comma_in_multiline": { "elements": ["arrays"] } }, "exclude": [ "vendor", "storage", "bootstrap/cache" ] } // Alternative: use PHP configuration // pint.php <?php return [ 'preset' => 'laravel', 'rules' => [ 'array_syntax' => ['syntax' => 'short'], 'binary_operator_spaces' => [ 'default' => 'single_space', ], 'blank_line_after_namespace' => true, 'blank_line_after_opening_tag' => true, 'blank_line_before_statement' => [ 'statements' => ['return'], ], ], ];

# .husky/pre-commit
#!/bin/sh
./vendor/bin/pint --test || (
    ./vendor/bin/pint
    git add .
)

// Install Larastan composer require larastan/larastan --dev // Create phpstan.neon configuration // phpstan.neon includes: - vendor/larastan/larastan/extension.neon parameters: paths: - app - config - database - routes # Level goes from 0 to 9 (strictest) level: 6 # Ignore specific errors ignoreErrors: - '#Call to an undefined method .*::factory\(\)#' # Check for missing types checkMissingIterableValueType: false checkGenericClassInNonGenericObjectType: false # Custom rules excludePaths: - vendor - storage - bootstrap/cache // Run PHPStan ./vendor/bin/phpstan analyse // Fix what can be fixed automatically ./vendor/bin/phpstan analyse --generate-baseline // Use memory limit for large projects ./vendor/bin/phpstan analyse --memory-limit=2G

// Issue: Property has no type or mixed type // Bad class User extends Model { protected $fillable; } // Good class User extends Model { /** @var array<string> */ protected $fillable = ['name', 'email']; } // Issue: Method has no return type // Bad public function getUsers() { return User::all(); } // Good public function getUsers(): Collection { return User::all(); } // Issue: Property is never read/written // Use PHPStan annotations /** @phpstan-ignore-next-line */ private $unusedProperty; // Issue: Undefined method on Eloquent model /** @var \App\Models\User $user */ $user = User::find(1); $user->posts(); // PHPStan now knows about this relation // Or use PHPDoc on the model /** * @property-read \Illuminate\Database\Eloquent\Collection<Post> $posts * @method \Illuminate\Database\Eloquent\Relations\HasMany posts() */ class User extends Model { public function posts() { return $this->hasMany(Post::class); } }

// Install IDE Helper composer require --dev barryvdh/laravel-ide-helper // Generate helper files php artisan ide-helper:generate php artisan ide-helper:models php artisan ide-helper:meta // Auto-generate on composer update // composer.json { "scripts": { "post-update-cmd": [ "@php artisan ide-helper:generate", "@php artisan ide-helper:models --nowrite", "@php artisan ide-helper:meta" ] } } // Add to .gitignore _ide_helper.php _ide_helper_models.php .phpstorm.meta.php // Generate PHPDoc for models php artisan ide-helper:models --write // This adds PHPDoc to your models: /** * App\Models\User * * @property int $id * @property string $name * @property string $email * @property \Illuminate\Support\Carbon|null $email_verified_at * @property string $password * @property-read \Illuminate\Notifications\DatabaseNotificationCollection $notifications * @property-read \Illuminate\Database\Eloquent\Collection $posts * @method static \Illuminate\Database\Eloquent\Builder|User whereEmail($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereName($value) */ class User extends Authenticatable { // ... }

// Laravel Debugbar - powerful debug toolbar composer require barryvdh/laravel-debugbar --dev // Telescope - elegant debug assistant for Laravel composer require laravel/telescope --dev php artisan telescope:install php artisan migrate // Access Telescope // Visit: http://your-app.test/telescope // Ray - desktop debugging tool by Spatie composer require spatie/laravel-ray --dev // Usage ray('Debug this'); ray($user, $posts); ray()->table($users); ray()->measure(fn() => expensive_operation()); // Clock - debugging helper for Laravel use Illuminate\Support\Facades\Date; Date::setTestNow('2024-01-01 12:00:00'); now(); // Returns 2024-01-01 12:00:00 // Query debugging DB::enableQueryLog(); // Your queries here dd(DB::getQueryLog()); // Or use query listener DB::listen(function ($query) { logger($query->sql, $query->bindings, $query->time); });

// GitHub Actions workflow // .github/workflows/laravel.yml name: Laravel CI on: push: branches: [ main, develop ] pull_request: branches: [ main, develop ] jobs: laravel-tests: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.2' extensions: mbstring, xml, bcmath coverage: xdebug - name: Copy .env run: php -r "file_exists('.env') || copy('.env.example', '.env');" - name: Install Dependencies run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist - name: Generate key run: php artisan key:generate - name: Directory Permissions run: chmod -R 777 storage bootstrap/cache - name: Create Database run: | mkdir -p database touch database/database.sqlite - name: Run Pint run: ./vendor/bin/pint --test - name: Run PHPStan run: ./vendor/bin/phpstan analyse - name: Execute tests env: DB_CONNECTION: sqlite DB_DATABASE: database/database.sqlite run: php artisan test --coverage - name: Upload coverage reports uses: codecov/codecov-action@v3