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

Dariusz Rumiński 079341d13b solve TODO 1 год назад
.github d795b4b5dc optionally support type/devs, depends on https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/pull/7304 1 год назад
dev-tools 445df272f8 feat: Introduce `LongToShorthandOperatorFixer` (#7295) 1 год назад
doc b9602e93bf feat(`@PER-CS2.0`): Add `concat_space` to the ruleset (#7302) 1 год назад
docker ca23bbbfed minor: Use single Dockerfile with multiple build targets (#6840) 1 год назад
src b9602e93bf feat(`@PER-CS2.0`): Add `concat_space` to the ruleset (#7302) 1 год назад
tests 079341d13b solve TODO 1 год назад
.composer-require-checker.json 3bfe42676d Test on PHP 8.1 3 лет назад
.editorconfig 734f765913 DX: do not nest ".editorconfig" files (#7112) 1 год назад
.gitattributes 98640cd33c DX: exclude Dockerfile from dist (#7113) 1 год назад
.gitignore 3a8e4609ca DX: PHPStan improvements (#6868) 1 год назад
.php-cs-fixer.dist.php 59314204fe feat(@PhpCsFixer:risky): add static_lambda rule (#7237) 1 год назад
.php-cs-fixer.php-highest.php 38728f554f DX: enable `HeredocIndentationFixer` for the codebase (#7195) 1 год назад
.php-cs-fixer.php-lowest.php fd5d09309d DX: use numeric_literal_separator (#6766) 1 год назад
.yamllint.yml 4543492603 Drop CircleCI and AppVeyor 4 лет назад
CHANGELOG.md e73ccaae12 prepared the 3.27.0 release 1 год назад
CONTRIBUTING.md 512d32250b DX: Improve contributing guide (#7241) 1 год назад
Dockerfile 9fc23918c2 DX: [Docker] Distinguish Alpine version between PHP versions (#7105) 1 год назад
LICENSE 94c4dbb7af docs: drop license end year (#6767) 1 год назад
README.md ccdefeb72e docs: Add information about installing Fixer as dev dependency (#7129) 1 год назад
UPGRADE-v3.md 61e6165eb4 docs: Update GitHub org 2 лет назад
benchmark.sh ab538a47e7 DX: chmod +x for benchmark.sh file 2 лет назад
box.json.dist fb4d4e0f8a Fix file missing for php8 3 лет назад
ci-integration.sh c704d13f56 DX: new config filename 3 лет назад
composer.json ca99f36591 DX: add Composer script for applying CS fixes in parallel (#7274) 1 год назад
docker-compose.override.yaml.dist 7ac5fae629 minor: PHP8.2 Docker runtime (#6833) 1 год назад
docker-compose.yaml e80a95b602 DX: Bump XDebug version in Docker services (#7300) 1 год назад
feature-or-bug.rst e39f17cc01 docs: feature or bug (#6652) 2 лет назад
logo.md 94c4dbb7af docs: drop license end year (#6767) 1 год назад
logo.png 1d01692483 Rework documentation 4 лет назад
php-cs-fixer 3607c6b473 DX: officially enable 8.2 support (#6825) 1 год назад
phpstan.dist.neon f3f35bda66 DX: Introduce Composer scripts as common DX (#6839) 1 год назад
phpunit.xml.dist f1d8235aa6 DX: Update PHPUnit config (#6566) 2 лет назад

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.

Supported PHP Versions

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" - leverage the PHP_CS_FIXER_IGNORE_ENV.

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 -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

Or using the main composer.json:

composer require --dev 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/PHP-CS-Fixer/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.