A tool to automatically fix PHP Coding Standards issues https://cs.symfony.com/

Dariusz Ruminski c704d13f56 DX: new config filename 3 лет назад
.github 9f54f1bfcd DX: Test that Transformers are adding only CustomTokens that they define and nothing else 4 лет назад
dev-tools 9f536ed049 DX: update checkbashisms 4 лет назад
doc c704d13f56 DX: new config filename 3 лет назад
docker 3adc81b7b0 DX: Add Docker dev setup 4 лет назад
src c704d13f56 DX: new config filename 3 лет назад
tests c704d13f56 DX: new config filename 3 лет назад
.composer-require-checker.json 9f54f1bfcd DX: Test that Transformers are adding only CustomTokens that they define and nothing else 4 лет назад
.editorconfig fc50e3f3e0 DX: cleanup Github Actions configs 4 лет назад
.gitattributes 3adc81b7b0 DX: Add Docker dev setup 4 лет назад
.gitignore c704d13f56 DX: new config filename 3 лет назад
.php-cs-fixer.dist.php c704d13f56 DX: new config filename 3 лет назад
.php_cs.dist c704d13f56 DX: new config filename 3 лет назад
.yamllint.yml 4543492603 Drop CircleCI and AppVeyor 4 лет назад
CHANGELOG.md e0f6d05c8b prepared the 2.18.5 release 3 лет назад
CONTRIBUTING.md 3adc81b7b0 DX: Add Docker dev setup 4 лет назад
LICENSE 9991b0b68b Update LICENSE 4 лет назад
README.md 3031bf58a2 Rework documentation 4 лет назад
UPGRADE.md afaf95958d Merge branch '2.16' 4 лет назад
benchmark.sh af0cb08a08 Use "set -eu" in shell scripts 7 лет назад
box.json.dist fb4d4e0f8a Fix file missing for php8 4 лет назад
ci-integration.sh c704d13f56 DX: new config filename 3 лет назад
composer.json 81a5c170f2 Merge branch '2.18' 3 лет назад
docker-compose.override.yaml.dist 3adc81b7b0 DX: Add Docker dev setup 4 лет назад
docker-compose.yaml 3adc81b7b0 DX: Add Docker dev setup 4 лет назад
logo.md ee78b94b8a Add © for logo 4 лет назад
logo.png 1d01692483 Rework documentation 4 лет назад
php-cs-fixer 37a9611956 Fix runtime check of PHP version 4 лет назад
phpmd.xml d187410494 Do not allow assignments in if statements 4 лет назад
phpstan.neon c75d8e8d73 DX: use ::class whenever possible 3 лет назад
phpunit.xml.dist 324929f23e Add PHP8 integration test 4 лет назад

README.md

PHP CS Fixer logo

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.

Documentation

Installation

The recommended way to install PHP CS Fixer is to use Composer in a dedicated composer.json file in your project, for example in the tools/php-cs-fixer directory:

$ 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.

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:

$ tools/php-cs-fixer/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:

Community

The PHP CS Fixer is maintained on GitHub at https://github.com/FriendsOfPHP/PHP-CS-Fixer. Bug reports and ideas about new features are welcome there.

You can reach us at https://gitter.im/PHP-CS-Fixer/Lobby about the project, configuration, possible improvements, ideas and questions, please visit us!

Contribute

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