fsevestre/php-cs-fixer-config

PHP CS Fixer config

php-cs-fixer-config

PHP CS Fixer config., _(*1)

Installation

Run:, _(*2)

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

Usage

Configuration

Create a configuration file .php_cs in the root of your project:, _(*3)

<?php

$config = new FSevestre\CS\Config\PhpXX();

$config->getFinder()
    ->in([
        __DIR__.'/src'
    ])->exclude([
        'tests'
    ])
;

return $config;

Git

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

vendor/
.php_cs.cache

Makefile

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

# Coding Style

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

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

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

Fixing issues

If you need to check issues locally, run:, _(*6)

$ make cs

If you need to fix issues locally, run:, _(*7)

$ make cs-fix

In your Continuous Integration, run:, _(*8)

$ make cs-ci

Credits

Inspired by m6web/php-cs-fixer-config., _(*9)

License

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