rem42/php-cs-fixer-config

PHP CS Fixer config

3.4 2022-08-05 14:56 UTC

This package is auto-updated.

Last update: 2022-10-05 15:18:32 UTC


README

PHP CS Fixer config for M6Web components.

Installation

Run

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

Usage

Configuration

Create a configuration file .php-cs-fixer.dist.php in the root of your project:

<?php

$config = new Rem42\CS\Config\Config;
$config->getFinder()
    ->in(
        [
            __DIR__.'/src',
            __DIR__.'/tests',
        ]
    );

return $config;

Git

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

vendor/
.php-cs-fixer.cache

Makefile

Create a Makefile with the targets below:

# 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

$ make cs

If you need to fix issues locally, just run

$ make cs-fix

In your Continuous Integration, run

$ make cs-ci

Credits

Developed by Rémy BRUYERE (rem42), inspired by Bedrock Streaming.

License

This project is licensed under the MIT license.