使用 PHP_CodeSniffer 的包的代码一致性徽章

Question

PHP_CodeSniffer Github 页面有一个非常好的 代码一致性 徽章。

单击徽章可将您带到徽章报告的排名分析的细分。您还可以看到 analysis of many packages.

我想在我自己的项目中包含一个代码一致性徽章。

我找不到有关如何实现的任何详细信息。也许它不是任何软件包都可用的东西？

Answer 1

我手动将项目添加到该分析站点，但您可以通过在 PHP_CodeSniffer Github 项目上打开一个问题来建议添加一个 PHP 项目。不过它必须托管在 Github 上，并且是 public.

我需要的信息非常基本。您可以在此处查看当前项目列表及其设置：https://github.com/squizlabs/PHP_CodeSniffer/blob/gh-pages/analysis/_assets/repos.json

设置为：

• 名称：项目的友好名称
• URL：Github 项目路径
• 路径：要检查的项目内部路径（大多数使用根目录，或者 src 如果根目录有一堆不应该检查的文件和目录）
• 忽略：要忽略的任何文件或目录，使用多个正则表达式之一（如果您的 git 克隆将包含来自其他项目的代码）
• 扩展：如果您使用非标准扩展，应该检查哪些扩展。

如果您不知道设置应该是什么，可以将我指向一个 Github 存储库，我可以弄清楚，就像我对报告中的绝大多数项目所做的那样。