2017 © Pedro Peláez
 

library coding-standard

Set of Symplify rules for PHP_CodeSniffer and PHP CS Fixer.

image

symplify/coding-standard

Set of Symplify rules for PHP_CodeSniffer and PHP CS Fixer.

  • PHP
  • 15 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 100 Versions
  • 39 % Grown

The README.md

Coding Standard

Downloads, (*1)

Set of rules for PHP_CodeSniffer and PHP-CS-Fixer used by Symplify projects., (*2)

They run best with EasyCodingStandard., (*3)


, (*4)

Install

composer require symplify/coding-standard --dev
composer require symplify/easy-coding-standard --dev
  1. Run with ECS:
# ecs.php
 use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;

 return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->sets([SetList::SYMPLIFY]);


, (*5)

12 Rules Overview

ArrayListItemNewlineFixer

Indexed PHP array item has to have one line per item, (*6)

-$value = ['simple' => 1, 'easy' => 2];
+$value = ['simple' => 1,
+'easy' => 2];


, (*7)

ArrayOpenerAndCloserNewlineFixer

Indexed PHP array opener [ and closer ] must be on own line, (*8)

-$items = [1 => 'Hey'];
+$items = [
+1 => 'Hey'
+];


, (*9)

BlankLineAfterStrictTypesFixer

Strict type declaration has to be followed by empty line, (*10)

 declare(strict_types=1);
+
 namespace App;


, (*11)

LineLengthFixer

Array items, method parameters, method call arguments, new arguments should be on same/standalone line to fit line length., (*12)

:wrench: configure it!, (*13)

-function some($veryLong, $superLong, $oneMoreTime)
-{
+function some(
+    $veryLong,
+    $superLong,
+    $oneMoreTime
+) {
 }

-function another(
-    $short,
-    $now
-) {
+function another($short, $now) {
 }


, (*14)

MethodChainingNewlineFixer

Each chain method call must be on own line, (*15)

-$someClass->firstCall()->secondCall();
+$someClass->firstCall()
+->secondCall();


, (*16)

ParamReturnAndVarTagMalformsFixer

Fixes @param, @return, @var and inline @var annotations broken formats, (*17)

 /**
- * @param string
+ * @param string $name
  */
 function getPerson($name)
 {
 }


, (*18)

RemovePHPStormAnnotationFixer

Remove "Created by PhpStorm" annotations, (*19)

-/**
- * Created by PhpStorm.
- * User: ...
- * Date: 17/10/17
- * Time: 8:50 AM
- */
 class SomeClass
 {
 }


, (*20)

RemoveUselessDefaultCommentFixer

Remove useless PHPStorm-generated @todo comments, redundant "Class XY" or "gets service" comments etc., (*21)

-/**
- * class SomeClass
- */
 class SomeClass
 {
-    /**
-     * SomeClass Constructor.
-     */
     public function __construct()
     {
-        // TODO: Change the autogenerated stub
-        // TODO: Implement whatever() method.
     }
 }


, (*22)

SpaceAfterCommaHereNowDocFixer

Add space after nowdoc and heredoc keyword, to prevent bugs on PHP 7.2 and lower, see https://laravel-news.com/flexible-heredoc-and-nowdoc-coming-to-php-7-3, (*23)

 $values = [
     <<<RECTIFY
 Some content
-RECTIFY,
+RECTIFY
+,
     1000
 ];


, (*24)

StandaloneLineConstructorParamFixer

Constructor param should be on a standalone line to ease git diffs on new dependency, (*25)

 final class PromotedProperties
 {
-    public function __construct(int $age, string $name)
-    {
+    public function __construct(
+        int $age,
+        string $name
+    ) {
     }
 }


, (*26)

StandaloneLineInMultilineArrayFixer

Indexed arrays must have 1 item per line, (*27)

-$friends = [1 => 'Peter', 2 => 'Paul'];
+$friends = [
+    1 => 'Peter',
+    2 => 'Paul'
+];


, (*28)

StandaloneLinePromotedPropertyFixer

Promoted property should be on standalone line, (*29)

 final class PromotedProperties
 {
-    public function __construct(public int $age, private string $name)
-    {
+    public function __construct(
+        public int $age,
+        private string $name
+    ) {
     }
 }


, (*30)

The Versions

24/07 2018

dev-master

9999999-dev

Set of Symplify rules for PHP_CodeSniffer and PHP CS Fixer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/07 2018

v4.5.1

4.5.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

11/07 2018

v4.5.0

4.5.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/06 2018

v4.4.2

4.4.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/06 2018

v4.4.1

4.4.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/06 2018

v4.4.0

4.4.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

20/05 2018

v4.3.0

4.3.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

12/05 2018

v4.2.2

4.2.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

12/05 2018

v4.2.3

4.2.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

12/05 2018

v4.2.1

4.2.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/05 2018

v4.2.0

4.2.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/05 2018

v4.1.2

4.1.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

25/04 2018

v4.1.1

4.1.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/04 2018

v4.1.0

4.1.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/04 2018

v4.0.3

4.0.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/04 2018

v4.0.4

4.0.4.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/04 2018

v4.0.2

4.0.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/04 2018

v4.0.1

4.0.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/04 2018

v4.0.0alpha5

4.0.0.0-alpha5

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/04 2018

v4.0.0alpha6

4.0.0.0-alpha6

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/04 2018

v4.0.0beta1

4.0.0.0-beta1

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/04 2018

v4.0.0

4.0.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/04 2018

v4.0.0alpha4

4.0.0.0-alpha4

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/03 2018

dev-throwable-renderer-tests

dev-throwable-renderer-tests

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/03 2018

dev-vendor-param-in-imports

dev-vendor-param-in-imports

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/03 2018

dev-ecs-tester

dev-ecs-tester

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/03 2018

v4.0.0alpha3

4.0.0.0-alpha3

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

22/03 2018

v4.0.0alpha2

4.0.0.0-alpha2

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/03 2018

v4.0.0alpha1

4.0.0.0-alpha1

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/03 2018

v3.2.29

3.2.29.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/03 2018

v3.2.27

3.2.27.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/03 2018

v3.2.28

3.2.28.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/03 2018

v3.2.30

3.2.30.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

25/02 2018

v3.2.25

3.2.25.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

25/02 2018

v3.2.26

3.2.26.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2018

v3.2.21

3.2.21.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2018

v3.2.22

3.2.22.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2018

v3.2.23

3.2.23.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2018

v3.2.24

3.2.24.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/02 2018

v3.2.20

3.2.20.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/02 2018

v3.2.18

3.2.18.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.10

3.2.10.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.11

3.2.11.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.12

3.2.12.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.13

3.2.13.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.14

3.2.14.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.15

3.2.15.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/01 2018

v3.2.17

3.2.17.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/01 2018

v3.2.9

3.2.9.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

21/01 2018

v3.2.7

3.2.7.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

20/01 2018

v3.2.5

3.2.5.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

20/01 2018

v3.2.6

3.2.6.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

20/01 2018

v3.2.4

3.2.4.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

16/01 2018

v3.2.3

3.2.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/01 2018

v3.2.0

3.2.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/01 2018

v3.2.1

3.2.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/01 2018

v3.2.2

3.2.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/01 2018

v3.1.2

3.1.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/01 2018

v3.1.1

3.1.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/01 2018

v3.1.0

3.1.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/01 2018

2.5.x-dev

2.5.9999999.9999999-dev

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/01 2018

v2.5.12

2.5.12.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/12 2017

v3.0.7

3.0.7.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/12 2017

v3.0.8

3.0.8.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/12 2017

v3.0.5

3.0.5.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/12 2017

v3.0.6

3.0.6.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/12 2017

v3.0.4

3.0.4.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/12 2017

v3.0.3

3.0.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/12 2017

v3.0.2

3.0.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/12 2017

v3.0.1

3.0.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/12 2017

v3.0.0

3.0.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/12 2017

v3.0.0-RC5

3.0.0.0-RC5

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

04/12 2017

v2.5.10

2.5.10.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/12 2017

v3.0.0-RC4

3.0.0.0-RC4

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/11 2017

v3.0.0-RC3

3.0.0.0-RC3

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/11 2017

v3.0.0-RC2

3.0.0.0-RC2

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

12/11 2017

v3.0.0-RC1

3.0.0.0-RC1

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

27/10 2017

v2.5.9

2.5.9.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/10 2017

v2.5.8

2.5.8.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/10 2017

v2.5.7

2.5.7.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/10 2017

v2.5.6

2.5.6.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/10 2017

v2.5.4

2.5.4.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/10 2017

v2.5.5

2.5.5.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/10 2017

v2.5.3

2.5.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/10 2017

v2.5.2

2.5.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

08/10 2017

v2.5.0

2.5.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

08/10 2017

v2.5.1

2.5.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/10 2017

v2.4.3

2.4.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/09 2017

v2.4.2

2.4.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

20/09 2017

v2.4.1

2.4.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

19/09 2017

v2.4.0

2.4.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

16/09 2017

v2.3.4

2.3.4.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/09 2017

v2.3.3

2.3.3.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/09 2017

v2.3.2

2.3.2.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/09 2017

v2.3.1

2.3.1.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/09 2017

v2.3.0

2.3.0.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/09 2017

v2.2.15

2.2.15.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/09 2017

v2.2.14

2.2.14.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

31/08 2017

v2.2.13

2.2.13.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/08 2017

v2.2.11

2.2.11.0

Set of Symplify rules for PHP_CodeSniffer.

  Sources   Download

MIT

The Requires

 

The Development Requires