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
- PHP 7.4
- PHP 8.0
- PHP 8.1
- PHP 8.2
- PHP 8.3
- PHP 8.4
Note
Each new PHP version requires a huge effort to support the new syntax.
That\’s why the latest PHP version might not be supported yet. If you need it,
please, consider supporting the project in any convenient way, for example
with code contribution or reviewing existing PRs. To run PHP CS Fixer on yet
unsupported versions \”at your own risk\” – use--allow-unsupported-php-version=yesoption.
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 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
Dedicated plugins exist for:
- NetBeans
- PhpStorm
- Sublime Text
- Vim
- VS Code
Community
The PHP CS Fixer is maintained on GitHub at https://*git*hub*.com/PHP-CS-Fixer/PHP-CS-Fixer.
Bug reports and ideas about new features are welcome there.
You can reach us in the GitHub Discussions regarding the
project, configuration, possible improvements, ideas and questions. Please visit us there!
Contribute
The tool comes with quite a few built-in fixers, but everyone is more than
welcome to contribute more of them.
