phpstan bodyscan

Phpstan Bodyscan

• Вы хотите быстро увидеть качество нового кода проекта?
• Вы хотите знать, какой уровень 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 и DECLARATION PROPECT TIPE DECLARATION проекта?

Запустить команду 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

Некоторые проекты должны загружать файл .env для запуска PHPSTAN. Вы можете сделать это так:

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

Отладка

Запуск PHPSTAN в новом проекте, который вы не знаете, может разбиться. Чтобы сохранить данные с готовых уровней, мы сбрасываем их в файл bodyscan-log.txt .

Если прогон сбоятся по какой -либо причине, выходной выход PHPSTAN также отбрасывается в тот же файл.

Счастливого кодирования!