使用PHP_CodeSniffer的包的代码一致性标记

时间:2016-08-13 00:52:31

标签: github-pages codesniffer

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

image link

点击徽章可转到徽章报告的排名分析细分。您还可以看到analysis of many packages

我想在自己的项目中加入代码一致性徽章。

我无法找到有关如何实现这一目标的任何细节。也许它不适用于任何包装?

1 个答案:

答案 0 :(得分:3)

我手动将项目添加到该分析站点,但您可以通过在PHP_CodeSniffer Github项目上打开一个问题来建议要添加的PHP项目。它必须托管在Github上,然后公开。

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

设置为:

  • 名称:项目的友好名称
  • URL:项目的Github路径
  • 路径:要检查的项目内部的路径(大多数使用根目录,如果您的根目录有一堆不应检查的文件和目录,则使用src
  • 忽略:使用一个或多个正则表达式忽略的任何文件或目录(如果您的git clone将包含其他项目中的代码)
  • 扩展:如果您使用非标准扩展,则应检查哪些扩展名。

如果您不知道设置应该是什么,您可以指向我的Github回购,我可以解决它,就像我在报告中的绝大多数项目中所做的那样。