michaelcozzolino/psalm-html-report

A Psalm plugin to generate the output in a formatted html table.

1.0.1 2024-04-14 13:30 UTC

Requires

• php: >=8.2
• ext-simplexml: *
• jetbrains/phpstorm-attributes: ^1.0
• twig/twig: ^3.0
• vimeo/psalm: ^5.0

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• Michael Cozzolino

• plugin
• html
• report
• psalm

README

An html report plugin for Psalm v5.0+.

Installation:

composer require --dev michaelcozzolino/psalm-html-report
vendor/bin/psalm-plugin enable MichaelCozzolino\PsalmHtmlReport\Plugin

Usage

While enabled, the plugin will generate an html report file named report.html every time Psalm is run without the --report command-line option.

Configuration

The default output file is report.html in the current working directory. To change this, edit the plugin's settings in psalm.xml or psalm.xml.dist to add an outputFilepath element. All paths are relative to the current working directory. Be aware that in order for the plugin to work, the specified output directory must exist.

<plugins>
    <pluginClass class="MichaelCozzolino\PsalmHtmlReport\Plugin">
        <outputFilePath>./custom-dir/html-report.html</outputFilePath>
    </pluginClass>
</plugins>

The report will not be written if another report is being requested with the --report command-line option.

If the command-line option --show-info is set, then the info level messages will also be added to the report.

Screenshots