php cs fixer custom fixers
v3.22.0
Satu set fixer khusus untuk fixer PHP CS.
PHP CS Fixer: Pemecah kustom dapat diinstal dengan menjalankan:
composer require --dev kubawerlos/php-cs-fixer-custom-fixersDalam fixer register konfigurasi fixer php cs Anda dan menggunakannya:
<?php
return (new PhpCsFixerConfig())
+ ->registerCustomFixers(new PhpCsFixerCustomFixersFixers())
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
+ PhpCsFixerCustomFixersFixerNoLeadingSlashInGlobalNamespaceFixer::name() => true,
+ PhpCsFixerCustomFixersFixerPhpdocNoSuperfluousParamFixer::name() => true,
]);php-cs-fixer/shim , yang membutuhkan bootstrap mungkin diperlukan untuk memuat kelas PhpCsFixerCustomFixers :
require __DIR__ . ' /vendor/kubawerlos/php-cs-fixer-custom-fixers/bootstrap.php ' ;Komentar harus dikelilingi oleh ruang.
<?php
- /*foo*/
+ /* foo */ Fungsi yang dikonfigurasi harus dikomentari. Risiko: Ketika salah satu fungsi yang dikonfigurasi memiliki efek samping atau ditimpa. Opsi Konfigurasi:
functions ( array ): Daftar fungsi untuk dikomentari; default ke ['print_r', 'var_dump', 'var_export'] <?php
- var_dump($x);
+ //var_dump($x); Kawat gigi kosong konstruktor harus berada di satu baris.
<?php
class Foo {
public function __construct(
$param1,
$param2
- ) {
- }
+ ) {}
} Nama penyedia data harus sesuai dengan nama tes. Tercerahkan: Gunakan php_unit_data_provider_name sebagai gantinya. Risiko: Saat mengandalkan nama fungsi penyedia data. Opsi Konfigurasi:
prefix ( string ): awalan yang menggantikan "tes"; default untuk 'provide'suffix ( string ): Sufiks yang akan ditambahkan di akhir "; default ke 'Cases' <?php
class FooTest extends TestCase {
/**
- * @dataProvider dataProvider
+ * @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function dataProvider() {}
+ public function provideSomethingCases() {}
} Jenis pengembalian penyedia data phPunit harus dapat iterable . DESTRECATED: Gunakan php_unit_data_provider_return_type sebagai gantinya. Risiko: Saat mengandalkan tanda tangan penyedia data.
<?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases(): array {}
+ public function provideSomethingCases(): iterable {}
} Penyedia data harus statis. Tercerahkan: Gunakan php_unit_data_provider_static sebagai gantinya. Risiko: Ketika force diatur ke true . Opsi Konfigurasi:
force ( bool ): Apakah akan membuat penyedia data statis memiliki panggilan kelas dinamis; default ke false <?php
class FooTest extends TestCase {
/**
* @dataProvider provideSomethingCases
*/
public function testSomething($expected, $actual) {}
- public function provideSomethingCases() {}
+ public static function provideSomethingCases() {}
}Deklarasikan pernyataan untuk tipe ketat harus ditempatkan pada baris yang sama, setelah tag pembuka.
- <?php
+ <?php declare(strict_types=1);
$foo;
- declare(strict_types=1);
$bar; Tubuh fungsi kosong harus disingkat sebagai {} dan ditempatkan pada garis yang sama dengan simbol sebelumnya, dipisahkan dengan ruang.
<?php function foo(
int $x
- )
- {
- }
+ ) {} Kelas yang ditentukan secara internal oleh ekstensi atau inti harus dirujuk dengan kasus yang benar. Tercerahkan: Gunakan class_reference_name_casing sebagai gantinya.
<?php
- $foo = new STDClass();
+ $foo = new stdClass(); Function array_key_exists harus digunakan sebagai pengganti isset bila memungkinkan. Risiko: Ketika array tidak didefinisikan, adalah multi-dimensi atau perilaku mengandalkan nilai nol.
<?php
- if (isset($array[$key])) {
+ if (array_key_exists($key, $array)) {
echo $array[$key];
}Komentar multiline atau phpDocs harus berisi jalur pembukaan dan penutupan tanpa konten tambahan.
<?php
- /** Hello
+ /**
+ * Hello
* World!
*/Properti yang dipromosikan harus pada jalur terpisah. Opsi Konfigurasi:
keep_blank_lines ( bool ): Apakah akan menjaga garis kosong di antara properti; default ke falseminimum_number_of_parameters ( int ): Jumlah parameter minimum dalam konstruktor untuk memperbaiki; default ke 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
+ ) {}
}Tidak boleh ada kode yang dikomentari.
<?php
- //var_dump($_POST);
print_r($_POST);Tidak boleh ada komentar yang dihasilkan oleh migrasi doktrin.
<?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");
}
}Tidak boleh ada tombol array duplikat. Opsi Konfigurasi:
ignore_expressions ( bool ): Apakah akan menyimpan ekspresi duplikat (karena mereka mungkin mengembalikan nilai yang berbeda) atau tidak; default ke true <?php
$x = [
- "foo" => 1,
"bar" => 2,
"foo" => 3,
]; Tidak boleh ada pernyataan use duplikat.
<?php
namespace FooBar;
use Foo;
- use Foo;
use Bar;Tidak boleh ada impor dari namespace global.
<?php
namespace Foo;
- use DateTime;
class Bar {
- public function __construct(DateTime $dateTime) {}
+ public function __construct(DateTime $dateTime) {}
}Kelas -kelas di namespace global tidak dapat berisi tebasan terkemuka.
<?php
- $x = new Foo();
+ $x = new Foo();
namespace Bar;
$y = new Baz();Tidak boleh ada tipe Boolean yang dapat dibatalkan. Risiko: Saat nol digunakan.
<?php
- function foo(?bool $bar) : ?bool
+ function foo(bool $bar) : bool
{
return $bar;
}Tidak boleh ada komentar yang dihasilkan oleh phpstorm.
<?php
- /**
- * Created by PhpStorm.
- * User: root
- * Date: 01.01.70
- * Time: 12:00
- */
namespace Foo;Tidak boleh ada parameter yang disahkan dengan referensi dalam fungsi. Risiko: Saat mengandalkan referensi.
<?php
- function foo(&$x) {}
+ function foo($x) {} Tidak boleh ada gabungan yang berlebihan dari string literal. Opsi Konfigurasi:
allow_preventing_trailing_spaces ( bool ): apakah akan tetap menggabungkan jika mencegah memiliki spasi trailing di string; default ke falsekeep_concatenation_for_different_quotes ( bool ): Apakah akan menjaga gabungan jika dikutip tunggal dan dikutip ganda akan digabungkan; default ke false <?php
- echo 'foo' . 'bar';
+ echo 'foobar'; Daftar elemen yang ditulis pada satu baris tidak dapat berisi koma trailing.
<?php
- $x = ['foo', 'bar', ];
+ $x = ['foo', 'bar']; Tidak boleh ada komentar yang tidak berguna.
<?php
/**
- * Class Foo
* Class to do something
*/
class Foo {
/**
- * Get bar
*/
function getBar() {}
} Tidak boleh ada panggilan dirname yang tidak berguna.
<?php
- require dirname(__DIR__) . "/vendor/autoload.php";
+ require __DIR__ . "/../vendor/autoload.php"; Tidak ada komentar yang dihasilkan oleh Doctrine ORM.
<?php
- /**
- * FooRepository
- *
- * This class was generated by the Doctrine ORM. Add your own custom
- * repository methods below.
- */
class FooRepository extends EntityRepository {}Tidak boleh ada tanda kurung yang tidak berguna.
<?php
- foo(($bar));
+ foo($bar); Fungsi strlen dan mb_strlen tidak boleh dibandingkan dengan 0. Risiko: Ketika fungsi strlen diganti.
<?php
- $isEmpty = strlen($string) === 0;
- $isNotEmpty = strlen($string) > 0;
+ $isEmpty = $string === '';
+ $isNotEmpty = $string !== ''; Literal numerik harus memiliki pemisah yang dikonfigurasi. Tercerahkan: Gunakan numeric_literal_separator sebagai gantinya. Opsi Konfigurasi:
binary ( bool , null ): apakah menambah, menghapus atau mengabaikan pemisah dalam nomor biner.; default ke falsedecimal ( bool , null ): apakah menambah, menghapus atau mengabaikan pemisah dalam nomor desimal.; default ke falsefloat ( bool , null ): apakah menambah, menghapus atau mengabaikan pemisah dalam nomor float.; default ke falsehexadecimal ( bool , null ): apakah menambah, menghapus atau mengabaikan pemisah dalam nomor heksadesimal.; default ke falseoctal ( bool , null ): apakah menambah, menghapus atau mengabaikan pemisah dalam nomor oktal.; default ke 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 Pernyataan phpunit harus memiliki argumen yang diharapkan sebelum yang sebenarnya. Risiko: Ketika metode phpunit asli ditimpa.
<?php
class FooTest extends TestCase {
public function testFoo() {
- self::assertSame($value, 10);
+ self::assertSame(10, $value);
}
} Pernyataan Phpunit seperti assertCount dan assertInstanceOf harus digunakan atas assertEquals / assertSame . Risiko: Ketika metode phpunit asli ditimpa.
<?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 dan markTestSkipped Functions tidak boleh langsung diikuti dengan return . Risiko: Ketika metode phpunit asli ditimpa.
<?php
class FooTest extends TestCase {
public function testFoo() {
$this->markTestSkipped();
- return;
}
} Gaya array generik harus digunakan dalam PHPDOC. Tercerahkan: Gunakan phpdoc_array_type sebagai gantinya.
<?php
/**
- * @return int[]
+ * @return array<int>
*/
function foo() { return [1, 2]; } Anotasi @var harus digunakan dengan benar dalam kode.
<?php
- /** @var Foo $foo */
$bar = new Foo();Tidak boleh ada parameter berlebihan di PHPDOC.
<?php
/**
* @param bool $b
- * @param int $i
* @param string $s this is string
- * @param string $s duplicated
*/
function foo($b, $s) {}Hanya anotasi yang terdaftar yang diizinkan dalam PHPDOC. Opsi Konfigurasi:
elements ( array ): Daftar anotasi untuk disimpan di PHPDOC; default ke [] <?php
/**
* @author John Doe
- * @package foo
- * @subpackage bar
* @version 1.0
*/
function foo_bar() {} Memesan semua anotasi @param di docblocks sesuai dengan tanda tangan metode. Tercerahkan: Gunakan phpdoc_param_order sebagai gantinya.
<?php
/**
+ * @param int $a
* @param int $b
- * @param int $a
* @param int $c
*/
function foo($a, $b, $c) {} Anotasi @param harus memiliki jenis.
<?php
/**
* @param string $foo
- * @param $bar
+ * @param mixed $bar
*/
function a($foo, $bar) {} Di PHPDOC, elemen kelas atau antarmuka self harus digunakan sebagai ganti nama kelas itu sendiri.
<?php
class Foo {
/**
- * @var Foo
+ * @var self
*/
private $instance;
} Anotasi @var harus berada pada satu baris jika itu adalah satu -satunya konten.
<?php
class Foo {
- /**
- * @var string
- */
+ /** @var string */
private $name;
} list Jenis PHPDOC harus digunakan sebagai pengganti array tanpa jenis kunci. Tercerahkan: Gunakan phpdoc_list_type sebagai gantinya.
<?php
/**
- * @param array<string>
+ * @param list<string>
*/
function foo($x) {}Jenis PHPDOC Commas tidak boleh didahului oleh spasi putih, dan harus digantikan oleh satu whitespace.
- <?php /** @var array<int,string> */
+ <?php /** @var array<int, string> */ Jenis PHPDOC harus dipangkas.
<?php
/**
- * @param null | string $x
+ * @param null|string $x
*/
function foo($x) {} Konversi anotasi @var untuk assert panggilan saat digunakan dalam penugasan.
<?php
- /** @var string $x */
$x = getValue();
+ assert(is_string($x)); Properti Konstruktor harus dipromosikan jika memungkinkan. Opsi Konfigurasi:
promote_only_existing_properties ( bool ): apakah akan mempromosikan hanya properti yang didefinisikan di kelas; default ke false <?php
class Foo {
- private string $bar;
- public function __construct(string $bar) {
- $this->bar = $bar;
+ public function __construct(private string $bar) {
}
}Properti yang dipromosikan harus dinyatakan sebagai baca saja. Risiko: Saat properti ditulis.
<?php class Foo {
public function __construct(
- public array $a,
- public bool $b,
+ public readonly array $a,
+ public readonly bool $b,
) {}
}Pernyataan yang tidak diikuti oleh titik koma harus diikuti oleh satu ruang. Opsi Konfigurasi:
allow_linebreak ( bool ): Apakah akan mengizinkan pernyataan yang diikuti oleh linebreak; default ke false <?php
- $foo = new Foo();
- echo$foo->bar();
+ $foo = new Foo();
+ echo $foo->bar(); Pernyataan yang tidak didahului oleh jeda garis harus didahului oleh satu ruang.
<?php
- $foo =new Foo();
+ $foo = new Foo(); Kelas yang mengimplementasikan metode __toString() harus secara eksplisit mengimplementasikan antarmuka Stringable .
<?php
- class Foo
+ class Foo implements Stringable
{
public function __toString()
{
return "Foo";
}
}Minta fitur atau laporkan bug dengan membuat masalah.
Atau, garpu repositori, lakukan perubahan Anda, dan pastikan semuanya baik -baik saja:
composer verifydan mengirimkan permintaan tarik.
