phpstan bodyscan

Phpstan Bodyscan

• Apakah Anda ingin melihat sekilas kualitas kode proyek baru?
• Apakah Anda ingin tahu, level phpstan apa yang terbaik untuk proyek Anda?
• Apakah Anda ingin tahu, berapa banyak kesalahan yang Anda hadapi per level untuk melihat seberapa sulit untuk mencapai mereka?

Dapatkan jumlah kesalahan untuk setiap level phpstan!

Bagaimana cara kerjanya?

Pertama, kami melihat root proyek untuk file phpstan.neon .

• Jika ditemukan, kami menggunakannya kembali.
• Jika tidak, kami mencari jalur kode sumber default seperti /src , /app , /tests , dll.

Kemudian kami menjalankan PHPSTAN untuk setiap level dari 0 hingga 8. Kami menghitung kesalahan dan menampilkannya dalam tabel.

Memasang

composer require tomasvotruba/phpstan-bodyscan --dev

Penggunaan

Jalankan alat di proyek Anda. Ini akan memakan waktu, karena akan menjalankan analisis phpstan penuh untuk setiap level.

vendor/bin/phpstan-bodyscan

↓

Untuk mendapatkan jumlah kesalahan per level:

+-------+-------------+-----------+
| Level | Error count | Increment |
+-------+-------------+-----------+
|     0 |           0 |         - |
|     1 |          35 |      + 35 |
|     2 |          59 |      + 24 |
|     3 |          59 |         - |
|     4 |         120 |      + 61 |
|     5 |         120 |         - |
|     6 |         253 |     + 133 |
|     7 |         350 |      + 97 |
|     8 |         359 |       + 9 |
+-------+-------------+----------- ; 

Apakah Anda ingin menjalankan level termasuk semua pesan yang diabaikan?

vendor/bin/phpstan-bodyscan --no-ignore

Apakah Anda ingin menjalankan level tanpa ekstensi?

vendor/bin/phpstan-bodyscan --bare

Apakah Anda memerlukan format JSON?

Kami membuat Anda tertutup:

vendor/bin/phpstan-bodyscan --json

↓

[
    {
        " level " : 0,
        " error_count " : 0,
        " increment_count " : 0
    },
    {
        " level " : 1,
        " error_count " : 5,
        " increment_count " : 5
    },
    {
        " level " : 2,
        " error_count " : 25,
        " increment_count " : 20
    }
]

Jumlah level batas

Apakah Anda hanya tertarik pada beberapa level? Anda dapat membatasi rentang dengan opsi:

vendor/bin/phpstan-bodyscan run --min-level 0 --max-level 3

Ukur Cakupan Jenis

Eksperimental!

Apakah Anda tertarik untuk belajar Param, pengembalian dan jenis deklarasi Jenis Properti Proyek?

Jalankan perintah type-coverage ↓

vendor/bin/phpstan-bodyscan type-coverage --json

↓

[
    {
        " category ": "param type",
        "relative_covered": 100 ,
        "total_count": 54
    },
    {
        "category": "property type",
        "relative_covered": 100 ,
        "total_count": 1
    },
    {
        "category": "return type",
        "relative_covered": 100 ,
        "total_count": 33
    },
    {
        "category": "strict declares",
        "relative_covered": 100 ,
        " total_count": 18
    }
]

Berdasarkan paket tipe-penutupan.

Muat file env

Beberapa proyek perlu memuat file .env untuk menjalankan phpstan. Anda bisa melakukannya seperti ini:

vendor/bin/phpstan-bodyscan run --env-file some-parameters.env

Debugging

Menjalankan Phpstan pada proyek baru yang tidak Anda ketahui mungkin macet. Untuk menyimpan data dari level jadi, kami membuangnya ke file bodyscan-log.txt .

Jika run macet karena alasan apa pun, output kesalahan phpstan juga dibuang ke file yang sama.

Happy Coding!