schwarzer/php-code-style

Schwarzer IT's shared PHP style rules for PHP-CS-Fixer

v3.0.0 2021-09-27 05:10 UTC

Requires

• php: ^7.4|^8.0
• friendsofphp/php-cs-fixer: ^3.0

Requires (Dev)

• roave/security-advisories: dev-master

MIT

README

Require this package.

composer require "schwarzer/php-code-style" --dev

Using this package

Create a PHP-CS-Fixer dist file.

touch .php-cs-fixer.dist.php

Minimum Setup

Add this to your .php-cs-fixer.dist.php file.

<?php

$classLoader = require __DIR__ . '/vendor/autoload.php';
$classLoader->register(true);

$rules = [
    // 'use-this-to-override' => 'the-default-rules',
];

$finder = PhpCsFixer\Finder::create()
    ->in([
        __DIR__.'/your/source/code',
    ]);

return (new Schwarzer\PhpCs\Styles)($finder, $rules);

Our Laravel Setup

<?php

$classLoader = require __DIR__ . '/vendor/autoload.php';
$classLoader->register(true);

$rules = [
    // 'use-this-to-override' => 'the-default-rules',
];

$finder = PhpCsFixer\Finder::create()
    ->notPath('bootstrap')
    ->notPath('storage')
    ->notPath('vendor')
    ->in(getcwd())
    ->name('*.php')
    ->notName('*.blade.php')
    ->notName('index.php')
    ->notName('server.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return (new Schwarzer\PhpCs\Styles)($finder, $rules);

Ready

You can now use php-cs-fixer as usual.

• php-cs-fixer fix --dry-run
• php-cs-fixer fix