PhpStorm에 Docker 용 PHP CodeSniffer를 통합하고 이상한 코드를 자동으로 감지하는 방법

이 글에서는 PHP_CodeSniffer의 Docker 이미지을 PhpStorm에 통합하여 phpcs의 해석 결과를 PhpStorm에서 확인할 수 있도록 하는 설정 순서를 설명한다. Docker 이미지를 사용하지 않는 방법에 대한 설명은 "Mac용 PhpStorm에 PHP CodeSniffer를 통합하는 방법"을 참조하십시오.

phpcs를 PhpStorm에 통합 할 때 표시되는 충고 예

설정 절차

phpcs 용 원격 인터프리터 추가

인터프리터란 PHP의 실행 환경을 말한다. 원격 인터프리터는 PhpStorm이 움직이는 OS 이외의 PHP 실행 환경을 말합니다. 여기서는 Docker 컨테이너 내의 php 명령을 가리킨다. phpcs 는 컨테이너내에서 기동시킬 필요가 있기 (위해)때문에, 인터프리터의 설정을 우선 실시한다.

설정을 열고 Languages ​​& Frameworks → PHP에서 CLI Interpreter에 Docker 이미지를 지정하려면 "..."버튼을 누릅니다.



CLI Interpreters 창에서 +를 눌러 Configure Remote Interpreters 화면을 엽니다. 입력은 아래 그림과 같이 수행됩니다. 「Image name」에는 phpqa/phpcs:3.2.3를 복사.



「OK」를 누르면 2,3초 후 아래 그림과 같이 인터프리터가 추가된 화면이 나온다. "Visible only for this project"의 선택을 취소합니다. 그런 다음 "OK"를 눌러 닫습니다.

phpcs 설정하기

Code Sniffer 설정 화면에서 "..."버튼을 누릅니다.



방금 추가 한 인터프리터 선택 :



Validate하고 문제가 없으면 OK를 누릅니다.

Inspections 설정에서 PHP Code Sniffer 사용

여기에서는 아래의 2가지 설정 방법을 소개한다.

PSR2 코딩 표준 사용

자신의 코딩 기준 설정 파일 phpcs.xml을 사용하는 경우

필요한 경우 설정 방법을 선택하십시오.

1. PSR2의 코딩 표준을 사용하는 경우

설정 검색창에서 「Code Sniffer」를 넣고 「Editor」→「Inspections」의 「PHP Code Sniffer validation」을 찾아 거기에 체크를 넣는다. 「Severity」(경고도)는 「Warning」으로 바꾼다. 「Coding Standard」는 「PSR2」로 한다.

2. 독자적인 코딩 기준 설정 파일 phpcs.xml 를 사용하는 경우

설정 검색창에서 「Code Sniffer」를 넣고 「Editor」→「Inspections」의 「PHP Code Sniffer validation」을 찾아 거기에 체크를 넣는다. 「Severity」(경고도)는 「Warning」으로 바꾼다.

「Coding Standard」는 「Custom」으로 하고, 「Custom Coding Standard」창을 열면, 「Path to ruleset」에 XML의 패스를 지정한다. 파일 이름이 phpcs.xml이고 프로젝트 루트에 있으면 /opt/project/phpcs.xml를 지정하십시오. 이 /opt/project/ 는 Docker 컨테이너내의 패스이다.