spiral/code-style

Code style and static analysis tools rulesets collection

v1.0.6 2021-08-24 16:18 UTC

Requires

• php: >=7.2
• friendsofphp/php-cs-fixer: ^2.15
• squizlabs/php_codesniffer: ^3.5

Requires (Dev)

• phpunit/phpunit: ^8.4

MIT

• Aleksandr Novikov

README

This repository contains ruleset for static analyses tools. Currently supported:

• PHP_CodeSniffer
• PHP CS Fixer

Current codestyle is PSR-12.

PHP Codesniffer ruleset is located in config/ruleset.xml.

PHP CS Fixer ruleset is located in config/.php_cs

To apply it in your project do the following:

Install the package

composer require --dev spiral/code-style

Check the code

#vendor/bin/spiral-cs check <dir1> <dir2> <file1>....
vendor/bin/spiral-cs check src tests

Automatically fix the code style

#vendor/bin/spiral-cs fix <dir1> <dir2> <file1>....
vendor/bin/spiral-cs fix src tests