본문: 프로젝트에서 PHP로 개발을 진행하고, 코드 스타일을 일관되게 유지하고 싶다면, Prettier를 사용해 PHP 코드를 자동으로 포맷팅할 수 있습니다. 이 글에서는 Prettier를 PHP 프로젝트에 통합하는 방법을 소개하고자 합니다.
1. Prettier란?
Prettier는 코드 포맷팅 도구로, 여러 프로그래밍 언어에 대한 지원을 제공합니다. 프로젝트에 통합하면, 코드를 일관된 형식으로 자동으로 정리할 수 있어서 코드 리뷰 및 유지보수를 용이하게 합니다.
2. PHP 통합하기
Prettier는 기본적으로 PHP를 지원하지 않습니다. 하지만, PHP-CS-Fixer와 Prettier의 조합을 사용하여 PHP 코드를 포맷팅할 수 있습니다. PHP-CS-Fixer는 PHP 코드 스타일을 체크하고 자동으로 수정하는 도구입니다.
아래는 Prettier와 PHP-CS-Fixer를 통합하기 위한 단계입니다.
2.1 PHP-CS-Fixer 설치
먼저, PHP-CS-Fixer를 프로젝트에 설치해야 합니다. Composer를 사용하여 다음과 같이 설치할 수 있습니다.
composer require friendsofphp/php-cs-fixer --dev
2.2 Prettier 설정
프로젝트 루트 디렉토리에 .prettierrc
파일을 만들고, 다음과 같은 설정을 추가합니다.
{
"overrides": [
{
"files": "*.php",
"options": {
"parser": "php",
"prettier/php": true
}
}
]
}
2.3 Prettier와 PHP-CS-Fixer 통합
프로젝트 루트 디렉토리에 .prettierignore
파일을 만들고, PHP-CS-Fixer가 처리해야 하는 파일을 제외할 수 있습니다. 또한, Git 훅(pre-commit, pre-push 등)을 이용하여 Prettier와 PHP-CS-Fixer를 통합하여 커밋 시 자동으로 코드를 정리할 수 있습니다.
3. 결론
위의 단계를 거쳐 PHP 프로젝트에서 Prettier를 활용하여 코드 포맷팅을 자동화할 수 있습니다. 이를 통해 프로젝트 내의 PHP 코드를 보다 일관된 스타일로 유지하고, 개발자들 간의 협업을 용이하게 할 수 있습니다.