spiral / code-style

Code-Style sniffer and fixer rules and CLI command

Codestyle presets for Spiral components

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

code-style's Issues

Check command has bad formatting

Error description contains only 1 word per line, example:

FILE: ...ycle\ProxyFactory\tests\Promise\ProxyPrinter\Fixtures\Entity.php
----------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------
LINE 16: WARNING Property
                 name
                 "$__resolver"
                 should
                 not
                 be
                 prefixed
                 with
                 an
                 underscore
                 to
                 indicate
                 visibility
----------------------------------------------------------------------
   14:      public static $publicStatic;
   15:      protected $protected;
>> 16:      protected $__resolver;
   17:      private $private = null;
   18:
----------------------------------------------------------------------
Time: 4.38 secs; Memory: 10MB

Ability to define own cs config file

Now you have problem with PHP-cs-fixer - wrong config file name - Configuration file .php_cs is outdated, rename to .php-cs-fixer.php..
You can avoid this problem if command will have some option for config file

Is it possible?

Add new option like --exclude

Sometimes it can be required to check directory but skip some directory or file

It will be useful for libs with some generated code (in case of vendor lib generates code with some problems for example)