codeclimate phpcodesniffer

代码气候php_codesniffer引擎

codeclimate-phpcodesniffer是一种代码气候引擎，它包含PHP_CODE SNIFFER静态分析工具。您可以使用代码气候CLI或我们托管的分析平台在命令行上运行它。

php_codesniffer可帮助您检测违反定义的编码标准。

安装

1. 如果还没有，请安装代码气候CLI。
2. 运行codeclimate engines:enable phpcodesniffer 。此命令同时安装引擎并在.codeclimate.yml文件中启用它。
3. 您准备分析了！浏览您项目的文件夹并运行codeclimate analyze 。

配置选项

根据php_codesniffer文档格式化这些配置选项的值。

• file_extensions-这是您可以为需要PHP_CODESNIFFER的文件配置文件扩展名的地方。
• 标准 - 这是您希望在分析文件时使用php_codesniffer的逗号界定标准列表。您可以选择包括自定义PHPCS Ruleset.xml文件的相对路径。
• ignore_warnings-您可以隐藏警告，并且仅报告此选项的错误。
• 编码 - 默认情况下，PHPC使用ISO-8859-1。用它将其更改为您的编码，例如UTF-8。

样本配置

 exclude_paths:
 - "/examples/**/*"
engines:
  phpcodesniffer:
    enabled: true
    config:
      file_extensions: "php,inc,lib"
      standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
      ignore_warnings: true
      encoding: utf-8
ratings:
  paths:
  - "**.php"

支持的编码标准

除了默认情况下，还支持使用Php_codesniffer提供的标准外，还支持Drupal，WordPress，YII2和Magento扩展编码标准。这是完整列表：

• Drupal
• drupalpractice
• MEQP1
• meqp2
• mysource
• 梨
• phpcs
• PSR1
• PSR2
• 大麻
• WordPress
• WordPress核
• WordPress-Docs
• WordPress-Extra
• WordPress-VIP
• yii2
• Zend

需要帮助吗？

有关php_codesniffer的帮助，请查看其文档。

如果您遇到了代码气候问题，请首先查看该项目的GitHub问题，因为您的问题可能已经涵盖。如果没有，请继续与我们打开支持票。