Set of PHP-CS-Fixer rules used in the development of Ely.by PHP projects
Go to file
2023-03-23 03:36:47 +01:00
.github/workflows Fix GitHub Actions deprecation 2022-12-06 22:31:30 +01:00
src Fixes #12. Implemented Ely\align_multiline_parameters 2023-03-23 03:36:47 +01:00
tests/Fixer Fixes #12. Implemented Ely\align_multiline_parameters 2023-03-23 03:36:47 +01:00
.gitignore Migrate to PHP-CS-Fixer 3. Upgrade custom rules. Upgrade ruleset. 2022-09-20 02:50:21 +02:00
.php-cs-fixer.dist.php Migrate to PHP-CS-Fixer 3. Upgrade custom rules. Upgrade ruleset. 2022-09-20 02:50:21 +02:00
CHANGELOG.md Fixes #12. Implemented Ely\align_multiline_parameters 2023-03-23 03:36:47 +01:00
composer.json Fix fn spacing rule, upgrade to the latest PHP-CS-Fixer and add a new rule 2022-12-06 22:21:28 +01:00
composer.lock Fix fn spacing rule, upgrade to the latest PHP-CS-Fixer and add a new rule 2022-12-06 22:21:28 +01:00
LICENSE Update LICENSE year 2023-03-22 20:41:26 +01:00
phpunit.xml.dist Fix PHPUnit configuration 2023-03-22 14:03:19 +01:00
README.md Fixes #12. Implemented Ely\align_multiline_parameters 2023-03-23 03:36:47 +01:00

Ely.by PHP-CS-Fixer rules

Set of PHP-CS-Fixer rules used in development of Ely.by PHP projects. It's suited for PHP 7.4 and above. You can use it as a ready-made set of rules or just some of them.

Latest Version on Packagist Total Downloads Software License Build Status

Installation

First of all install Ely.by PHP-CS-Fixer rules via composer with PHP-CS-Fixer:

composer require --dev friendsofphp/php-cs-fixer ely/php-code-style

Then create a file .php-cs-fixer.php with the following contents:

<?php
$finder = \PhpCsFixer\Finder::create()
    ->in(__DIR__);

return \Ely\CS\Config::create()
    ->setFinder($finder);

And that's it. You can now find code style violations with following command:

vendor/bin/php-cs-fixer --diff --dry-run -v fix 

And then completely fix them all with:

vendor/bin/php-cs-fixer fix

Configuration

You can pass a custom set of rules to the \Ely\CS\Config::create() call. For example, it can be used to validate a project with PHP 7.4 compatibility:

<?php
return \Ely\CS\Config::create([
    'trailing_comma_in_multiline' => [
        'elements' => ['arrays', 'arguments'],
    ],
])->setFinder($finder);

Code style

Our code style is based primarily on PSR-2, while borrowing some ideas from PSR-12 with some changes.

Example

This example encompasses some of the rules below as a quick overview:

<?php
declare(strict_types=1);

namespace Vendor\Package;

use Vendor\Package\SomeNamespace\ClassA;

class Foo extends Bar implements FooInterface {
    use SomeTrait;

    private const SAMPLE_1 = 123;
    private const SAMPLE_2 = 321;

    public Typed $field1;

    public $field2;

    public function sampleFunction(
        int $a,
        private readonly int $b = null,
    ): array {
        if ($a === $this->b) {
            $result = bar();
        } else {
            $result = BazClass::bar($this->field1, $this->field2);
        }

        return $result;
    }

    public function setToNull(): self {
        $this->field1 = null;
        return $this;
    }

}

Key differences:

  • Opening braces for classes MUST be on the same line.

  • Opening braces for methods MUST be on the next line.

Additional rules:

  • There MUST be one empty line before return statement, except when there is only one statement before it.

    <?php
    
    function a() {
        $a = '123';
        return $a . ' is a number';
    }
    
    function b() {
        $a = '123';
        $b = 'is';
    
        return $a . ' ' . $b . ' a number';
    }
    
  • There MUST be one blank line around class body, but there MUST be no blank lines around anonymous class body.

    <?php
    class Test {
    
        public function method() {
            $obj = new class extends Foo {
                public function overriddenMethod() {
                    // code body
                }
            };
        }
    
    }
    
  • Visibility MUST be declared for all methods, properties and constants.

  • There MUST be one blank line after an each of if, switch, for, foreach, while and do-while bodies.

    <?php
    if (true) {
        // some actions here
    }
    
    echo 'the next statement is here';
    
  • There MUST be no alignment around multiline function parameters.

    <?php
    function foo(
        string $input,
        int $key = 0,
    ): void {}
    

Using our fixers

First of all, you must install Ely.by PHP-CS-Fixer package as described in the installation chapter. After that you can enable our custom fixers with registerCustomFixers method:

<?php
// Your Finder configuration

return \PhpCsFixer\Config::create()
    ->registerCustomFixers(new \Ely\CS\Fixers());

And then you'll be able to use our custom rules.

Ely/align_multiline_parameters

Forces aligned or not aligned multiline function parameters:

--- Original
+++ New
@@ @@
  function foo(
      string $string,
-     int $index = 0,
-     $arg = 'no type',
+     int    $index  = 0,
+            $arg    = 'no type',
  ): void {}

Configuration:

  • variables - when set to true, forces variables alignment. On false forces strictly no alignment. You can set it to null to disable touching of variables. Default: true.

  • defaults - when set to true, forces defaults alignment. On false forces strictly no alignment. You can set it to null to disable touching of defaults. Default: false.

Ely/blank_line_around_class_body

Ensure that a class body contains one blank line after its definition and before its end:

--- Original
+++ New
@@ @@
  <?php
  class Test {
+
      public function func() {
          $obj = new class extends Foo {
+
              public $prop;
+
          }
      }
+
  }

Configuration:

  • apply_to_anonymous_classes - should this fixer be applied to anonymous classes? If it is set to false, than anonymous classes will be fixed to don't have empty lines around body. Default: true.

  • blank_lines_count - adjusts an amount of the blank lines. Default: 1.

Ely/blank_line_before_return

This is extended version of the original blank_line_before_statement fixer. It applies only to return statements and only in cases, when on the current nesting level more than one statements.

--- Original
+++ New
@@ @@
 <?php
 public function foo() {
     $a = 'this';
     $b = 'is';
+
     return "$a $b awesome";
 }

 public function bar() {
     $this->foo();
     return 'okay';
 }

Ely/line_break_after_statements

Ensures that there is one blank line above the next statements: if, switch, for, foreach, while and do-while.

--- Original
+++ New
@@ @@
 <?php
 $a = 123;
 if ($a === 123) {
     // Do something here
 }
+
 $b = [1, 2, 3];
 foreach ($b as $number) {
     if ($number === 3) {
         echo 'it is three!';
     }
 }
+
 $c = 'next statement';

Ely/remove_class_name_method_usages (Yii2)

Replaces Yii2 BaseObject::className() usages with native ::class keyword, introduced in PHP 5.5.

--- Original
+++ New
@@ @@
  <?php
  use common\models\User;
  
- $className = User::className();
+ $className = User::class;