README

psalm-junit

Psalm 的 JUnit 报告插件 (需要 Psalm v4.4+ 或 v5.0+)。

安装

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

启用插件后，每次在未使用 --report 命令行选项的情况下运行 Psalm 时，都会生成一个名为 psalm_junit_report.xml 的 JUnit 格式化文件。

插件默认将 psalm_junit_report.xml 写入当前工作目录。要更改此设置，请编辑 psalm.xml 中的插件设置以添加一个 filepath 元素。所有路径都是相对于当前工作目录的。

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

如果请求了另一个报告并使用了 --report 命令行选项，则不会写入报告。要覆盖此限制并始终生成报告，请编辑 psalm.xml 中的插件设置以添加一个 always 元素。

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

如果设置了命令行选项 --report-show-info 或在配置中定义了 showInfo，则该值用于控制是否将信息级别问题包含在输出中或问题总数中。默认情况下，将包含它们。

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

如果配置中定义了 showSnippet，则该值用于控制是否将代码片段包含在报告中。默认情况下，将包含它们。

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