PHP_CodeSniffer

경고

이 저장소는 버려졌습니다. 후임자는 PHPCS 스탠드/PHP_CodesNiffer입니다

자세한 내용은 이슈 #3932를 참조하십시오.

에 대한

php_codesniffer는 두 개의 PHP 스크립트 세트입니다. PHP, JavaScript 및 CSS 파일을 토큰 화하여 정의 된 코딩 표준의 위반을 감지하고 표준 위반을 자동으로 수정하기 위해 두 번째 phpcbf 스크립트를 감지하는 주요 phpcs 스크립트. PHP_CODESNIFFER는 코드가 깨끗하고 일관성을 유지하는 필수 개발 도구입니다.

요구 사항

PHP_CODESNIFFER는 PHP 버전 5.4.0 이상이 필요하지만 개별 스 니프에는 외부 응용 프로그램 및 스크립트와 같은 추가 요구 사항이있을 수 있습니다. 이러한 요구 사항 목록은 구성 옵션 설명서 페이지를 참조하십시오.

팀의 일원으로 php_codesniffer를 사용하거나 CI 서버에서 실행중인 경우 구성 파일을 사용하여 프로젝트 설정을 구성 할 수 있습니다.

설치

php_codesniffer로 시작하는 가장 쉬운 방법은 각 명령에 대한 PHAR 파일을 다운로드하는 것입니다.

# Download using curl
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Or download using wget
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Then test the downloaded PHARs
php phpcs.phar -h
php phpcbf.phar -h

작곡가

Composer를 사용하는 경우 다음 명령으로 PHP_CODESNIFFER 시스템 전체에 SYSTEM을 설치할 수 있습니다.

 Composer Global은 "squizlabs/php_codesniffer =*"가 필요합니다.

경로에 작곡가 빈이 있는지 확인하십시오. 기본값은 ~/.composer/vendor/bin/ 이지만 composer global config bin-dir --absolute 실행하여 사용해야 할 값을 확인할 수 있습니다.

또는 composer.json 파일에 squizlabs/php_codesniffer 에 대한 종속성을 포함하십시오. 예를 들어:

 { "require-dev": { "squizlabs/php_codesniffer": "3.*"}
}

그런 다음 공급 업체 빈 디렉토리에서 php_codesniffer를 실행할 수 있습니다.

 ./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

Phive

Phive를 사용하는 경우 다음 명령을 사용하여 PHP_CODESNIFFER를 프로젝트 도구로 설치할 수 있습니다.

 Phive 설치 PHPC
Phive 설치 phpcbf

그런 다음 도구 디렉토리에서 php_codesniffer를 실행할 수 있습니다.

 ./tools/phpcs -h
./tools/phpcbf -h

배

Pear를 사용하는 경우 Pear 설치 프로그램을 사용하여 PHP_CODESNIFFER를 설치할 수 있습니다. 이를 통해 phpcs 및 phpcbf 명령을 즉시 사용할 수 있습니다. 배 설치 프로그램을 사용하여 php_codesniffer를 설치하려면 먼저 배를 설치 한 다음 다음 명령을 실행하십시오.

 배 설치 php_codesniffer

git 클론

PHP_CodesNiffer 소스를 다운로드하고 GIT 클론에서 직접 phpcs 및 phpcbf 명령을 실행할 수도 있습니다.

 git 클론 https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer
Php bin/phpcs -h
Php bin/phpcbf -h

시작하기

php_codesniffer에서 사용하는 기본 코딩 표준은 배 코딩 표준입니다. 배 코딩 표준에 대한 파일을 확인하려면 파일의 위치를 ​​간단히 지정합니다.

 phpcs/path/to/code/myfile.php

또는 전체 디렉토리를 확인하려면 파일 대신 디렉토리 위치를 지정할 수 있습니다.

 PHPCS/PATH/TO/CODE-DIRECTORY

PSR-12 코딩 표준에 대해 코드를 확인하려면 --standard 명령 줄 인수를 사용하십시오.

 phpcs-- 표준 = psr12/path/to/code-directory

php_codesniffer가 코딩 표준 오류를 찾으면 명령을 실행 한 후 보고서가 표시됩니다.

전체 사용 정보 및 예제 보고서는 사용 페이지에서 확인할 수 있습니다.

선적 서류 비치

php_codesniffer에 대한 문서는 Github Wiki에서 제공됩니다.

문제

버그 보고서 및 기능 요청은 Github 문제 추적기에 제출할 수 있습니다.

기여

정보는 Contributing.md를 참조하십시오.

버전 작성

php_codesniffer MAJOR.MINOR.PATCH 버전 번호 형식을 사용합니다.

MAJOR 버전은 다음과 같이 증가합니다.

• phpcs 또는 phpcbf 명령이 어떻게 사용되는지에 대한 뒤로 호환되지 않는 변경이 이루어집니다.

• Backwards-Inscincible 변경 사항은 ruleset.xml 형식으로 이루어집니다

• Sniff 개발자가 사용하는 API에 대한 거꾸로 호환되지 않는 변경 사항이 있습니다.

• 사용자 정의 php_codesniffer 토큰 유형이 제거됩니다

• 기존 스 니프는 PHP_CodesNiffer에서 완전히 제거됩니다

MINOR 버전은 다음과 같이 증가합니다.

• 새로운 역 호환 기능은 phpcs 및 phpcbf 명령에 추가됩니다.

• Backwards 호환 변경 사항은 ruleset.xml 형식으로 이루어집니다

• Sniff 개발자가 사용하는 API에 대한 후진 호환 변경 사항 또는

• 새로운 스 니프가 포함 된 표준에 추가됩니다

• 기존 스 니프는 포함 된 표준에서 제거됩니다

참고 : Sniff 개발자가 사용하는 API에 대한 후진 호환 변경을 통해 기존 스니핑은 치명적인 오류를 일으키지 않고 계속 실행할 수 있지만 스니핑은 이전에 변경 사항이 필요하지 않은 것과 동일한 오류를보고하지 않을 수 있습니다.

PATCH 버전은 다음과 같이 증가합니다.

• 후진 호환 버그 수정이 이루어집니다

참고 : PHP_CODESNIFFER가 문제를보고하고 수정하기 위해 존재하므로 대부분의 버그는 표준 오류가 잘못보고되거나 표준 오류가 필요할 때보고되지 않은 결과입니다. 이는 PHP_CodesNiffer가 생성 한 메시지와 그 수정이 패치 버전마다 다를 수 있음을 의미합니다.