PHP Coding Standards Fixer¶
The PHP Coding Standards Fixer (PHP CS Fixer) fixes your code to follow the standards.
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 not only detects them, but also fixes them for you.
PHP CS Fixer has built-in rule sets, whether you want to follow PHP coding standards as defined by PHP-FIG’s PER Coding Style, a wide community like the Symfony, or our opinionated one. You can also define your (team’s) style through the configuration file.
PHP CS Fixer can not only unify the style of your code, but also help to modernize your codebase towards newer PHP (e.g. @PHP85Migration) and newer PHPUnit (e.g. @PHPUnit91Migration:risky).
Supported PHP Versions¶
PHP 7.4 - PHP 8.4
Documentation¶
Installation¶
The recommended way to install PHP CS Fixer is to use Composer:
$ composer require --dev friendsofphp/php-cs-fixer
$ ## or when facing conflicts in dependencies:
$ composer require --dev php-cs-fixer/shim
For more details and other installation methods (also with Docker or behind CI), see installation instructions.
Usage¶
Assuming you installed PHP CS Fixer as instructed above, you can run
the following command to fix the files PHP files in the src directory:
$ ./vendor/bin/php-cs-fixer fix src
See usage, list of built-in rules, list of rule sets and configuration file documentation for more details.
If you need to apply code styles that are not supported by the tool, you can create custom rules.
Editor Integration¶
Native support exists for:
Dedicated plugins exist for:
Community¶
The PHP CS Fixer is maintained on GitHub at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Contributions, 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.
Who is behind the PHP Coding Standards Fixer?¶
The PHP Coding Standards Fixer is brought to you by Fabien Potencier, the creator of the Symfony framework, and Dariusz Rumiński. It is released under the MIT license.