README

此库向 PHP_CodeSniffer (phpcs) 添加了一个自定义报告，以生成代码质量工件，该工件可用于 Gitlab CI/CD。自定义报告将以 Code Climate 格式生成，并允许 Gitlab CI/CD 在代码质量报告中显示违规情况。

安装

使用 Composer 安装此库

composer require --dev micheh/phpcs-gitlab

然后调整您的 .gitlab-ci.yml 文件以运行带有自定义报告器的 PHP_CodeSniffer 并收集代码质量工件

phpcs:
  script: vendor/bin/phpcs --report=full --report-\\Micheh\\PhpCodeSniffer\\Report\\Gitlab=phpcs-quality-report.json
  artifacts:
    reports:
      codequality: phpcs-quality-report.json

上面的示例使用两个报告，一个用于在构建日志中显示（完整），另一个用于生成 Code Climate 格式的代码质量工件文件。

注意： Gitlab 当前不支持多个代码质量工件。您无法在代码质量报告中显示多个工具（例如 PHP Code Sniffer & PHPStan）的违规情况。

在代码质量工件内部，Gitlab 期望是相对于包含违规的文件的路径。要使用 PHP Code Sniffer 生成相对路径，请使用 basepath 参数在您的 phpcs.xml.dist 配置文件中设置 <arg name="basepath" value="."/> 或使用 --basepath=. 运行 phpcs（根据需要调整基础路径）。

参考

许可

此存档中的文件受 BSD-3-Clause 许可证的许可。您可以在 LICENSE.md 中找到此许可证的副本。

micheh / phpcs-gitlab

维护者

详细信息

README

安装

参考

许可