dq5studios/psalm-junit

Add junit report format to psalm

v3.0.0 2022-12-21 05:15 UTC

Requires

• php: >=7.4
• vimeo/psalm: ^4.4 || ^5.0

Requires (Dev)

• dg/bypass-finals: ^1.4
• friendsofphp/php-cs-fixer: ^3.13
• mikey179/vfsstream: ^1.6
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: ^3.5

BSD-3-Clause

• Ben Dusinberre

README

psalm-junit

A Junit report plugin for Psalm (requires Psalm v4.4+ or v5.0+).

Installation:

composer require --dev dq5studios/psalm-junit
vendor/bin/psalm-plugin enable dq5studios/psalm-junit

Usage

While enabled, the plugin will generate a JUnit formatted file named psalm_junit_report.xml every time Psalm is run without the --report commandline option.

Configuration

The plugin defaults to writing psalm_junit_report.xml in the current working directory. To change this, edit the plugin's settings in psalm.xml to add a filepath element. All paths are relative to the current working directory.

<plugins>
    <pluginClass class="DQ5Studios\PsalmJunit\Plugin">
        <filepath>./reports/junit.xml</filepath>
    </pluginClass>
</plugins>

The report will not be written if another report is being requested with the --report commandline option. To override this and always generate the report, edit the plugin's settings in psalm.xml to add an always element.

<plugins>
    <pluginClass class="DQ5Studios\PsalmJunit\Plugin">
        <always />
    </pluginClass>
</plugins>

If the command line option --report-show-info is set or showInfo is defined in the config, then the value is used to control if info level issues will be included in the output nor in the issue totals. The default is to include them.

<plugins>
    <pluginClass class="DQ5Studios\PsalmJunit\Plugin">
        <showInfo>false</showInfo>
    </pluginClass>
</plugins>

If showSnippet is defined in the config, the value is used to control if snippets will be included in the report. The default is to include them.

<plugins>
    <pluginClass class="DQ5Studios\PsalmJunit\Plugin">
        <showSnippet>false</showSnippet>
    </pluginClass>
</plugins>