symplify/coding-standard

Set of Symplify rules for PHP_CodeSniffer and PHP CS Fixer.

Maintainers

👁 TomasVotruba

Package info

github.com/symplify/coding-standard

pkg:composer/symplify/coding-standard

Statistics

Installs: 8 112 772

Dependents: 75

Suggesters: 2

Stars: 381

Open Issues: 0

13.1.1 2026-06-09 23:10 UTC

Requires

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT c2fdcdf091c7679c05a7bc3497f680a8c04b5494

This package is auto-updated.

Last update: 2026-06-10 12:45:28 UTC

README

👁 Downloads

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

They run best with ECS.


Install

composer require symplify/coding-standard symplify/easy-coding-standard --dev
  1. Register in ecs.php config:
 # ecs.php
 use Symplify\EasyCodingStandard\Config\ECSConfig;

 return ECSConfig::configure()
 ->withPreparedSets(symplify: true);
  1. And run:
# dry-run without changes
vendor/bin/ecs


# apply changes
vendor/bin/ecs --fix

23 Rules to Keep Your Code Clean

ArrayListItemNewlineFixer

Indexed PHP array item has to have one line per item

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

ArrayOpenerAndCloserNewlineFixer

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

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

BlankLineAfterStrictTypesFixer

Strict type declaration has to be followed by empty line

 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!

-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

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

Doc block malform rules

Single-task rules that each fix one kind of @param/@return/@var malform. They are registered together in the docblock set and all handle the @phpstan- and @psalm- prefixed variants of these tags.


AddMissingParamNameFixer

Add a missing variable name to a @param annotation

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

AddMissingVarNameFixer

Add a missing variable name to an inline @var annotation

-/** @var int */
+/** @var int $value */
 $value = 1000;

DoubleAsteriskInlineVarFixer

Use a double asterisk /** doc block for an inline @var comment

-/* @var int $variable */
+/** @var int $variable */
 $variable = 5;

FixParamNameTypoFixer

Fix a typo in the @param variable name to match the real argument

 /**
 * @param string $one
- * @param string $twoTypo
+ * @param string $two
 */
 function anotherFunction(string $one, string $two)
 {
 }

RemoveDeadParamFixer

Remove a dead @param line that has only a name and no type

 /**
 * @param string $name
- * @param $age
 */
 function withDeadParam(string $name, $age)
 {
 }

RemoveParamNameReferenceFixer

Remove the reference & from a @param variable name

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

RemoveSuperfluousReturnNameFixer

Remove a superfluous variable name from a @return annotation

 /**
- * @return int $value
+ * @return int
 */
 function function1(): int
 {
 }

RemoveSuperfluousVarNameFixer

Remove a superfluous variable name from a property @var annotation

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

SingleLineInlineVarDocBlockFixer

Collapse a multi-line inline @var doc block into a single line

-/**
- * @var int $value
- */
+/** @var int $value */
 $value = 1000;

SwitchedTypeAndNameFixer

Reorder switched type and variable name in @param/@var annotation

 /**
- * @param $a string
- * @param $b string|null
+ * @param string $a
+ * @param string|null $b
 */
 function test($a, string $b = null): string
 {
 }

RemovePropertyVariableNameDescriptionFixer

Remove docblock descriptions which duplicate their property name

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

RemoveMethodNameDuplicateDescriptionFixer

Remove docblock descriptions which duplicate their method name

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

RemovePHPStormAnnotationFixer

Remove "Created by PhpStorm" annotations

-/**
- * 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 SomeClass
- */
 class SomeClass
 {
- /**
- * SomeClass Constructor.
- */
 public function __construct()
 {
- // TODO: Change the autogenerated stub
- // TODO: Implement whatever() method.
 }
 }

It also removes "Class representing XY" comments:

-/**
- * Class representing TeamPlayer
- */
 class TeamPlayer
 {
 }

Comments that only repeat the class name are removed:

-/**
- * TeamPlayer
- */
 class TeamPlayer
 {
 }

As well as the default doc block generated by the Doctrine ORM:

-/**
- * This class was generated by the Doctrine ORM. Add your own custom
- * repository methods below.
- */
 class SomeRepository
 {
 }

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

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

StandaloneLineConstructorParamFixer

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

 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

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

StandaloneLinePromotedPropertyFixer

Promoted property should be on standalone line

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