symplify/coding-standardPublic

NotificationsYou must be signed in to change notification settings
Fork24
Star374

Coding Standard rules for PHP projects with focus on Clean Architecture

License

MIT license

374 stars 24 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 994 Commits
.github		.github
config		config
src		src
tests		tests
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json
ecs.php		ecs.php
phpstan.neon		phpstan.neon
phpunit.xml		phpunit.xml
rector.php		rector.php

Repository files navigation

Coding Standard

Coding standard rules for clean, consistent, and readable PHP code. No configuration needed—just install and let it handle the rest.

They run best withECS.

Install

composer require symplify/coding-standard --devcomposer require phpecs/phpecs --dev

# ecs.phpuseSymplify\EasyCodingStandard\Config\ECSConfig;useSymplify\EasyCodingStandard\ValueObject\Set\SetList;return ECSConfig::configure()     ->withSets([SetList::SYMPLIFY]);

And run:

# dry-run without changesvendor/bin/ecs# apply changesvendor/bin/ecs --fix

12 Rules to Keep Your Code Clean

ArrayListItemNewlineFixer

Indexed PHP array item has to have one line per item

class:Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer

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

ArrayOpenerAndCloserNewlineFixer

Indexed PHP array opener [ and closer ] must be on own line

class:Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer

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

BlankLineAfterStrictTypesFixer

Strict type declaration has to be followed by empty line

class:Symplify\CodingStandard\Fixer\Strict\BlankLineAfterStrictTypesFixer

 declare(strict_types=1);+ namespace App;

LineLengthFixer

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

🔧configure it!

class:Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer

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

MethodChainingNewlineFixer

Each chain method call must be on own line

class:Symplify\CodingStandard\Fixer\Spacing\MethodChainingNewlineFixer

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

ParamReturnAndVarTagMalformsFixer

Fixes @param, @return,@var and inline@var annotations broken formats

class:Symplify\CodingStandard\Fixer\Commenting\ParamReturnAndVarTagMalformsFixer

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

RemovePropertyVariableNameDescriptionFixer

Remove docblock descriptions which duplicate their property name

class:Symplify\CodingStandard\Fixer\Annotation\RemovePropertyVariableNameDescriptionFixer

 /**- * @var string $name+ * @var string  */ private $name;

RemoveMethodNameDuplicateDescriptionFixer

Remove docblock descriptions which duplicate their method name

class:Symplify\CodingStandard\Fixer\Annotation\RemoveRedundantDescriptionFixer

 /**- * Get name  *  * @return string  */ function getName() { }

RemovePHPStormAnnotationFixer

Remove "Created by PhpStorm" annotations

class:Symplify\CodingStandard\Fixer\Annotation\RemovePHPStormAnnotationFixer

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

RemoveUselessDefaultCommentFixer

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

class:Symplify\CodingStandard\Fixer\Commenting\RemoveUselessDefaultCommentFixer

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

SpaceAfterCommaHereNowDocFixer

Add space after nowdoc and heredoc keyword, to prevent bugs on PHP 7.2 and lower, seehttps://laravel-news.com/flexible-heredoc-and-nowdoc-coming-to-php-7-3

class:Symplify\CodingStandard\Fixer\Spacing\SpaceAfterCommaHereNowDocFixer

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

StandaloneLineConstructorParamFixer

Constructor param should be on a standalone line to ease git diffs on new dependency

class:Symplify\CodingStandard\Fixer\Spacing\StandaloneLineConstructorParamFixer

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

StandaloneLineInMultilineArrayFixer

Indexed arrays must have 1 item per line

class:Symplify\CodingStandard\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer

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

StandaloneLinePromotedPropertyFixer

Promoted property should be on standalone line

class:Symplify\CodingStandard\Fixer\Spacing\StandaloneLinePromotedPropertyFixer

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