PHPackages                             staabm/phpstan-baseline-analysis - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. staabm/phpstan-baseline-analysis

ActiveLibrary[Testing & Quality](/categories/testing)

staabm/phpstan-baseline-analysis
================================

0.13.2(7mo ago)84114.1k↓53%12[3 issues](https://github.com/staabm/phpstan-baseline-analysis/issues)[7 PRs](https://github.com/staabm/phpstan-baseline-analysis/pulls)1MITPHPPHP ^7.4 || ^8.0CI passing

Since Aug 4Pushed 1w ago3 watchersCompare

[ Source](https://github.com/staabm/phpstan-baseline-analysis)[ Packagist](https://packagist.org/packages/staabm/phpstan-baseline-analysis)[ GitHub Sponsors](https://github.com/staabm)[ RSS](/packages/staabm-phpstan-baseline-analysis/feed)WikiDiscussions main Synced 3d ago

READMEChangelog (10)Dependencies (10)Versions (42)Used By (1)

Analyzes phpstan baseline files
-------------------------------

[](#analyzes-phpstan-baseline-files)

Analyzes PHPStan baseline files and creates aggregated error trend-reports.

[Read more in the Blog post.](https://staabm.github.io/2022/07/04/phpstan-baseline-analysis.html)

You need at least one of the supported PHPStan RuleSets/Rules configured in your project, to get meaningful results.

Installation
------------

[](#installation)

```
composer require staabm/phpstan-baseline-analysis --dev

```

Supported Rules
---------------

[](#supported-rules)

### PHPStan RuleSets

[](#phpstan-rulesets)

-

### PHPStan Rules

[](#phpstan-rules)

- PHPStan\\Rules\\PhpDoc\\InvalidPhpDocTagValueRule

### [Symplify PHPStan Rules](https://github.com/symplify/phpstan-rules)

[](#symplify-phpstan-rules)

- Symplify\\PHPStanRules\\Rules\\Explicit\\NoMixedMethodCallerRule
- Symplify\\PHPStanRules\\Rules\\Explicit\\NoMixedPropertyFetcherRule

### [tomasvotruba/cognitive-complexity](https://github.com/TomasVotruba/cognitive-complexity) Rules

[](#tomasvotrubacognitive-complexity-rules)

- TomasVotruba\\CognitiveComplexity\\Rules\\ClassLikeCognitiveComplexityRule

### [tomasvotruba/type-coverage](https://github.com/TomasVotruba/type-coverage) Rules

[](#tomasvotrubatype-coverage-rules)

- TomasVotruba\\TypeCoverage\\Rules\\ParamTypeCoverageRule
- TomasVotruba\\TypeCoverage\\Rules\\PropertyTypeCoverageRule
- TomasVotruba\\TypeCoverage\\Rules\\ReturnTypeCoverageRule

### [tomasvotruba/unused-public](https://github.com/TomasVotruba/unused-public) Rules

[](#tomasvotrubaunused-public-rules)

- TomasVotruba\\UnusedPublic\\Rules\\UnusedPublicClassConstRule
- TomasVotruba\\UnusedPublic\\Rules\\UnusedPublicClassMethodRule
- TomasVotruba\\UnusedPublic\\Rules\\UnusedPublicPropertyRule

example report
--------------

[](#example-report)

Starting from the current directory, the command will recursively search for files matching the glob pattern and report a summary for each baseline found.

```
$ phpstan-baseline-analyze *phpstan-baseline.neon
Analyzing app/portal/phpstan-baseline.neon
  Overall-Errors: 41
  Classes-Cognitive-Complexity: 70
  Deprecations: 2
  Invalid-Phpdocs: 5
  Unknown-Types: 1
  Anonymous-Variables: 4
  Native-Property-Type-Coverage: 1
  Native-Param-Type-Coverage: 27
  Native-Return-Type-Coverage: 4
  Unused-Symbols: 3

```

example error filtering
-----------------------

[](#example-error-filtering)

Filter a existing baseline and output only errors NOT matching the given filter key:

Tip

This can be helpful to remove a class of errors out of an existing baseline, so PHPStan will start reporting them again.

```
$ phpstan-baseline-filter *phpstan-baseline.neon --exclude=Unknown-Types

```

Filter a existing baseline and output only errors matching the given filter key:

```
$ phpstan-baseline-filter *phpstan-baseline.neon --include=Invalid-Phpdocs

```

[Currently supported filter keys](https://github.com/staabm/phpstan-baseline-analysis/blob/1e8ea32a10e1a50c3fd21396201495a1ae1a5d1d/lib/ResultPrinter.php#L42-L51) can be found in the source.

example graph analysis
----------------------

[](#example-graph-analysis)

```
$ git clone ...

$ phpstan-baseline-analyze *phpstan-baseline.neon --json > now.json

$ git checkout `git rev-list -n 1 --before="1 week ago" HEAD`
$ phpstan-baseline-analyze '*phpstan-baseline.neon' --json > 1-week-ago.json

$ git checkout `git rev-list -n 1 --before="2 week ago" HEAD`
$ phpstan-baseline-analyze '*phpstan-baseline.neon' --json > 2-weeks-ago.json

$ php phpstan-baseline-graph '*.json' > result.html

```

[![PHPStan baseline analysis graph](https://private-user-images.githubusercontent.com/120441/260998387-ea5abe25-21e8-43f2-9118-0967a75517c6.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODI2NzkzMTcsIm5iZiI6MTc4MjY3OTAxNywicGF0aCI6Ii8xMjA0NDEvMjYwOTk4Mzg3LWVhNWFiZTI1LTIxZTgtNDNmMi05MTE4LTA5NjdhNzU1MTdjNi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYyOFQyMDM2NTdaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kMDgyYjM4NmUxNDMzMDkwYzhkOWY4NGE5ZGQ0YjRjZjU3MmI4MjZmNmQ5OGRkN2ZjZTNlOWI3Mjc0NGJkYTc5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.2I-ifheJNL7aPYCjCzfueqnIaWReH8nFTlpxyhffg8A)](https://private-user-images.githubusercontent.com/120441/260998387-ea5abe25-21e8-43f2-9118-0967a75517c6.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODI2NzkzMTcsIm5iZiI6MTc4MjY3OTAxNywicGF0aCI6Ii8xMjA0NDEvMjYwOTk4Mzg3LWVhNWFiZTI1LTIxZTgtNDNmMi05MTE4LTA5NjdhNzU1MTdjNi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYyOFQyMDM2NTdaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kMDgyYjM4NmUxNDMzMDkwYzhkOWY4NGE5ZGQ0YjRjZjU3MmI4MjZmNmQ5OGRkN2ZjZTNlOWI3Mjc0NGJkYTc5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.2I-ifheJNL7aPYCjCzfueqnIaWReH8nFTlpxyhffg8A)

example trend analysis
----------------------

[](#example-trend-analysis)

the following example shows the evolution of errors in your phpstan baselines. see the trend between 2 different points in time like:

```
$ git clone ...

$ phpstan-baseline-analyze '*phpstan-baseline.neon' --json > now.json

$ git checkout `git rev-list -n 1 --before="1 week ago" HEAD`

$ phpstan-baseline-analyze '*phpstan-baseline.neon' --json > reference.json

$ phpstan-baseline-trend reference.json now.json
Analyzing Trend for app/portal/phpstan-baseline.neon
  Overall-Errors: 30 -> 17 => improved
  Classes-Cognitive-Complexity: 309 -> 177 => improved
  Deprecations: 1 -> 2 => worse
  Invalid-Phpdocs: 3 -> 1 => good
  Unknown-Types: 5 -> 15 => worse
  Anonymous-Variables: 4 -> 3 => good
  Unused-Symbols: 1 -> 1 => good
  Native-Return-Type-Coverage: 20 -> 2 => worse
  Native-Property-Type-Coverage: 3 -> 3 => good
  Native-Param-Type-Coverage: 4 -> 40 => improved

```

Usage example in a scheduled GitHub Action with Mattermost notification
-----------------------------------------------------------------------

[](#usage-example-in-a-scheduled-github-action-with-mattermost-notification)

Copy the following workflow into your repository. Make sure to adjust as needed:

- adjust the cron schedule pattern
- actions/checkout might require a token - e.g. for private repos
- adjust the comparison period, as you see fit
- adjust the notification to your needs - e.g. use Slack, Discord, E-Mail,..

```
name: Trends Analyse

on:
  workflow_dispatch:
  schedule:
    - cron: '0 8 * * 4'

jobs:

  behat:
    name: Trends
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - run: "composer global require staabm/phpstan-baseline-analysis"
      - run: echo "$(composer global config bin-dir --absolute --quiet)" >> $GITHUB_PATH

      - uses: actions/checkout@v2
        with:
          fetch-depth: 50 # fetch the last X commits.

      - run: "phpstan-baseline-analyze '*phpstan-baseline.neon' --json > ../now.json"

      - run: git checkout `git rev-list -n 1 --before="1 week ago" HEAD`

      - run: "phpstan-baseline-analyze '*phpstan-baseline.neon' --json > ../reference.json"

      - name: analyze trend
        shell: php {0}
        run: |