phpstan bodyscan

phpstanボディスカン

• 新しいプロジェクトコードの品質をすばやく垣間見たいですか？
• あなたは知りたいですか、あなたのプロジェクトに最適なphpstanレベルは何ですか？
• レベルごとに直面しているエラーの量を知りたいですか？

phpstanレベルごとにエラーカウントを取得します！

どのように機能しますか？

まず、 phpstan.neonファイルのプロジェクトルートを調べます。

• 見つかった場合、私たちはそれを再利用します。
• そうでない場合は、 /src 、 /app 、 /testsなどのデフォルトのソースコードパスを探します。

次に、各レベルのPHPSTANを0〜8に実行します。エラーをカウントし、テーブルに表示します。

インストール

composer require tomasvotruba/phpstan-bodyscan --dev

使用法

プロジェクトでツールを実行します。各レベルで完全なPHPSTAN分析を実行するため、時間がかかります。

vendor/bin/phpstan-bodyscan

↓

レベルごとにエラーカウントを取得するには：

+-------+-------------+-----------+
| 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 |
+-------+-------------+----------- ; 

すべての無視されたメッセージを含むレベルを実行したいですか？

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

拡張機能なしでレベルを実行しますか？

vendor/bin/phpstan-bodyscan --bare

JSON形式が必要ですか？

私たちはあなたをカバーしました：

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
    }
]

制限レベルカウント

いくつかのレベルだけに興味がありますか？オプションで範囲を制限できます。

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

タイプカバレッジを測定します

実験的！

プロジェクトのParam、Return、およびProperty Typeの宣言範囲を学ぶことに興味がありますか？

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
    }
]

タイプカバーパッケージに基づいています。

envファイルをロードします

一部のプロジェクトは、phpstanを実行するために.envファイルをロードする必要があります。あなたはこのようにそれをすることができます：

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

デバッグ

あなたが知らない新しいプロジェクトでphpstanを実行する可能性があるかもしれない。完成したレベルからデータを保存するために、それらをbodyscan-log.txtファイルにダンプします。

何らかの理由で実行がクラッシュする場合、PHPSTANエラー出力も同じファイルに投棄されます。

ハッピーコーディング！