xmarcos / php-cs-fixer-config
PHP Coding Standards Fixer Config
v0.1.0
2017-10-09 04:10 UTC
Requires
- php: ^5.6 || ^7.0
- friendsofphp/php-cs-fixer: ^2.7
Requires (Dev)
- phpunit/phpunit: ^5.7.19
This package is not auto-updated.
Last update: 2024-10-27 05:04:30 UTC
README
A PHP Coding Standards Fixer
config with the rules i use in all my projects to verify and enforce coding standards.
Requirements
PHP needs to be a minimum version of PHP 5.6.0
.
Installation
composer require --dev xmarcos/php-cs-fixer-config
Usage
Create a configuration file .php_cs.dist
in the root of your project:
<?php $config = new xmarcos\PhpCsFixer\Config\Php56(); $config ->setUsingCache(true) ->getFinder() ->in(__DIR__); return $config;
⚠️ If
setUsingCache
is set totrue
, add.php_cs.cache
to.gitignore
.
The default Finder configuration is:
$finder ->files() ->name('*.php') ->name('*.phpt') ->ignoreDotFiles(true) ->ignoreVCS(true) ->exclude('vendor');
To enforce a header_comment
pass a string
to the constructor of the config:
$header = <<<'EOF' (c) 2017 Marcos Sader. For the full copyright and license information, please view the LICENSE file that was distributed with this source code. EOF; $config = new xmarcos\PhpCsFixer\Config\Php56($header); ...
Fixing Issues
Using Composer Scripts
You can use Composer Scripts to run the fixer:
"scripts": { "cs": "php-cs-fixer fix --config=.php_cs.dist -v --diff --dry-run", "cs-fix": "php-cs-fixer fix --config=.php_cs.dist -v --diff" }
And then run:
# to run the rules but not change/fix any files. composer cs # to change/fix files. composer cs-fix
Credits
Inspired by refinery29/php-cs-fixer-config.
License
MIT License