A tool to automatically fix PHP Coding Standards issues https://cs.symfony.com/
Dariusz Ruminski
c704d13f56
DX: new config filename
|
3 years ago | |
|---|---|---|
| .github | 4 years ago | |
| dev-tools | 4 years ago | |
| doc | 3 years ago | |
| docker | 4 years ago | |
| src | 3 years ago | |
| tests | 3 years ago | |
| .composer-require-checker.json | 4 years ago | |
| .editorconfig | 4 years ago | |
| .gitattributes | 4 years ago | |
| .gitignore | 3 years ago | |
| .php-cs-fixer.dist.php | 3 years ago | |
| .php_cs.dist | 3 years ago | |
| .yamllint.yml | 4 years ago | |
| CHANGELOG.md | 3 years ago | |
| CONTRIBUTING.md | 4 years ago | |
| LICENSE | 4 years ago | |
| README.md | 4 years ago | |
| UPGRADE.md | 4 years ago | |
| benchmark.sh | 7 years ago | |
| box.json.dist | 4 years ago | |
| ci-integration.sh | 3 years ago | |
| composer.json | 3 years ago | |
| docker-compose.override.yaml.dist | 4 years ago | |
| docker-compose.yaml | 4 years ago | |
| logo.md | 4 years ago | |
| logo.png | 4 years ago | |
| php-cs-fixer | 4 years ago | |
| phpmd.xml | 4 years ago | |
| phpstan.neon | 3 years ago | |
| phpunit.xml.dist | 4 years ago |
README.md
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.