README

🎯 Standardized PHP code quality configurations for PHP-CS-Fixer, PHPStan, and Rector. Share consistent coding standards across all your projects with a single Composer package.

This package provides battle-tested, production-ready configuration files that can be shared across all your PHP projects, ensuring consistent code quality, formatting standards, and static analysis rules. Stop duplicating configuration files—maintain them in one place and reuse everywhere.

✨ Features

🔧 Pre-configured PHP-CS-Fixer rules for consistent code formatting
🔍 PHPStan configuration with sensible defaults for static analysis
⚡ Rector setup for automated code refactoring and modernization
🪝 Git hooks included (pre-commit & pre-push) to enforce standards
📦 Easy installation via Composer
🎨 Fully extensible—override or extend any configuration
🔄 Semantic versioning for predictable updates

🚀 Quick Start

composer require --dev qb-technologies/laravel-config

That's it! Then extend the base configurations in your project as needed.

📦 Installation

Step 1: Install the Package

composer require --dev qb-technologies/laravel-config

Step 2: Install Git Hooks (Optional but Recommended)

Install the pre-commit and pre-push hooks:

cp vendor/qb-technologies/laravel-config/hooks/pre-commit .git/hooks/pre-commit
cp vendor/qb-technologies/laravel-config/hooks/pre-push .git/hooks/pre-push
chmod +x .git/hooks/pre-commit .git/hooks/pre-push

Or use the included installer:

php vendor/bin/install-hooks

Usage

PHP-CS-Fixer

Create a .php-cs-fixer.php file in your project root:

<?php

use PhpCsFixer\Finder;

$baseConfig = require __DIR__ . '/vendor/qb-technologies/laravel-config/config/.php-cs-fixer.php';

$finder = Finder::create()
    ->in(__DIR__ . '/app')
    ->in(__DIR__ . '/domain')
    ->in(__DIR__ . '/routes')
    ->in(__DIR__ . '/config')
    ->in(__DIR__ . '/tests')
    ->exclude('bootstrap')
    ->exclude('storage')
    ->exclude('vendor');

return $baseConfig->setFinder($finder);

PHPStan

Create a .phpstan.neon file in your project root:

includes:
    - ./vendor/qb-technologies/laravel-config/config/.phpstan.neon

parameters:
    level: 9  # Adjust level as needed for your project
    paths:
        - app
        - domain
        - routes
        - database
        - config
    ignoreErrors: []
    # Add project-specific ignore errors here if needed

rules:
    - Spatie\Ray\PHPStan\RemainingRayCallRule

Or, if you want to use the base config directly and only override specific parameters:

includes:
    - ./vendor/qb-technologies/laravel-config/config/.phpstan.neon

parameters:
    paths:
        - app
        - domain
    # Only override what you need

Rector

Create a rector.php file in your project root:

<?php

use Rector\Config\RectorConfig;
use Rector\Naming\Rector\Class_\RenamePropertyToMatchTypeRector;
use Rector\Naming\Rector\ClassMethod\RenameParamToMatchTypeRector;

$baseConfig = require __DIR__ . '/vendor/qb-technologies/laravel-config/config/rector.php';

return $baseConfig
    ->withPaths([
        __DIR__ . '/app',
        __DIR__ . '/bootstrap',
        __DIR__ . '/config',
        __DIR__ . '/domain',
        __DIR__ . '/routes',
        __DIR__ . '/tests',
    ])
    ->withSkip([
        RenamePropertyToMatchTypeRector::class => [
            // Add project-specific files to skip
            __DIR__ . '/domain/Some/DTOs/SomeDTO.php',
        ],
        RenameParamToMatchTypeRector::class => [
            // Add project-specific files to skip
        ],
    ]);

Updating Configurations

When you need to update the shared configurations:

Make changes to the configuration files in this repository
Commit and push the changes

Create a new tag (following semantic versioning):

git tag -a v1.0.1 -m "Update PHP-CS-Fixer rules"
git push origin v1.0.1

Update the version constraint in your project's composer.json if needed
Run composer update qb-technologies/laravel-config in your projects

Versioning

This package follows Semantic Versioning:

MAJOR version for breaking changes (e.g., removing a rule)
MINOR version for new features (e.g., adding new rules)
PATCH version for bug fixes and minor updates

Customization

Each project can extend or override the base configurations as needed. The base configurations are designed to be:

Comprehensive: Cover common code quality standards
Extensible: Easy to extend with project-specific rules
Flexible: Allow projects to customize paths, levels, and skip lists

Contributing

When proposing changes to the shared configurations:

Test the changes in at least one project
Document the reasoning for the change
Ensure backward compatibility or clearly mark as a breaking change
Update this README if usage instructions change

License

MIT License - see LICENSE file for details.

qb-technologies / laravel-config

Maintainers

Details