bafs / psalm-plugin-typecov

v1.0.0 2025-02-04 21:41 UTC

Requires

• php: >=8.0
• vimeo/psalm: ^5.0 || ^6.0

Requires (Dev)

• squizlabs/php_codesniffer: ^3.3

MIT

Published on Packagist.org on 2025-02-14 17:28 UTC

README

Experimental Psalm plugin to have type coverage information

Install

composer req --dev bafs/psalm-plugin-typecov

Register the plugin in psalm.xml:

    <plugins>
        <pluginClass class="BafS\PsalmTypecov\TypeCoverage">
            <htmlReport output="typecov-report.html" />
        </pluginClass>
    </plugins>

Use markdownReport instead of (or together with) htmlReport to get a Markdown table, handy for pull request comments or a GitHub Actions job summary:

            <markdownReport output="typecov-report.md" />

You can run psalm (typically ./vendor/bin/psalm) and the report will get generated on the fly.

Note: If you want to always scan all the files, you need to use the --no-cache flag.

Screenshoot