phpstan bodyscan

Phpstan Bodyscan

• Deseja ter uma rápida visão da qualidade do código do projeto?
• Você quer saber, qual nível de phpstan é o melhor para o seu projeto?
• Deseja saber quantos erros você está enfrentando por nível para ver como será difícil alcançá -los?

Obtenha a contagem de erros para cada nível do Phpstan!

Como funciona?

Primeiro, analisamos a raiz do projeto para o arquivo phpstan.neon .

• Se encontrado, reutilizamos.
• Caso contrário, procuramos os caminhos de código -fonte dos padrões como /src , /app , /tests etc.

Em seguida, executamos o Phpstan para cada nível de 0 a 8. Contamos erros e os exibimos em uma tabela.

Instalar

composer require tomasvotruba/phpstan-bodyscan --dev

Uso

Execute a ferramenta em seu projeto. Levará algum tempo, pois será executado uma análise completa do Phpstan para cada nível.

vendor/bin/phpstan-bodyscan

↓

Para obter erros contando por nível:

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

Você quer executar níveis, incluindo todas as mensagens ignoradas?

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

Você quer executar níveis sem extensões?

vendor/bin/phpstan-bodyscan --bare

Você precisa de um formato JSON?

Temos você coberto:

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

Contagem de nível limite

Você está interessado apenas em alguns níveis? Você pode limitar os intervalos pelas opções:

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

Medir cobertura do tipo

Experimental!

Você está interessado em aprender param, devolução e cobertura de declaração do tipo de propriedade do projeto?

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

Com base no pacote de cobertura de tipo.

Carregar arquivo Env

Alguns projetos precisam carregar o arquivo .env para executar o phpstan. Você pode fazer assim:

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

Depuração

Executar o Phpstan em um novo projeto que você não conhece pode travar. Para salvar os dados dos níveis acabados, jogamos-os no arquivo bodyscan-log.txt .

Se a execução travar por qualquer motivo, a saída de erro do Phpstan também será despejada no mesmo arquivo.

Codificação feliz!