README

PHP-CS-Fixer Configurations

Description

This package provides a set PHP-Cs-Fixer configuration objects ready to be used in any project using PHP-Cs-Fixer.

Documentation

Available configuration objects:

• drupol\PhpCsFixerConfigsPhp\Config\PSR12
• drupol\PhpCsFixerConfigsPhp\Config\Php56
• drupol\PhpCsFixerConfigsPhp\Config\Php7
• drupol\PhpCsFixerConfigsPhp\Config\Php71
• drupol\PhpCsFixerConfigsPhp\Config\Php72
• drupol\PhpCsFixerConfigsPhp\Config\Php73

Each configuration object is an object implementing PhpCsFixer/ConfigInterface.

It provides a default configuration, mandatory to configure PHP CS Fixer.

It implements the method(s):

    public function withRulesFrom(...$configs);

Where the $configs parameters must implements PhpCsFixer/ConfigInterface.

Requirements

• PHP >= 7.4

Installation

composer require --dev drupol/phpcsfixer-configs-php

Usage

See the PHP CS Fixer documentation on how to use the configuration object.

Code quality, tests and benchmarks

Every time changes are introduced into the library, Github Actions run the tests and the benchmarks.

The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.

Before each commit some inspections are executed with GrumPHP, run ./vendor/bin/grumphp run to check manually.

PHPInfection is used to ensure that your code is properly tested, run composer infection to test your code.

Contributing

Feel free to contribute to this library by sending Github pull requests. I'm quite reactive :-)