README

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 - @PER-CS, a wide community like the Symfony - @Symfony, or our opinionated one - @PhpCsFixer. 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 modernise your codebase towards newer PHP (e.g. @autoPHPMigration and @autoPHPMigration:risky) and newer PHPUnit (e.g. @autoPHPUnitMigration:risky).

There are also @auto and @auto:risky that aim to provide good base rules.

Supported PHP Versions

• PHP 7.4 - PHP 8.5

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 contributions or reviewing existing PRs. To run PHP CS Fixer on yet unsupported versions "at your own risk" - use --allow-unsupported-php-version=yes option.

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 initialise base config for your project by using following command:

./vendor/bin/php-cs-fixer init

To automatically fix your project, or only check against the need of changes, run:

./vendor/bin/php-cs-fixer fix
./vendor/bin/php-cs-fixer check

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 built-in into the tool, you can create custom rules.

Editor Integration

Native support exists for:

• PhpStorm

Community plugins exist for:

• NetBeans
• Sublime Text
• Vim
• VS Code

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 in the GitHub Discussions regarding the project, configuration, possible improvements, ideas and questions.

Contribute

The tool comes with quite a few built-in fixers, but everyone is more than welcome to contribute more of them.