이 기사에서는 PHP_CodeSniffer와 설치 및 사용 튜토리얼을 소개합니다. 도움이 필요한 친구들이 모두 참고할 수 있기를 바랍니다.
PHP_CodeSniffer는 자동 PHP 코드 사양 확인 도구입니다.
CodeSniffer에는 MySource
, PEAR
, PHPCS
, PSR1
, PSR2
가 내장되어 있습니다. >, Squiz 및 Zend
와 같은 여러 가지 코드 사양 세트가 있습니다. MySource
、PEAR
、PHPCS
、PSR1
、PSR2
、Squiz
和Zend
等几套代码规范。
当然,你也可以新增自己的代码规范。
PHP_CodeSniffer包含两个工具,phpcs
用来检查代码规范,phpcbf
用来纠正代码规范。
PHP_CodeSniffer 有好几种安装方式。
用git命令下载(或直接下载)仓库源码,然后直接执行:
git clone https://github.com/squizlabs/PHP_CodeSniffer.git cd PHP_CodeSniffer php bin/phpcs -h php bin/phpcbf -h
要使用非最新版本,可以到PEAR下载,地址:http://pear.php.net/package/PHP_CodeSniffer/download
例如,要用2.9.1
,PEAR下载之后解压,执行的命令是:
php scripts/phpcs -h php scripts/phpcbf -h
与 githuh 下载不同的是,执行文件在scripts
目录。
phar也就是php archive,把php文件打包成一个文件供服务。
Linux系统用命令下载phar文件:
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
Windows系统用浏览器访问上面的两个链接,下载这两个phar文件。
然后在phar文件的目录里面执行:
php phpcs.phar -h php phpcbf.phar -h
能看到phpcs和phpcbf的帮助信息,说明安装成功。
说明:
.phar
文件放到对应目录,然后在那个目录下运php phpcs.phar xxx
行命令
如果本地安装了pear(pear安装方法),也可以通过pear来安装PHP_CodeSniffer,命令:
pear install PHP_CodeSniffer
通过pear安装后,CodeSniffer的规范文件会安装在:/path/to/pear/PHP/CodeSniffer/src/Standards
。
composer安装也很方便,一个命令:
composer global require "squizlabs/php_codesniffer=*"
说明:这里需要composer
命令已经在PATH
环境变量中。
也可以在composer.json文件中使用:
{ "require-dev": { "squizlabs/php_codesniffer": "3.*" } }
完成后执行命令:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
以上的方式中,除了pear安装方式,其他方式要执行phpcs
命令,都需要在前面加上php。
如果是Linux提供,因为php执行文件路径已经在环境PATH
中,所以把bin
(或scripts
) 的路径加入PATH
,就可以在终端执行phpcs
命令了。
但是在Windows系统中,实际是执行phpcs.bat文件,这个文件又引用了同目录下的phpcs文件。
在phpcs.bat中,我们需要配置两个变量,才能在CMD中正确执行phpcs命令。
如下,需指定php.exe
和phpcs
자신만의 코드 사양을 추가할 수도
.phpcs
는 코드 사양을 확인하는 데 사용됩니다. phpcbf
는 if "%PHPBIN%" == "" set PHPBIN=D:\php56n\php.exe if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH GOTO RUN :USE_PEAR_PATH set PHPBIN=%PHP_PEAR_PHP_BIN% :RUN "%PHPBIN%" "D:\www\PHP_CodeSniffer-2.9.1\scripts\phpcs" %*최신 버전이 아닌 버전을 사용하려면, PEAR(주소:http://pear.php.net/package/PHP_CodeSniffer/download
2.9.1
을 사용하려면 PEAR를 다운로드하고 압축을 푼 후, 실행할 명령은
$ phpcs /path/to/code/myfile.php # 检查文件 $ phpcs /path/to/code # 检查目录和子目录下的所有文件 $ phpcs -l /path/to/code # 检查目录下的所有文件,不包括子目录 $ phpcs /path/to/code/myfile.inc /path/to/code/my_dir # 检查文件和目录githuh download와 다릅니다. 네, 실행 파일은
scripts
디렉터리에 있습니다. 🎜🎜1.2 phar 파일 설치 방법 🎜🎜🎜phar도 🎜php archive🎜로, php 파일을 하나의 파일로 패키징하여 서비스합니다. 🎜🎜Linux 시스템의 경우 다음 명령을 사용하여 phar 파일을 다운로드합니다. 🎜$ phpcs /path/to/code/myfile.php FILE: /path/to/code/myfile.php -------------------------------------------------------------------------------- FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S) -------------------------------------------------------------------------------- 2 | ERROR | Missing file doc comment 20 | ERROR | PHP keywords must be lowercase; expected "false" but found | | "FALSE" 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1 47 | WARNING | Equals sign not aligned with surrounding assignments 51 | ERROR | Missing function doc comment 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6 --------------------------------------------------------------------------------🎜Windows 시스템의 경우 브라우저를 사용하여 위의 두 링크에 액세스하고 이 두 phar 파일을 다운로드합니다. 🎜🎜그런 다음 phar 파일 디렉터리에서 실행합니다. 🎜
$ phpcs -n /path/to/code/myfile.php🎜 phpcs 및 phpcbf의 도움말 정보를 보면 설치가 성공했음을 알 수 있습니다. 🎜🎜🎜참고: 🎜🎜
.phar
🎜 파일을 해당 디렉터리에 배치한 후 🎜php phpcs.phar xxx
🎜line 명령🎜$ phpcs --report=summary /path/to/code🎜pear를 통해 설치한 후 CodeSniffer 사양 파일이 설치됩니다. 위치:
/path/to /pear/PHP/CodeSniffer/src/Standards
. 🎜🎜1.4 컴포저 설치 방법🎜🎜🎜컴포저 설치도 매우 편리합니다. 명령 하나: 🎜$ phpcs --standard=PEAR /path/to/code/myfile.inc # 使用内置规范 $ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc # 使用指定路径下的规范 $ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php # 使用多个规范 $ phpcs --config-set default_standard Squiz # 修改默认规范为Squiz(原本是PEAR)🎜🎜지침: 🎜🎜여기에 필요함🎜
composer
🎜명령은 다음과 같습니다. 이미🎜 PATH
🎜환경 변수가 있습니다. 🎜🎜🎜는 작곡가.json 파일에서도 사용할 수 있습니다: 🎜$ phpcs -i🎜완료 후 명령 실행: 🎜
$ phpcs -h🎜1.5 명령줄에서 직접 실행되도록 phpcs 구성 🎜🎜🎜추가로 위의 방법들에 Pear 설치 방법,
phpcs
명령을 실행하는 다른 방법들에는 앞에 php를 추가해야 합니다. 🎜🎜Linux에서 제공하는 경우 php 실행 파일 경로가 이미 PATH
환경에 있으므로 bin
(또는 scripts
경로를 추가하세요. code>) PATH, 터미널에서 phpcs
명령을 실행할 수 있습니다. 🎜🎜그러나 Windows 시스템에서는 실제로 🎜phpcs.bat🎜 파일이 실행되는데, 이 파일은 동일한 디렉토리에 있는 🎜phpcs🎜 파일을 참조합니다. 🎜🎜CMD에서 phpcs 명령을 올바르게 실행하려면 phpcs.bat에서 두 개의 변수를 구성해야 합니다. 🎜🎜다음과 같이 php.exe
및 phpcs
파일의 절대 위치를 지정해야 합니다. 🎜rrreee🎜그런 다음 경로 D: wwwPHP_CodeSniffer-2.9.1scripts를 추가합니다. PATH, CMD에서 phpcs를 실행할 수 있습니다. 🎜🎜🎜🎜참고: phpcbf에도 이러한 수정이 필요합니다. 🎜🎜🎜🎜🎜2 🎜🎜🎜을 사용하면 위에서 PHP_CodeSniffer에 두 개의 명령이 있음을 알 수 있습니다. 🎜🎜기본적으로 PHP_CodeSniffer는 PEAR 사양을 사용하여 코드를 확인합니다. 🎜🎜🎜2.1 🎜🎜🎜 명령 사용 다음 명령은 기본 사양을 사용하여 파일과 디렉터리를 확인합니다. 🎜rrreee🎜🎜2.2 결과 확인🎜🎜🎜기본적으로 확인 결과에는 다음과 같은 오류와 경고가 포함되어 있습니다. 🎜$ phpcs /path/to/code/myfile.php FILE: /path/to/code/myfile.php -------------------------------------------------------------------------------- FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S) -------------------------------------------------------------------------------- 2 | ERROR | Missing file doc comment 20 | ERROR | PHP keywords must be lowercase; expected "false" but found | | "FALSE" 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1 47 | WARNING | Equals sign not aligned with surrounding assignments 51 | ERROR | Missing function doc comment 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6 --------------------------------------------------------------------------------
如果不要显示警告,加个-n
参数:
$ phpcs -n /path/to/code/myfile.php
仅显示检查结果概要:
$ phpcs --report=summary /path/to/code
可以使用 -- standard
参数指定一个或多个规范来检查。
$ phpcs --standard=PEAR /path/to/code/myfile.inc # 使用内置规范 $ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc # 使用指定路径下的规范 $ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php # 使用多个规范 $ phpcs --config-set default_standard Squiz # 修改默认规范为Squiz(原本是PEAR)
查看现有规范:
$ phpcs -i
$ phpcs -h
推荐学习:《PHP视频教程》
위 내용은 PHP_CodeSniffer란 무엇입니까? 설치 및 사용 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!