[PHP] PHP 코드스니퍼(phpcs)

안녕하세요! 

이전 포스팅에서 PSR-1, PSR-2 를 알아봤는데요..

이번에는 코딩스타일을 검사할 수 있는 도구인 PHP 코드스니퍼 phpcs 에 대해 알아보겠습니다.

 

설치하는 법과 phpstorm 에 연동하는 방법을 알아보겠습니다.

일단 설치를 해야겠죠?

 

1. phpcs 설치하기

composer global require squizlabs/php_codesniffer

 

2. PhpStorm 에 연동하기

 

PhpStorm 2024.3.5 기준으로 연동해 보겠습니다.

 

혹시 PhpStorm을 업데이트를 하려면, JetBrains Toolbox를 최신 버전으로 새로 설치 후 업데이트 해야합니다.

2024.3.5 를 사용하겠습니다. 곧 2025.1 도 릴리즈되긴 했으나, Toolbox에 나와있는 2024.3.5 를 사용합니다.

 

 

2022 버전을 쓰다가 2024 버전으로 하니 UI가 많이 바뀌었네요! ㅎㅎ

 

파일 -> 설정 -> PHP -> 품질 도구 -> PHP_CodeSniffer 로 들어가 봅니다.

선택한 구성에서 PHP_CodeSniffer 경로가 비어 있다고 나옵니다.

상단에 구성: 디폴트 프로젝트 인티프리티별 이라고 되어 있는 select box 옆의 ... 을 선택하세요

새로 뜬 창에서 PHP_CodeSniffer 경로를 선택해 줍니다.

 

phcs 가 설치된 위치는 

C:/Users/<사용자>/AppData/Roaming/Composer/vendor/bin/phpcs.bat

이니 참고해 주세요.. 저는 "시스템 PHP" 를 선택하고 PHP 스니퍼의 경로를 지정해 주었어요.

 

그리고, 아래처럼 PHP_CodeSniffer 유효성 검사를 체크해주셔야 콘솔에서 확인할 수 있어요.

 

이제 적용하고, 확인하면 끝입니다~!

 

확인하는 방법은...콘솔에서 검사별 그룹화를 하신다음에!!

 

아래처럼 phpcs 로 걸러낸 메시지들을 확인할 수 있습니다.

 

그럼 이제 즐거운 코딩되세요~!