PHP CS Fixer: custom fixers
, (*1)
, (*2)
A set of custom fixers for PHP CS Fixer., (*3)
Installation
PHP CS Fixer: custom fixers can be installed by running:, (*4)
composer require --dev kubawerlos/php-cs-fixer-custom-fixers
Usage
In your PHP CS Fixer configuration register fixers and use them:, (*5)
<?php
return (new PhpCsFixer\Config())
+ ->registerCustomFixers(new PhpCsFixerCustomFixers\Fixers())
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
+ PhpCsFixerCustomFixers\Fixer\NoLeadingSlashInGlobalNamespaceFixer::name() => true,
+ PhpCsFixerCustomFixers\Fixer\PhpdocNoSuperfluousParamFixer::name() => true,
]);
:warning: When PHP CS Fixer is installed via php-cs-fixer/shim package,
requiring bootstrap may be needed to load PhpCsFixerCustomFixers classes:, (*6)
require __DIR__ . '/vendor/kubawerlos/php-cs-fixer-custom-fixers/bootstrap.php';
Fixers
Comments must be surrounded by spaces., (*7)
<?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'], (*8)
<?php
-var_dump($x);
+//var_dump($x);
ConstructorEmptyBracesFixer
Constructor's empty braces must be on a single line., (*9)
<?php
class Foo {
public function __construct(
$param1,
$param2
- ) {
- }
+ ) {}
}
DataProviderNameFixer
Data provider names must match the name of the test.
DEPRECATED: use php_unit_data_provider_name instead.
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', (*10)
<?php
class FooTest extends TestCase {
/**
- * @dataProvider dataProvider
+ * @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function dataProvider() {}
+ public function provideSomethingCases() {}
}
DataProviderReturnTypeFixer
The return type of PHPUnit data provider must be iterable.
DEPRECATED: use php_unit_data_provider_return_type instead.
Risky: when relying on signature of data provider., (*11)
<?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases(): array {}
+ public function provideSomethingCases(): iterable {}
}
DataProviderStaticFixer
Data providers must be static.
DEPRECATED: use php_unit_data_provider_static instead.
Risky: when force is set to true.
Configuration options:
- force (bool): whether to make static data providers having dynamic class calls; defaults to false, (*12)
<?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases() {}
+ public static function provideSomethingCases() {}
}
DeclareAfterOpeningTagFixer
Declare statement for strict types must be placed on the same line, after the opening tag., (*13)
-<?php
+<?php declare(strict_types=1);
$foo;
-declare(strict_types=1);
$bar;
EmptyFunctionBodyFixer
Empty function body must be abbreviated as {} and placed on the same line as the previous symbol, separated with a space., (*14)
<?php function foo(
int $x
-)
-{
-}
+) {}
InternalClassCasingFixer
Classes defined internally by an extension or the core must be referenced with the correct case.
DEPRECATED: use class_reference_name_casing instead., (*15)
<?php
-$foo = new STDClass();
+$foo = new stdClass();
IssetToArrayKeyExistsFixer
Function array_key_exists must be used instead of isset when possible.
Risky: when array is not defined, is multi-dimensional or behaviour is relying on the null value., (*16)
<?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., (*17)
<?php
-/** Hello
+/**
+ * Hello
* World!
*/
Promoted properties must be on separate lines.
Configuration options:
- keep_blank_lines (bool): whether to keep blank lines between properties; defaults to false
- minimum_number_of_parameters (int): minimum number of parameters in the constructor to fix; defaults to 1, (*18)
<?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 must be no commented out code., (*19)
<?php
-//var_dump($_POST);
print_r($_POST);
There must be no comments generated by Doctrine Migrations., (*20)
<?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");
}
}
NoDuplicatedArrayKeyFixer
There must be no duplicate array keys.
Configuration options:
- ignore_expressions (bool): whether to keep duplicated expressions (as they might return different values) or not; defaults to true, (*21)
<?php
$x = [
- "foo" => 1,
"bar" => 2,
"foo" => 3,
];
NoDuplicatedImportsFixer
There must be no duplicate use statements., (*22)
<?php
namespace FooBar;
use Foo;
-use Foo;
use Bar;
NoImportFromGlobalNamespaceFixer
There must be no imports from the global namespace., (*23)
<?php
namespace Foo;
-use DateTime;
class Bar {
- public function __construct(DateTime $dateTime) {}
+ public function __construct(\DateTime $dateTime) {}
}
NoLeadingSlashInGlobalNamespaceFixer
Classes in the global namespace cannot contain leading slashes., (*24)
<?php
-$x = new \Foo();
+$x = new Foo();
namespace Bar;
$y = new \Baz();
NoNullableBooleanTypeFixer
There must be no nullable boolean types.
Risky: when the null is used., (*25)
<?php
-function foo(?bool $bar) : ?bool
+function foo(bool $bar) : bool
{
return $bar;
}
There must be no comments generated by PhpStorm., (*26)
<?php
-/**
- * Created by PhpStorm.
- * User: root
- * Date: 01.01.70
- * Time: 12:00
- */
namespace Foo;
NoReferenceInFunctionDefinitionFixer
There must be no parameters passed by reference in functions.
Risky: when rely on reference., (*27)
<?php
-function foo(&$x) {}
+function foo($x) {}
NoSuperfluousConcatenationFixer
There must be no superfluous concatenation of literal strings.
Configuration options:
- allow_preventing_trailing_spaces (bool): whether to keep concatenation if it prevents having trailing spaces in string; defaults to false
- keep_concatenation_for_different_quotes (bool): whether to keep concatenation if single-quoted and double-quoted would be concatenated; defaults to false, (*28)
<?php
-echo 'foo' . 'bar';
+echo 'foobar';
NoTrailingCommaInSinglelineFixer
An element list written on one line cannot contain a trailing comma., (*29)
<?php
-$x = ['foo', 'bar', ];
+$x = ['foo', 'bar'];
There must be no useless comments., (*30)
<?php
/**
- * Class Foo
* Class to do something
*/
class Foo {
/**
- * Get bar
*/
function getBar() {}
}
NoUselessDirnameCallFixer
There must be no useless dirname calls., (*31)
<?php
-require dirname(__DIR__) . "/vendor/autoload.php";
+require __DIR__ . "/../vendor/autoload.php";
There can be no comments generated by Doctrine ORM., (*32)
<?php
-/**
- * FooRepository
- *
- * This class was generated by the Doctrine ORM. Add your own custom
- * repository methods below.
- */
class FooRepository extends EntityRepository {}
NoUselessParenthesisFixer
There must be no useless parentheses., (*33)
<?php
-foo(($bar));
+foo($bar);
NoUselessStrlenFixer
Functions strlen and mb_strlen must not be compared to 0.
Risky: when the function strlen is overridden., (*34)
<?php
-$isEmpty = strlen($string) === 0;
-$isNotEmpty = strlen($string) > 0;
+$isEmpty = $string === '';
+$isNotEmpty = $string !== '';
NumericLiteralSeparatorFixer
Numeric literals must have configured separators.
DEPRECATED: use numeric_literal_separator instead.
Configuration options:
- binary (bool, null): whether add, remove or ignore separators in binary numbers.; defaults to false
- decimal (bool, null): whether add, remove or ignore separators in decimal numbers.; defaults to false
- float (bool, null): whether add, remove or ignore separators in float numbers.; defaults to false
- hexadecimal (bool, null): whether add, remove or ignore separators in hexadecimal numbers.; defaults to false
- octal (bool, null): whether add, remove or ignore separators in octal numbers.; defaults to false, (*35)
<?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; // octal
PhpUnitAssertArgumentsOrderFixer
PHPUnit assertions must have expected argument before actual one.
Risky: when original PHPUnit methods are overwritten., (*36)
<?php
class FooTest extends TestCase {
public function testFoo() {
- self::assertSame($value, 10);
+ self::assertSame(10, $value);
}
}
PhpUnitDedicatedAssertFixer
PHPUnit assertions like assertCount and assertInstanceOf must be used over assertEquals/assertSame.
Risky: when original PHPUnit methods are overwritten., (*37)
<?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);
}
}
PhpUnitNoUselessReturnFixer
PHPUnit fail, markTestIncomplete and markTestSkipped functions must not be directly followed by return.
Risky: when original PHPUnit methods are overwritten., (*38)
<?php
class FooTest extends TestCase {
public function testFoo() {
$this->markTestSkipped();
- return;
}
}
PhpdocArrayStyleFixer
Generic array style should be used in PHPDoc.
DEPRECATED: use phpdoc_array_type instead., (*39)
<?php
/**
- * @return int[]
+ * @return array<int>
*/
function foo() { return [1, 2]; }
PhpdocNoIncorrectVarAnnotationFixer
The @var annotations must be used correctly in code., (*40)
<?php
-/** @var Foo $foo */
$bar = new Foo();
PhpdocNoSuperfluousParamFixer
There must be no superfluous parameters in PHPDoc., (*41)
<?php
/**
* @param bool $b
- * @param int $i
* @param string $s this is string
- * @param string $s duplicated
*/
function foo($b, $s) {}
PhpdocOnlyAllowedAnnotationsFixer
Only the listed annotations are allowed in PHPDoc.
Configuration options:
- elements (array): list of annotations to keep in PHPDoc; defaults to [], (*42)
<?php
/**
* @author John Doe
- * @package foo
- * @subpackage bar
* @version 1.0
*/
function foo_bar() {}
PhpdocParamOrderFixer
Orders all @param annotations in DocBlocks according to method signature.
DEPRECATED: use phpdoc_param_order instead., (*43)
<?php
/**
+ * @param int $a
* @param int $b
- * @param int $a
* @param int $c
*/
function foo($a, $b, $c) {}
PhpdocParamTypeFixer
The @param annotations must have a type., (*44)
<?php
/**
* @param string $foo
- * @param $bar
+ * @param mixed $bar
*/
function a($foo, $bar) {}
PhpdocSelfAccessorFixer
In PHPDoc, the class or interface element self must be used instead of the class name itself., (*45)
<?php
class Foo {
/**
- * @var Foo
+ * @var self
*/
private $instance;
}
PhpdocSingleLineVarFixer
The @var annotation must be on a single line if it is the only content., (*46)
<?php
class Foo {
- /**
- * @var string
- */
+ /** @var string */
private $name;
}
PhpdocTypeListFixer
PHPDoc type list must be used instead of array without a key type.
DEPRECATED: use phpdoc_list_type instead., (*47)
<?php
/**
- * @param array<string>
+ * @param list<string>
*/
function foo($x) {}
PhpdocTypesCommaSpacesFixer
PHPDoc types commas must not be preceded by a whitespace, and must be succeeded by a single whitespace., (*48)
-<?php /** @var array<int,string> */
+<?php /** @var array<int, string> */
PhpdocTypesTrimFixer
PHPDoc types must be trimmed., (*49)
<?php
/**
- * @param null | string $x
+ * @param null|string $x
*/
function foo($x) {}
PhpdocVarAnnotationToAssertFixer
Converts @var annotations to assert calls when used in assignments., (*50)
<?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 to false, (*51)
<?php
class Foo {
- private string $bar;
- public function __construct(string $bar) {
- $this->bar = $bar;
+ public function __construct(private string $bar) {
}
}
Promoted properties must be declared as read-only.
Risky: when property is written., (*52)
<?php class Foo {
public function __construct(
- public array $a,
- public bool $b,
+ public readonly array $a,
+ public readonly bool $b,
) {}
}
SingleSpaceAfterStatementFixer
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 to false, (*53)
<?php
-$foo = new Foo();
-echo$foo->bar();
+$foo = new Foo();
+echo $foo->bar();
SingleSpaceBeforeStatementFixer
Statements not preceded by a line break must be preceded by a single space., (*54)
<?php
-$foo =new Foo();
+$foo = new Foo();
StringableInterfaceFixer
A class that implements the __toString() method must explicitly implement the Stringable interface., (*55)
<?php
-class Foo
+class Foo implements \Stringable
{
public function __toString()
{
return "Foo";
}
}
Contributing
Request a feature or report a bug by creating an issue., (*56)
Alternatively, fork the repository, commit your changes, and make sure everything is fine:, (*57)
composer verify
and submit a pull request., (*58)
Wallogit.com
