Repository files navigation

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 yourcode, you know that fixing them by hand is tedious, especially on largeprojects. 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 byPHP-FIG's PER Coding Style -@PER-CS,a wide community like theSymfony -@Symfony,or our opinionated one -@PhpCsFixer.You can also define your (team's) style through theconfiguration file.

PHP CS Fixer can not only unify the style of your code, but also help to modernise your codebase towardsnewer 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.

• PHP 7.4 - PHP 8.5

The recommended way to install PHP CS Fixer is to useComposer:

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), seeinstallation instructions.

Assuming you installed PHP CS Fixer as instructed above, you caninitialise 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

Seeusage, list ofbuilt-in rules, list ofrule setsandconfiguration file documentation for more details.

If you need to apply code styles that are not built-in into the tool, you cancreate custom rules.

Native support exists for:

• PhpStorm

Community plugins exist for:

• NetBeans
• Sublime Text
• Vim
• VS Code

The PHP CS Fixer is maintained on GitHub athttps://github.com/PHP-CS-Fixer/PHP-CS-Fixer.Contributions, bug reports and ideas about new features are welcome there.

You can reach us in theGitHub Discussions regarding theproject, configuration, possible improvements, ideas and questions.

The tool comes with quite a few built-in fixers, but everyone is more thanwelcome tocontribute more of them.