eviweb / fuelphp-phpcs
Fuel PHP 的 PHP 代码检查标准,具有专门的 CLI
v1.0.8
2018-11-20 23:14 UTC
Requires
- php: >=5.3.3
- squizlabs/php_codesniffer: ~2
Requires (Dev)
- phpunit/phpunit: ^4 || ^5
README
PHP Code Sniffer 规则,涵盖了 [Fuel PHP 编码标准] 的很大一部分 (http://docs.fuelphp.com/general/coding_standards.html "Fuel PHP 编码标准")。
如何安装
Composer 方法(自 v1.0.4 版起)
在您的 fuelphp 项目中运行 composer require --dev eviweb/fuelphp-phpcs:~1
。
它将自动使用 Composer 安装 PHP CodeSniffer。
旧方法
安装(仅限 Linux)
- 克隆项目
git clone https://github.com/eviweb/fuelphp-phpcs.git
- 更改目录到 ./fuelphp-phpcs
cd fuelphp-phpcs
- 以 root 权限运行安装程序
sudo ./install.sh
卸载(仅限 Linux)
- 更改目录到 ./fuelphp-phpcs
cd fuelphp-phpcs
- 以 root 权限运行卸载程序
sudo ./uninstall.sh
如何使用
使用 fuelphpcs 命令(自 v1.0.4 版起)
假设 FuelPHPCS 已通过 Composer 安装在 ./fuel/vendor
中,并且 bin-dir
是 ./fuel/vendor/bin
。
运行 ./fuel/vendor/bin/fuelphpcs PROJECT_TO_SNIFF_DIRECTORY
,其中 PROJECT_TO_SNIFF_DIRECTORY 是您的 fuel php 项目目录。
旧方法
运行 phpcs --standard=FuelPHP PROJECT_TO_SNIFF_DIRECTORY
,其中 PROJECT_TO_SNIFF_DIRECTORY 是您的 fuel php 项目目录。
注意:不要使用 --tab-width phpcs 选项,除非值是 0,否则这会禁用制表符识别!
要求
请注意,此软件包与 PHP Code Sniffer 版本 2.9.x 兼容。