m6web/php-cs-fixer-config

PHP CS Fixer config for M6Web components

php-cs-fixer-config

PHP CS Fixer config for M6Web components., _(*1)

Installation

Run, _(*2)

$ composer require --dev m6web/php-cs-fixer-config

Usage

Configuration

Create a configuration file .php-cs-fixer.dist.php in the root of your project:, _(*3)

<?php

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

$config = new M6Web\CS\Config\BedrockStreaming();
$config->setFinder($finder);

return $config;

Custom configuration

You may extend these rules and apply your own extra rules., _(*4)

Create a configuration file .php-cs-fixer.dist.php in the root of your project:, _(*5)

<?php

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

$config = new class() extends PhpCsFixer\Config {
    public function __construct()
    {
        parent::__construct('customized Bedrock Streaming');
        $this->setRiskyAllowed(true);
    }

    public function getRules(): array
    {
        $rules = (new M6Web\CS\Config\BedrockStreaming())->getRules();

        // perform updates on the rules array here

        return $rules;
    }
};

$config->setFinder($finder);

return $config;

Git

Add .php-cs-fixer.cache (this is the cache file created by php-cs-fixer) to .gitignore:, _(*6)

vendor/
.php-cs-fixer.cache

Makefile

Create a Makefile with the targets below:, _(*7)

# Coding Style

cs:
    ./bin/php-cs-fixer fix --dry-run --stop-on-violation --diff

cs-fix:
    ./bin/php-cs-fixer fix

cs-ci:
    ./bin/php-cs-fixer fix --dry-run --using-cache=no --verbose

Fixing issues

Manually

If you need to check issues locally, just run, _(*8)

$ make cs

If you need to fix issues locally, just run, _(*9)

$ make cs-fix

In your Continuous Integration, run, _(*10)

$ make cs-ci

Credits

Developed by Bedrock Streaming, inspired by refinery29/php-cs-fixer-config., _(*11)

License

This project is licensed under the MIT license., _(*12)