PHP代码标准和测试(未完待续)

发表于 | 分类于 | | 阅读次数

用于检测php代码标准的套件有:

  • phpcs
  • phpmd
  • phpcbf
  • php-cs-fixer

下面将简单介绍这些工具的安装和使用方法

一, 安装

使用composer安装(推荐)
然后，确保~/.composer/vendor/bin目录在你的PATH中。
export PATH=”$PATH:$HOME/.composer/vendor/bin”

1
2
3
composer global require "squizlabs/php_codesniffer=*"
composer global require phpmd/phpmd
composer global require fabpot/php-cs-fixer

检查是否都成功安装:

1
2
3
4
$ which phpcs
$ which phpmd
$ which php-cs-fixer
$ which phpcbf

二, 使用

2.1 phpcs

  • 查看帮助：phpcs –help
  • 添加标准：phpcs –config-set installed_paths PATH_TO_SEARCH_STANDARDS

注意：假设标准为 Weibo, 目录为:
/Users/overtrue/code_standards/Weibo
其中Weibo 里才是 ruleset.xml，那么对应上面的 PATH_TO_SEARCH_STANDARDS 应该为：
phpcs –config-set installed_paths /Users/overtrue/code_standards

开发中我们经常使用wordpress的标准来, 设置如下:

1
2
git clone git@github.com:WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs
phpcs --config-set installed_paths /www/default_path_to/wpcs
  • 查看已经安装的标准：phpcs -i
  • 查看配置：phpcs –config-show
  • 检查代码规范：

phpcs ./codes/Example.php
// or
phpcs ./codes/

  • 指定标准：phpcs ./codes/Example.php –standard=PSR2
  • 报告格式：phpcs –report=summary /path/to/code

可用的格式有（默认为: full）：
full, xml, checkstyle, csv
json, emacs, source, summary, diff
svnblame, gitblame, hgblame or notifysend

  • 修复代码

    • 第一种：使用 diff 形式打补丁：

      phpcs –report-diff=/path/to/changes.diff /path/to/code
      patch -p0 -ui /path/to/changes.diff

      patching file /path/to/code/file.php

    • 第二种：使用 PHP Code Beautifier 和 Fixer：

phpcbf /path/to/code
以上命令会自动修复原文件，如果不想直接覆盖原文件，可以使用 –suffix 指定修复后的代码后缀：
phpcs /path/to/code –suffix=.fixed

更多 PHPCS 的使用请参考：https://github.com/squizlabs/PHP_CodeSniffer/wiki

2.2 phpmd使用

使用phpmd检查代码质量操作如：

1
2
3
4
5
6
7
8
# phpmd 代码路径 报告格式
phpmd /path/to/source text
# phpmd 代码路径 报告格式 规则列表
phpmd /path/to/source text codesize,unusedcode,naming
# phpmd 代码路径 报告格式 规则xml文件
phpmd /path/to/source text /phpmd_ruleset.xml

报告格式有：

  • xml, 以 XML 格式输出；
  • text, 简单的文本格式；
  • html, 输出到单个的html；

这里有一个phpmd规则可参考：https://github.com/overtrue/phpmd-rulesets

更多关于 PHPMD 的使用请参考：http://phpmd.org/documentation/index.html

2.3 php-cs-fixer

参考