PHP 规范示例工程
团队协作中,规范显得尤其重要。我们可以通过一些现有的自动化工具来进行规范。 本工程结合了当前社区的工具,只选出了必要的工具,所谓小而精,大概也说的就是 这件事情。
php-cs-fixer
安装:composer require friendsofphp/php-cs-fixer --dev -vvv
一句话介绍:自动格式化校正代码风格
phpmd
地址:phpmd/phpmd
安装:composer require phpmd/phpmd --dev -vvv
一句话介绍:检测 PHP 的命名、代码复杂度规范等
phpcpd
安装:composer require sebastian/phpcpd --dev -vvv
一句话介绍:检测项目是否存在代码到处复制粘贴
1. 复制粘贴 composer.json
中的依赖和脚本到工程中
"require-dev": {
"sebastian/phpcpd": "^4.1",
"phpmd/phpmd": "^2.6",
"friendsofphp/php-cs-fixer": "^2.13"
},
"scripts": {
"check-copy-src": "vendor/bin/phpcpd ./src",
"fix-src": "vendor/bin/php-cs-fixer fix ./src",
"check-mess-src": "vendor/bin/phpmd ./src text ./phpmd.xml",
"check-src": "composer check-copy-src && composer check-mess-src"
}
其中 composer script 就是对默认命令的组合
composer check-copy-src
检测 src 目录下代码是否存在复制情况composer fix-src
校正 src 目录下代码风格check-mess-src
检查 src 目录下代码复杂度等check-src
复制和代码复杂度联合检测
2. 在项目中运行 composer install -vvv