A set of custom fixers for PHP CS Fixer.
PHP CS Fixer: custom fixers can be installed by running:
composer require --dev kubawerlos/php-cs-fixer-custom-fixersIn your PHP CS Fixer configuration register fixers and use them:
<?php return PhpCsFixer\Config::create() + ->registerCustomFixers(new PhpCsFixerCustomFixers\Fixers()) ->setRules([ '@PSR2' => true, 'array_syntax' => ['syntax' => 'short'], + PhpCsFixerCustomFixers\Fixer\NoLeadingSlashInGlobalNamespaceFixer::name() => true, + PhpCsFixerCustomFixers\Fixer\PhpdocNoSuperfluousParamFixer::name() => true, ]);Comments must be surrounded by spaces.
<?php -/*foo*/ +/* foo */The configured functions must be commented out. Risky: when any of the configured functions have side effects or are overwritten. Configuration options:
functions(array): list of functions to comment out; defaults to['print_r', 'var_dump', 'var_export']
<?php -var_dump($x); +//var_dump($x);Constructor's empty braces must be single line.
<?php class Foo { public function __construct( $param1, $param2 - ) { - } + ) {} }Data provider names used only once must match the name of the test. Risky: when relying on name of data provider function. Configuration options:
prefix(string): prefix that replaces "test"; defaults to'provide'suffix(string): suffix to be added at the end"; defaults to'Cases'
<?php class FooTest extends TestCase { /** - * @dataProvider dataProvider + * @dataProvider provideSomethingCases */ public function testSomething($expected, $actual) {} - public function dataProvider() {} + public function provideSomethingCases() {} }The types returned by data providers must be iterable. Risky: when relying on signature of data provider.
<?php class FooTest extends TestCase { /** * @dataProvider provideSomethingCases */ public function testSomething($expected, $actual) {} - public function provideSomethingCases(): array {} + public function provideSomethingCases(): iterable {} }Data providers must be static.
<?php class FooTest extends TestCase { /** * @dataProvider provideSomethingCases */ public function testSomething($expected, $actual) {} - public function provideSomethingCases() {} + public static function provideSomethingCases() {} }Declare statement must be placed in the same line, after opening tag.
-<?php +<?php declare(strict_types=1); $foo; -declare(strict_types=1); $bar;Classes defined internally by extension or core must be referenced with the correct case.
<?php -$foo = new STDClass(); +$foo = new stdClass();Function array_key_exists must be used over isset when possible. Risky: when array is not defined, is multi-dimensional or behaviour is relying on the null value.
<?php -if (isset($array[$key])) { +if (array_key_exists($key, $array)) { echo $array[$key]; }Multiline comments or PHPDocs must contain an opening and closing line with no additional content.
<?php -/** Hello +/** + * Hello * World! */;Constructor having promoted properties must have them in separate lines.
<?php class Foo { - public function __construct(private array $a, private bool $b, private int $i) {} + public function __construct( + private array $a, + private bool $b, + private int $i + ) {} }There can be no commented out code.
<?php -//var_dump($_POST); print_r($_POST);There can be no comments generated by Doctrine Migrations.
<?php namespace Migrations; use Doctrine\DBAL\Schema\Schema; -/** - * Auto-generated Migration: Please modify to your needs! - */ final class Version20180609123456 extends AbstractMigration { public function up(Schema $schema) { - // this up() migration is auto-generated, please modify it to your needs $this->addSql("UPDATE t1 SET col1 = col1 + 1"); } public function down(Schema $schema) { - // this down() migration is auto-generated, please modify it to your needs $this->addSql("UPDATE t1 SET col1 = col1 - 1"); } }There can be no duplicate array keys. Configuration options:
ignore_expressions(bool): whether to keep duplicated expressions (as they might return different values) or not; defaults totrue
<?php $x = [ - "foo" => 1, "bar" => 2, "foo" => 3, ];There can be no duplicate use statements.
<?php namespace FooBar; use Foo; -use Foo; use Bar;There can be no imports from the global namespace.
<?php namespace Foo; -use DateTime; class Bar { - public function __construct(DateTime $dateTime) {} + public function __construct(\DateTime $dateTime) {} }Classes in the global namespace cannot contain leading slashes.
<?php -$x = new \Foo(); +$x = new Foo(); namespace Bar; $y = new \Baz();There can be no nullable boolean types. Risky: when the null is used.
<?php -function foo(?bool $bar) : ?bool +function foo(bool $bar) : bool { return $bar; }There can be no comments generated by PhpStorm.
<?php -/** - * Created by PhpStorm. - * User: root - * Date: 01.01.70 - * Time: 12:00 - */ namespace Foo;There must be no parameters with reference in funcion methods. Risky: when rely on reference.
<?php -function foo(&$x) {} +function foo($x) {}There should be no superfluous concatenation of strings. Configuration options:
allow_preventing_trailing_spaces(bool): whether to keep concatenation if it prevents having trailing spaces in string; defaults tofalse
<?php -echo 'foo' . 'bar'; +echo 'foobar';There must be no useless comments.
<?php /** - * Class Foo * Class to do something */ class Foo { /** - * Get bar */ function getBar() {} }Function dirname call must be removed if not needed.
<?php -require dirname(__DIR__) . "/vendor/autoload.php"; +require __DIR__ . "/../vendor/autoload.php";There can be no comments generated by Doctrine ORM.
<?php -/** - * FooRepository - * - * This class was generated by the Doctrine ORM. Add your own custom - * repository methods below. - */ class FooRepository extends EntityRepository {}There must be no useless parentheses.
<?php -foo(($bar)); +foo($bar);The strlen or mb_strlen functions should not be compared against 0. Risky: when the function strlen is overridden.
<?php -$isEmpty = strlen($string) === 0; -$isNotEmpty = strlen($string) > 0; +$isEmpty = $string === ''; +$isNotEmpty = $string !== '';Numeric literals must have configured separators. Configuration options:
binary(bool,null): whether add, remove or ignore separators in binary numbers.; defaults tofalsedecimal(bool,null): whether add, remove or ignore separators in decimal numbers.; defaults tofalsefloat(bool,null): whether add, remove or ignore separators in float numbers.; defaults tofalsehexadecimal(bool,null): whether add, remove or ignore separators in hexadecimal numbers.; defaults tofalseoctal(bool,null): whether add, remove or ignore separators in octal numbers.; defaults tofalse
<?php -echo 0b01010100_01101000; // binary -echo 135_798_642; // decimal -echo 1_234.456_78e-4_321; // float -echo 0xAE_B0_42_FC; // hexadecimal -echo 0123_4567; // octal +echo 0b0101010001101000; // binary +echo 135798642; // decimal +echo 1234.45678e-4321; // float +echo 0xAEB042FC; // hexadecimal +echo 01234567; // octalPHPUnit assertions must have expected argument before actual one. Risky: when original PHPUnit methods are overwritten.
<?php class FooTest extends TestCase { public function testFoo() { - self::assertSame($value, 10); + self::assertSame(10, $value); } }PHPUnit assertions like assertCount and assertInstanceOf must be used over assertEquals/assertSame. Risky: when original PHPUnit methods are overwritten.
<?php class FooTest extends TestCase { public function testFoo() { - self::assertSame($size, count($elements)); - self::assertSame($className, get_class($object)); + self::assertCount($size, $elements); + self::assertInstanceOf($className, $object); } }PHPUnit fail, markTestIncomplete and markTestSkipped functions should not be followed directly by return. Risky: when original PHPUnit methods are overwritten.
<?php class FooTest extends TestCase { public function testFoo() { $this->markTestSkipped(); - return; } }Generic array style should be used in PHPDoc.
<?php /** - * @return int[] + * @return array<int> */ function foo() { return [1, 2]; }The @var annotations must be used correctly in code.
<?php -/** @var Foo $foo */ $bar = new Foo();There must be no superfluous parameters in PHPDoc.
<?php /** * @param bool $b - * @param int $i * @param string $s this is string - * @param string $s duplicated */ function foo($b, $s) {}Only the listed annotations are allowed in PHPDoc. Configuration options:
elements(array): list of annotations to keep in PHPDoc; defaults to[]
<?php /** * @author John Doe - * @package foo - * @subpackage bar * @version 1.0 */ function foo_bar() {}The @param annotations must be in the same order as the function parameters.
<?php /** + * @param int $a * @param int $b - * @param int $a * @param int $c */ function foo($a, $b, $c) {}The @param annotations must have a type.
<?php /** * @param string $foo - * @param $bar + * @param mixed $bar */ function a($foo, $bar) {}In PHPDoc, the class or interface element self should be preferred over the class name itself.
<?php class Foo { /** - * @var Foo + * @var self */ private $instance; }The @var annotations must be on a single line if they are the only content.
<?php class Foo { - /** - * @var string - */ + /** @var string */ private $name; }PHPDoc types must be trimmed.
<?php /** - * @param null | string $x + * @param null|string $x */ function foo($x) {}Converts @var annotations to assert calls when used in assignments.
<?php -/** @var string $x */ $x = getValue(); +assert(is_string($x));Constructor properties must be promoted if possible. Configuration options:
promote_only_existing_properties(bool): whether to promote only properties that are defined in class; defaults tofalse
<?php class Foo { - private string $bar; - public function __construct(string $bar) { - $this->bar = $bar; + public function __construct(private string $bar) { } }Statements not followed by a semicolon must be followed by a single space. Configuration options:
allow_linebreak(bool): whether to allow statement followed by linebreak; defaults tofalse
<?php -$foo = new Foo(); -echo$foo->bar(); +$foo = new Foo(); +echo $foo->bar();Statements not preceded by a line break must be preceded by a single space.
<?php -$foo =new Foo(); +$foo = new Foo();A class that implements the __toString () method must explicitly implement the Stringable interface.
<?php -class Foo +class Foo implements \Stringable { public function __toString() { return "Foo"; } }Request feature or report bug by creating issue.
Alternatively, fork the repo, develop your changes, regenerate README.md:
php .dev-tools/readme > README.mdmake sure all checks pass:
composer verifyand submit pull request.