Mac용 PhpStorm에 PHP CodeSniffer를 통합하는 방법

본고에서는 Mac의 PhpStorm에 PHP CodeSniffer를 통합해, 에디터상에서 코드의 문제점을 확인할 수 있도록 하는 설정 방법을 소개한다.

phpcs 명령 설치

composer에서 phpcs를 설치합니다.

composer global require "squizlabs/php_codesniffer=3.2.3"

버전 확인

$ ~/.composer/vendor/bin/phpcs --version
PHP_CodeSniffer version 3.2.3 (stable) by Squiz (http://www.squiz.net)

PhpStorm 설정 절차

phpcs 설정하기

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


phpcs의 전체 경로 확인

ls ~/.composer/vendor/bin/phpcs
/Users/suin/.composer/vendor/bin/phpcs

「PHP Code Sniffer (phpcs) path」에 위에서 조사한 풀 패스 「/Users/suin/.composer/vendor/bin/phpcs」등을 입력하고 「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의 패스를 지정한다.