PHP CS Fixer는 무엇이며 코드를 더 깔끔하게 유지하는 데 어떻게 도움이 됩니까?

PHP CS 해결사는 무엇입니까

PHP CS Fixer는 PHP Coding Standards Fixer의 약자입니다. 이것은 표준을 따르도록 코드를 수정하는 도구입니다. 인기 있는 PSR-1, 및 PHP 프레임워크 상호 운용성 그룹에서 게시한 PSR-12과 같이 따를 수 있는 다양한 PHP 코딩 표준이 있습니다(PSR 표준의 전체 목록은 here에서 찾을 수 있음).

Symphony 과 같은 다른 커뮤니티 기반 표준도 있습니다.

PHP CS Fixer를 사용하면 한 번에 여러 코딩 표준을 따르거나 구성을 통해 자신 또는 팀의 코딩 표준을 정의할 수도 있습니다. 특히 JavaScript 및 Eslint로 작업한 적이 있다면 PHP CS Fixer를 Eslint for PHP의 대안으로 생각하십시오.

코드에서 코딩 표준을 수동으로 수정하는 것은 매우 지루한 프로세스이므로 PHP CS Fixer는 훌륭한 솔루션입니다. 이는 귀하와 귀하의 팀이 코드를 작성할 때 모두 동일한 규칙을 따르도록 하여 코드를 더 깔끔하게 유지하는 데 도움이 됩니다.

설치

PHP CS Fixer를 설치하는 권장 방법은 프로젝트의 전용 디렉토리(예: tools/php-cs-fixer)에서 Composer을 사용하는 것입니다.

mkdir --parents tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

자세한 내용 및 기타 설치 방법은 installation instructions 을 참조하십시오.

용법

사용법: 옵션 1

위에서 설명한 대로 PHP CS Fixer를 설치했다고 가정하면 다음 명령을 실행하여 src 디렉토리에 있는 PHP 파일을 수정할 수 있습니다.

tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src

자세한 내용은 usage , built-in rules 목록 , rule sets 목록 및 configuration file 설명서를 참조하십시오. 도구에서 지원하지 않는 코드 스타일을 적용해야 하는 경우 다음을 수행할 수 있습니다create custom rules.

사용법: 옵션 2(에디터 통합)

그러나 명령을 수동으로 실행하는 것은 편리한 접근 방식이 아닌 것 같습니다. 저는 개인적으로 PHP Storm에서 미리 구성된 키보드 단축키를 눌러 PHP CS Fixer를 실행하는 것을 선호합니다.

아래 설명된 대로 다양한 코드 편집기에 대해 PHP CS Fixer를 구성할 수 있습니다.

Atom

NetBeans

PhpStorm

Sublime Text

Vim

VS Code

사용법: 옵션 3(커밋할 때마다 PHP CS Fixer 실행)

다른 옵션으로 Husky 및 lint-staged 을 사용하여 모든 커밋에서 코드를 수정할 수 있습니다. 이러한 도구를 사용하면 PHP CS Fixer가 준비된 파일, 즉 커밋하려는 파일에서 실행됩니다. Here is a great article PHP CS Fixer와 함께 작동하도록 이러한 도구를 설정하는 방법을 설명합니다.

PHP CS Fixer를 구성하는 쉬운 방법

PHP Coding Standards를 처음 사용하고 PHP CS Fixer를 빠르게 구성하려는 경우 PHP CS Fixer Configurator by Michele Locati 을 사용하는 것이 좋습니다. 자체 구성을 선택하고 생성할 수 있는 미리 정의된 규칙 집합이 있습니다.



대부분의 규칙을 클릭하면 규칙, 사용 가능한 구성 옵션 및 사용 예에 ​​대한 일반 정보가 표시됩니다. 이 도구로 생성된 PHP CS Fixer 구성 파일을 프로젝트에서 사용하기 위해 내보낸 다음 일부 수정을 원하는 경우 다시 가져올 수 있습니다.

원천

FriendsOfPHP/PHP-CS-Fixer: A tool to automatically fix PHP Coding Standards issues

PHP-CS-Fixer Configurator

끝. 이 기사가 도움이 되었기를 바랍니다. 더 많은 콘텐츠를 기대해주세요!

저를 지원하고 싶다면 buy me a coffee :)