plotbox-io/phpcs-parse

解析 phpcs (代码检查器) 输出,并以其他格式重新输出

v0.1.3 2020-04-03 18:38 UTC

This package is auto-updated.

Last update: 2024-09-29 05:36:13 UTC


README

将 phpcs (代码检查器) 输出解析为标准化的 dto,并允许以多种格式重新输出

注意:目前处于开发初期阶段(可能存在重大更改)

为什么?

通过解析 phpcs 命令的结果,我们可以进行高级过滤或在重新输出结果之前更改内容。主要用例是实现一个 'shim',其中你可能想过滤掉一些样式违规(例如,如果当前分支没有修改代码行)

示例用法

从 CSV 转换为 JSON

$converter = new Converter();
$csvIssuesString = file_get_contents(__DIR__ . '/phpcs-csv-example.txt');
$json = $converter->convert($csvIssuesString, 'csv', 'json');

支持的转换

注意:人类格式是一个特殊的报告格式,实际上并不由代码检查器使用(尽管与默认模式有些相似),可以用于生成 CI 服务器或开发者工具的输出(仅支持输出)

贡献

请阅读 [CONTRIBUTING.md],了解我们的行为准则和向我们提交拉取请求的流程。

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本,请参阅此存储库的 标签

许可

本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE.md 文件。