josecl/php-cs-fixer-custom-fixers

Set de reglas opinadas para PHP Coding Standards Fixer

v1.0.1 2022-08-30 12:28 UTC

Requires

• php: ^8.0
• ext-json: *
• friendsofphp/php-cs-fixer: ^3.0

Requires (Dev)

• phpstan/phpstan: ^1.8
• roave/security-advisories: dev-latest
• thecodingmachine/safe: ^2.0

Suggests

• thecodingmachine/safe

MIT

README

Set de reglas opinadas para php-cs-fixer.

En caso de usar thecodingmachine/safe, se agregará automáticamente una regla para agregar los imports provistos por Safe.

Instalación

composer require --dev josecl/php-cs-fixer-custom-fixers

Uso

En tu archivo de configuración de PHP Coding Standards Fixer (usualmente .php-cs-fixer.dist.php), en vez de instanciar PhpCsFixer\Config deberás usar Josecl\PhpCsFixerCustomFixers\CustomConfig, el cual ya tendrá definido el set de reglas.

<?php

use Josecl\PhpCsFixerCustomFixers\CustomConfig;

$finder = Symfony\Component\Finder\Finder::create()
    ->in([
        __DIR__ . '/app',
        __DIR__ . '/config',
        // etc...
    ])
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return (new CustomConfig())->setFinder($finder);

Puedes personalizar el set de reglas mediante el parámetro extraRules:

return (new CustomConfig(extraRules: [
    'yoda_style' => ['equal' => true],
    // ...
]))->setFinder($finder);