php cs fixer custom fixers
v3.22.0
Набор пользовательских исправлений для фиксатора PHP CS.
PHP CS Fixer: Custom Fixers можно установить с помощью работы:
composer require --dev kubawerlos/php-cs-fixer-custom-fixersВ ваших фиксаторах регистрации конфигурации фиксатора PHP CS и используйте их:
<?php
return (new PhpCsFixerConfig())
+ ->registerCustomFixers(new PhpCsFixerCustomFixersFixers())
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
+ PhpCsFixerCustomFixersFixerNoLeadingSlashInGlobalNamespaceFixer::name() => true,
+ PhpCsFixerCustomFixersFixerPhpdocNoSuperfluousParamFixer::name() => true,
]);php-cs-fixer/shim , требуется начальная загрузка для загрузки классов PhpCsFixerCustomFixers :
require __DIR__ . ' /vendor/kubawerlos/php-cs-fixer-custom-fixers/bootstrap.php ' ;Комментарии должны быть окружены пространствами.
<?php
- /*foo*/
+ /* foo */ Настроенные функции должны быть прокомментированы. Рискованно: когда любая из настроенных функций имеет побочные эффекты или перезаписывается. Параметры конфигурации:
functions ( array ): список функций для комментариев; по умолчанию ['print_r', 'var_dump', 'var_export'] <?php
- var_dump($x);
+ //var_dump($x); Пустые брекеты конструктора должны быть на одной линии.
<?php
class Foo {
public function __construct(
$param1,
$param2
- ) {
- }
+ ) {}
} Имена поставщиков данных должны соответствовать имени теста. Установите: используйте php_unit_data_provider_name вместо этого. Рискованно: применительно на имя функции поставщика данных. Параметры конфигурации:
prefix ( string ): префикс, который заменяет «тест»; по умолчанию 'provide'suffix ( string ): суффикс, который должен быть добавлен в конце "; по умолчанию 'Cases' <?php
class FooTest extends TestCase {
/**
- * @dataProvider dataProvider
+ * @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function dataProvider() {}
+ public function provideSomethingCases() {}
} Возвратный тип поставщика данных PHPUNIT должен быть iterable . Установите: используйте php_unit_data_provider_return_type вместо этого. Рискованно: когда полагается на подпись поставщика данных.
<?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases(): array {}
+ public function provideSomethingCases(): iterable {}
} Поставщики данных должны быть статичными. Установите: используйте php_unit_data_provider_static . Рискованно: когда force установлена на true . Параметры конфигурации:
force ( bool ): сделать ли поставщики статических данных с динамическими вызовами классов; по умолчанию false <?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases() {}
+ public static function provideSomethingCases() {}
}Заявление об объявлении для строгих типов должно быть размещено на той же строке после открывающей теги.
- <?php
+ <?php declare(strict_types=1);
$foo;
- declare(strict_types=1);
$bar; Тело пустого функции должно быть сокращено как {} и размещено на той же линии, что и предыдущий символ, разделенный пространством.
<?php function foo(
int $x
- )
- {
- }
+ ) {} Классы, определяемые внутри расширения или ядра, должны быть направлены с правильным случаем. Установите: используйте вместо этого class_reference_name_casing .
<?php
- $foo = new STDClass();
+ $foo = new stdClass(); Функция array_key_exists должен использоваться вместо isset , когда это возможно. Рискованно: когда массив не определен, многомерное, или поведение зависит от нулевого значения.
<?php
- if (isset($array[$key])) {
+ if (array_key_exists($key, $array)) {
echo $array[$key];
}Многослойные комментарии или PHPDOC должны содержать открывающуюся и закрывающую строку без дополнительного контента.
<?php
- /** Hello
+ /**
+ * Hello
* World!
*/Пропагандируемые свойства должны быть на отдельных линиях. Параметры конфигурации:
keep_blank_lines ( bool ): хранить пустые линии между свойствами; по умолчанию falseminimum_number_of_parameters ( int ): минимальное количество параметров в конструкторе для исправления; по умолчанию 1 <?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
+ ) {}
}Там не должно быть прокомментировано код.
<?php
- //var_dump($_POST);
print_r($_POST);Не должно быть никаких комментариев, сгенерированных миграциями доктрины.
<?php
namespace Migrations;
use DoctrineDBALSchemaSchema;
- /**
- * 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");
}
}Там не должно быть дублирующих клавиш массива. Параметры конфигурации:
ignore_expressions ( bool ): сохранять дублированные выражения (как они могут возвращать разные значения) или нет; по умолчанию к true <?php
$x = [
- "foo" => 1,
"bar" => 2,
"foo" => 3,
]; Там не должно быть никаких дублирующих операторов use .
<?php
namespace FooBar;
use Foo;
- use Foo;
use Bar;Не должно быть импорта из глобального пространства имен.
<?php
namespace Foo;
- use DateTime;
class Bar {
- public function __construct(DateTime $dateTime) {}
+ public function __construct(DateTime $dateTime) {}
}Занятия в глобальном пространстве имен не могут содержать ведущие черты.
<?php
- $x = new Foo();
+ $x = new Foo();
namespace Bar;
$y = new Baz();Там не должно быть нулевых логических типов. Рискованно: когда используется ноль.
<?php
- function foo(?bool $bar) : ?bool
+ function foo(bool $bar) : bool
{
return $bar;
}Не должно быть никаких комментариев, сгенерированных Phpstorm.
<?php
- /**
- * Created by PhpStorm.
- * User: root
- * Date: 01.01.70
- * Time: 12:00
- */
namespace Foo;Не должно быть никаких параметров, передаваемых по ссылке в функциях. Рискованно: когда полагайтесь на ссылку.
<?php
- function foo(&$x) {}
+ function foo($x) {} Не должно быть лишнего объединения буквальных струн. Параметры конфигурации:
allow_preventing_trailing_spaces ( bool ): СОДЕРЖАТЬ, СОДЕРЖАТЬ СООТВЕТСТВУЮЩИЙ, если она предотвращает наличие пробелов в строке; по умолчанию falsekeep_concatenation_for_different_quotes ( bool ): сохранять конкатенацию, если будет объединено одноцитированное и двойное цитирование; по умолчанию false <?php
- echo 'foo' . 'bar';
+ echo 'foobar'; Список элементов, записанный на одной строке, не может содержать запятую.
<?php
- $x = ['foo', 'bar', ];
+ $x = ['foo', 'bar']; Не должно быть бесполезных комментариев.
<?php
/**
- * Class Foo
* Class to do something
*/
class Foo {
/**
- * Get bar
*/
function getBar() {}
} Не должно быть dirname вызовов.
<?php
- require dirname(__DIR__) . "/vendor/autoload.php";
+ require __DIR__ . "/../vendor/autoload.php"; Не может быть никаких комментариев, сгенерированных доктриной Ормом.
<?php
- /**
- * FooRepository
- *
- * This class was generated by the Doctrine ORM. Add your own custom
- * repository methods below.
- */
class FooRepository extends EntityRepository {}Не должно быть бесполезных скобок.
<?php
- foo(($bar));
+ foo($bar); Функции strlen и mb_strlen нельзя сравнивать с 0. рискованно: когда функция strlen переопределяется.
<?php
- $isEmpty = strlen($string) === 0;
- $isNotEmpty = strlen($string) > 0;
+ $isEmpty = $string === '';
+ $isNotEmpty = $string !== ''; Числовые литералы должны были настроить разделители. Установите: используйте вместо этого numeric_literal_separator . Параметры конфигурации:
binary ( bool , null ): добавить, удалить или игнорировать разделители в двоичных числах.; по умолчанию falsedecimal ( bool , null ): добавлять, удалить или игнорировать разделители в десятичных числах.; по умолчанию falsefloat ( bool , null ): добавить, удалить или игнорировать разделители в числах сплавания.; по умолчанию falsehexadecimal ( bool , null ): добавлять, удалить или игнорировать разделители в шестнадцатеричных числах.; по умолчанию falseoctal ( bool , null ): добавлять, удалить или игнорировать разделители в восьми числах.; по умолчанию false <?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 Утверждения PHPUNIT должны иметь ожидаемый аргумент до фактического. Рискованно: когда оригинальные методы фпунита перезаписаны.
<?php
class FooTest extends TestCase {
public function testFoo() {
- self::assertSame($value, 10);
+ self::assertSame(10, $value);
}
} Утверждения PHPUNIT, такие как assertCount и assertInstanceOf должны использоваться над assertEquals / assertSame . Рискованно: когда оригинальные методы фпунита перезаписаны.
<?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 и markTestSkipped Функции не должны непосредственно следовать return . Рискованно: когда оригинальные методы фпунита перезаписаны.
<?php
class FooTest extends TestCase {
public function testFoo() {
$this->markTestSkipped();
- return;
}
} Общий стиль массива должен использоваться в PHPDOC. Установите: используйте phpdoc_array_type вместо этого.
<?php
/**
- * @return int[]
+ * @return array<int>
*/
function foo() { return [1, 2]; } Аннотации @var должны быть правильно использованы в коде.
<?php
- /** @var Foo $foo */
$bar = new Foo();В PHPDOC не должно быть лишних параметров.
<?php
/**
* @param bool $b
- * @param int $i
* @param string $s this is string
- * @param string $s duplicated
*/
function foo($b, $s) {}Только перечисленные аннотации разрешены в PHPDOC. Параметры конфигурации:
elements ( array ): список аннотаций, чтобы сохранить в PHPDOC; по умолчанию [] <?php
/**
* @author John Doe
- * @package foo
- * @subpackage bar
* @version 1.0
*/
function foo_bar() {} Заказы всех аннотаций @param в Docblocks в соответствии с подписью метода. Установите: используйте phpdoc_param_order вместо этого.
<?php
/**
+ * @param int $a
* @param int $b
- * @param int $a
* @param int $c
*/
function foo($a, $b, $c) {} У аннотаций @param должны быть тип.
<?php
/**
* @param string $foo
- * @param $bar
+ * @param mixed $bar
*/
function a($foo, $bar) {} В PHPDOC класс или элемент интерфейса должен self вместо самого имени класса.
<?php
class Foo {
/**
- * @var Foo
+ * @var self
*/
private $instance;
} Аннотация @var должна быть на одной строке, если это единственный контент.
<?php
class Foo {
- /**
- * @var string
- */
+ /** @var string */
private $name;
} list типов PHPDOC должен использоваться вместо array без типа ключа. Умерен: используйте вместо этого phpdoc_list_type .
<?php
/**
- * @param array<string>
+ * @param list<string>
*/
function foo($x) {}Типы PHPDOC не должны предшествуют пробелы, и должны быть сменены одним пробелом.
- <?php /** @var array<int,string> */
+ <?php /** @var array<int, string> */ Типы PHPDOC должны быть обрезаны.
<?php
/**
- * @param null | string $x
+ * @param null|string $x
*/
function foo($x) {} Преобразует аннотации @var , чтобы assert вызовы при использовании в заданиях.
<?php
- /** @var string $x */
$x = getValue();
+ assert(is_string($x)); Свойства конструктора должны быть повышены, если это возможно. Параметры конфигурации:
promote_only_existing_properties ( bool ): продвигать только свойства, которые определены в классе; по умолчанию false <?php
class Foo {
- private string $bar;
- public function __construct(string $bar) {
- $this->bar = $bar;
+ public function __construct(private string $bar) {
}
}Пропагандируемые свойства должны быть объявлены как только для чтения. Рискованно: когда написана недвижимость.
<?php class Foo {
public function __construct(
- public array $a,
- public bool $b,
+ public readonly array $a,
+ public readonly bool $b,
) {}
}За утверждениями, за которыми не следует полуколон, должен сопровождаться одним пространством. Параметры конфигурации:
allow_linebreak ( bool ): разрешить ли утверждение, за которым следует LineBreak; по умолчанию false <?php
- $foo = new Foo();
- echo$foo->bar();
+ $foo = new Foo();
+ echo $foo->bar(); Заявлениям, не предшествующим разрыву линии, должно предшествовать одно пространство.
<?php
- $foo =new Foo();
+ $foo = new Foo(); Класс, который реализует метод __toString() должен явно реализовать Stringable интерфейс.
<?php
- class Foo
+ class Foo implements Stringable
{
public function __toString()
{
return "Foo";
}
}Запросите функцию или сообщите об ошибке, создав проблему.
В качестве альтернативы, разграбляйте репозиторий, совершите свои изменения и убедитесь, что все в порядке:
composer verifyи отправьте запрос на привлечение.
