PHP 코드를 작성할 때 일관된 코드 사양에 따라 코드의 가독성과 유지 관리에 중요합니다. 그러나 최신 PHP 인코딩 표준을 준수하도록 코드를 수동으로 조정하는 것은 매우 지루하고 시간이 많이 걸릴 수 있습니다. 다행스럽게도 PHP 코드 생성 도구의 도움 으로이 프로세스를 자동화하고 최신 PHP 코드 사양을 준수하는 코드 스 니펫을 쉽게 생성 할 수 있습니다.
이 기사는 일반적인 PHP 코드 생성 도구 인 PHP-CS-Fixer를 소개하며, 이는 일련의 사전 설정 규칙을 기반으로 PHP 코드의 사양 문제를 자동으로 수정할 수 있습니다.
먼저 PHP-CS-Fixer를 설치하고 구성해야합니다. 설치하려면 명령 줄에서 다음 명령을 실행하십시오.
composer global require friendsofphp/php-cs-fixer
설치가 완료되면 설치 디렉토리를 시스템 환경 변수에 추가하여 모든 디렉토리에서 PHP-CS-Fixer를 사용할 수 있도록하십시오.
도구를 설치 한 후 다음 명령을 사용하여 코드에서 사양 문제를 확인할 수 있습니다.
php-cs-fixer fix src/
이 명령은`src/`디렉토리의 모든 PHP 파일을 가로 지르고 사전 설정 규칙에 따라 코드의 사양 문제를 수정합니다. 수리 된 코드는 원본 파일을 직접 덮어 쓸 것이므로이 명령을 실행하기 전에 코드 백업을 수행하는 것이 좋습니다.
전체 프로젝트의 코드를 수정하기 위해 명령을 수동으로 실행하는 것 외에도 구성 파일을 편집하여 규칙을 사용자 정의 할 수도 있습니다. 프로젝트의 루트 디렉토리에서`.php_cs.dist`라는 파일을 작성하고 다음 내용을 작성하십시오.
<?php
$finder
= PhpCsFixerFinder::create()
->exclude(
'vendor'
)
->in(__DIR__);
return
PhpCsFixerConfig::create()
->setRules([
'@PSR12'
=> true,
'trailing_comma_in_multiline'
=> true,
// 其他规则...
])
->setFinder(
$finder
);
이 구성 파일에서는`$ finder`를 통해 확인 해야하는 폴더와 파일을 정의하고`exclude '메소드를 사용하여`vendor'디렉토리를 제외합니다. 그런 다음 구성 객체는 phpcsfixerconfig :: create를 통해 생성되며 규칙은 setrules 메소드를 사용하여 정의됩니다.
예를 들어,`@psr12` 규칙은 'true'로 설정되어 최신 PSR-12 코드 사양이 따랐음을 나타냅니다. 또한``reaming_comma_in_multiline '과 같은 다른 규칙을 사용자 정의 할 수 있으며,이 규칙은 멀티 라인 배열 또는 매개 변수 목록에 쉼표를 추가합니다.
규칙을 구성한 후에는 코드를 수정하기 위해 다음 명령 만 실행하면됩니다.
php-cs-fixer fix
이 명령은 현재 디렉토리에서 모든 PHP 파일을 자동으로 찾아서 복구합니다.
특정 파일 만 복구하려면 명령 후 파일 경로를 지정할 수 있습니다.
php-cs-fixer fix path/to/file.php
PHP-CS-Fixer와 같은 PHP 코드 생성 도구를 사용하면 코드의 일관성, 가독성 및 유지 관리 가능성을 크게 향상시킬 수 있습니다. 이 도구는 사전 설정 규칙을 기반으로 코드를 자동으로 수리 할뿐만 아니라 프로젝트 요구를보다 잘 충족시키기 위해 규칙을 사용자 정의 할 수 있습니다.
이러한 도구는 코드 사양 문제를 자동으로 수정할 수 있지만 수리 후 수동 리뷰를 수행하는 것이 좋습니다. 모든 수리 작업이 프로젝트의 실제 요구를 충족하도록합니다.