PHP之CodeSniffer代码规范检测和修复工具

该文章以Windows 10环境,PHP 7.4.x为例,未安装PHPStorm和其它IDE编辑器的情况下,使用命名行完成PHP代码的检测和修复代码。

首先,进入php文件夹,然后下载代码检测工具phpcs.phar或代码修复工具phpcbf.phar文件,

注意:该文章的php文件夹已加入用户环境变量中。

# 系统中使用php下载
php -r "copy('https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar', 'phpcs.phar');"
php -r "copy('https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar', 'phpcbf.phar');"

# 或者,使用 curl 下载
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# 或者,使用 wget 下载
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

接下来,打开cmd.exe,测试phar是否可用,正常情况下会提示操作方法:

# 测试phpcs和phpcbf
php phpcs.phar -h
php phpcbf.phar -h

# 创建bat文件
echo @php "%~dp0phpcs.phar" %*>phpcs.bat
echo @php "%~dp0phpcbf.phar" %*>phpcbf.bat

# 再次测试
phpcs -h
phpcbf -h

此时可以全局使用phpcs和phpcbf了这两个命令了,接下来我们对php文件进行代码检测和修复。

代码检测phpcs命令

# 检测单个文件
phpcs /home/code/myfile.php --standard=PSR12
# 检测目录下文件
phpcs /home/code-directory --standard=PSR12

代码修复phpcbf命令

# 修复单个文件
phpcbf /home/code/myfile.php --standard=PSR12
# 修复目录下文件
phpcbf /home/code-directory --standard=PSR12

phpcs和phpcbf命令的默认参数配置,设置后可避免每次加参数:

phpcs --config-set default_standard PSR12
phpcbf --config-set default_standard PSR12

PSR-12官方文档:https://www.php-fig.org/psr/psr-12/
更多帮助文档:https://github.com/squizlabs/PHP_CodeSniffer

转载请注明出处:https://www.onexin.net/php-codesniffer/

相关文章:

1、用 PHP 编写更好的正则表达式regex
https://www.onexin.net/php-regex/

2、PHP 版本 8.2,8.1,8.0,7.4
https://www.onexin.net/php-8_2-8_1-8_0-7_4/

3、PHP中的Liskov替换原则
https://www.onexin.net/php-liskov/

4、php实现自运行的do实例详解
https://www.onexin.net/php-do/

5、PHP 后端实现JWT认证方法示例
https://www.onexin.net/php-jwt/

Leave a Reply