PHP Coding Standards Fixer¶
The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc., or other community driven ones like the Symfony one. You can also define your (team’s) style through configuration.
It can modernize your code (like converting the
pow function to the
** operator on PHP 5.6)
and (micro) optimize it.
If you are already using a linter to identify coding standards problems in your code, you know that fixing them by hand is tedious, especially on large projects. This tool does not only detect them, but also fixes them for you.
Supported PHP Versions¶
The recommended way to install PHP CS Fixer is to use
Composer in a dedicated
composer.json file in your project, for example in
$ mkdir --parents tools/php-cs-fixer
$ composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
For more details and other installation methods, see installation instructions.
Run with Docker¶
PHP CS Fixer can be run in a Docker container.
You can use pre-built Docker images to run
$FIXER_VERSION used in example above is an identifier of a release you want to use, which is based on Fixer and PHP versions combined. There are different tags for each Fixer’s SemVer level and PHP version with syntax
<php-cs-fixer-version>-php<php-version>. For example:
Assuming you installed PHP CS Fixer as instructed above, you can run
the following command to fix the files PHP files in the
$ tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
If you need to apply code styles that are not supported by the tool, you can create custom rules.
Native support exists for:
Dedicated plugins exist for:
The PHP CS Fixer is maintained on GitHub at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Bug reports and ideas about new features are welcome there.
You can reach us at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions about the project, configuration, possible improvements, ideas and questions, please visit us!