프로젝트 및 팀 간에 PHPCS 규칙 공유

PHPCS는 지정된 코딩 표준의 코드 스타일 위반을 감지하고 자동으로 수정 가능한 규칙에 대한 자동 수정을 제공하는 오픈 소스 CLI 도구입니다. Pint 또는 PHP-CS-Fixer를 직접 사용하더라도 컬렉션에 PHPCS를 추가하는 것을 고려해야 합니다.

팀 설정에서 여러 프로젝트에 걸쳐 PHPCS 규칙을 정의하는 것은 지루한 작업이며 프로젝트 간에 규칙 드리프트가 발생할 수밖에 없습니다. 많은 생각이나 노력 없이 프로젝트 전체에 일관된 규칙을 적용하고 싶을 것입니다.

이 자습서를 마치면 모든 PHP 프로젝트를 빠르게 스캔하는 데 사용할 수 있는 조직 규칙 집합을 만드는 방법을 알게 됩니다.

이 시리즈의 첫 번째 파트에서는 ​​Laravel 프로젝트에서 PHP Codesniffer를 사용하는 방법을 배웠습니다. 이 튜토리얼은 Laravel 프로젝트에서 생성한 규칙 세트를 사용자 정의 Composer 패키지로 이동합니다.

배경

“Laravel Pint와 PHP CS Fixer가 있는데 왜 PHPCS를 사용해야 합니까?”라고 물을 수 있습니다. 이러한 도구를 경쟁자로 생각하기보다는 각각 고유하고 가치 있는 코드 스타일 제안 및 수정 사항을 제공하는 보완 도구로 생각하십시오. PHPCS는 파일입니다. 린터PHP-CS-Fixer는 개혁가.

실제로 이러한 유형의 도구는 중복됩니다. PHP-CS-Fixer에는 확장 기능이 있는 확인 기능이 있습니다. --dry-run 특징. PHPCS에는 파일이 포함되어 있습니다. phpcbf PHPCS 스니퍼 위반을 자동으로 수정하는 CLI 도구입니다. 하지만, phpcbf 사용 가능한 모든 기반에 맞지는 않습니다.

예를 들어 라인 길이 위반을 감지하고 보고하도록 PHPCS를 구성할 수 있습니다. 그러나 PHPCS는 도구가 긴 줄을 나누는 방법을 결정할 수 없기 때문에 이러한 위반을 자동으로 수정할 수 없습니다.

스크린샷은 줄이 120자를 초과할 때 경고하고 80자를 초과하지만 여전히 120자 제한 내에 있는 줄에 대해 경고하는 줄 길이 구성을 보여줍니다. 이는 코드의 상태를 유지하고 줄 길이와 같은 항목을 정리하는 데 유용할 수 있습니다.

시작

모든 프로젝트에서 재사용할 수 있는 사용자 지정 규칙 집합을 만들려면 새 PHP 작성자 패키지를 만들어야 합니다. PHPCS는 이러한 규칙을 알아야 하므로 작곡가 설치 프로그램 Composer를 통해 인코딩 표준을 쉽게 설치할 수 있는 패키지입니다.

시작하기 전에 패키지를 만들고 Git 및 Composer를 시작하겠습니다.

mkdir phpcs
cd phpcs
git init
composer init

일단 실행 composer initComposer는 패키지 이름과 같은 것을 정의하라는 메시지를 표시합니다. 최소한 패키지 이름, 선택적으로 설명을 입력하고 프롬프트를 완료하십시오. 수동으로 종속성을 요구하므로 대화식으로 설치하는 것에 대해 걱정하지 마십시오.

Composer 패키지에서 PHPCS 표준을 더 쉽게 감지하려면 이제 Composer Installer 패키지를 설치해야 합니다.

composer require --dev \
  dealerdirect/phpcodesniffer-composer-installer

또한 작곡가 설치 프로그램을 사용하려면 파일을 지정해야 합니다. type 재산 phpcodesniffer-standard. Composer Installer 플러그인은 다음을 사용하여 규칙 세트를 검색합니다. type 속성은 프로젝트에 설치된 모든 Composer 패키지에 있습니다.

결국 composer.json 파일은 다음과 유사해야 합니다.

{
    "name": "bitpressio/phpcs",
    "type": "phpcodesniffer-standard",
    "authors": [
        {
            "name": "Paul Redmond",
            "email": "[email protected]"
        }
    ],
    "require-dev": {
        "dealerdirect/phpcodesniffer-composer-installer": "^1.0"
    },
    "config": {
        "allow-plugins": {
            "dealerdirect/phpcodesniffer-composer-installer": true
        }
    }
}

우리는 Composer 패키지를 정의하는 데 필요한 모든 것을 갖추고 있으며, 이를 작동시키기 위해 해야 할 일은 자체 규칙 세트를 정의하는 것뿐입니다.

규칙 정의

Composer 패키지에는 다음이 포함됩니다. ruleset.xml 모든 프로젝트에 설치할 파일입니다. 내 규칙 집합에 이름을 지정했습니다. Bitpress따라서 규칙 세트가 들어 있는 내 프로젝트에 폴더를 만들어야 합니다.

mkdir Bitpress
touch Bitpress/ruleset.xml

이 시리즈의 첫 번째 부분에서 규칙 세트를 만들었으므로 다음 콘텐츠를 ruleset.xml규칙 세트라고 부르는 값을 대체하려면 다음을 수행하십시오.

<?xml version="1.0"?>
<!-- @see https://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
<ruleset name="Bitpress PHPCS Rules">
 
    <description>PHPCS ruleset for Bitpress</description>
 
    <!-- Use colors in output -->
    <arg name="colors"/>
 
    <!-- Show progress of the run -->
    <arg value="p"/>
 
    <!-- Show sniff codes in all reports -->
    <arg value="s"/>
 
    <!-- Our base rule: set to PSR12 -->
    <rule ref="PSR12">
        <exclude name="PSR12.Traits.UseDeclaration.MultipleImport" />
        <exclude name="PSR12.Operators.OperatorSpacing.NoSpaceBefore" />
        <exclude name="PSR12.Operators.OperatorSpacing.NoSpaceAfter" />
    </rule>
 
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="lineLimit" value="80"/>
            <property name="absoluteLineLimit" value="120"/>
        </properties>
    </rule>
 
    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>
 
    <exclude-pattern>*/.phpstorm.meta.php</exclude-pattern>
    <exclude-pattern>*/_ide_helper.php</exclude-pattern>
    <exclude-pattern>*/*.blade.php</exclude-pattern>
    <exclude-pattern>*/autoload.php</exclude-pattern>
    <exclude-pattern>*/vendor/*</exclude-pattern>
 
</ruleset>

우리의 규칙 집합에는 사용자 지정 스니프가 포함되지 않지만 포함된 항목에 따라 선호하는 설정을 선택합니다. PSR12 규칙의 집합.

맞춤형 규칙 세트를 시작하는 데 필요한 모든 것이 있습니다! Composer 패키지가 게시되면 파일로 요청할 수 있습니다. --dev 인증.

프로젝트에서 규칙 세트 설정

패키지를 Composer 패키지로 게시한 후에는 다음과 같이 프로젝트에 설치할 수 있습니다.

composer require --dev bitpressio/phpcs

그만큼 작곡가 설치 프로그램 종속성은 Composer 패키지에서 표준을 검색하고 설치할 수 있도록 코드 실행 권한을 요청합니다. 그가 선택하다 y 플러그인을 활성화하려면:

이 시점에서 사용자 정의 규칙 세트가 설치되었으며 다음 명령으로 확인할 수 있습니다.

vendor/bin/phpcs -i
The installed coding standards are
MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend,
Bitpress and VariableAnalysis

그만큼 --show-info 플래그는 우리에게 더 많은 정보를 보여줄 수 있습니다:

vendor/bin/phpcs --config-show
Using config file: /Users/paul/code/sandbox/bitpress-phpcs/vendor/squizlabs/php_codesniffer/CodeSniffer.conf
 
installed_paths: ../../bitpressio/phpcs,../../sirbrillig/phpcs-variable-analysis

마지막으로 다음을 사용하여 규칙 세트를 기본값으로 만들 수 있습니다.

vendor/bin/phpcs --config-set default_standard Bitpress

각 개발자가 수동으로 규칙을 기본값으로 설정하도록 할 수 있습니다. 그러나, composer.json 다음과 같이 자동으로 실행할 수 있습니다.

"scripts": {
    "post-package-install": "vendor/bin/phpcs --config-set default_standard Bitpress"
}

명령을 다시 시작하면 이제 규칙 세트가 기본값이 됩니다.

vendor/bin/phpcs --config-show
...
default_standard: Bitpress

거의 완료되었지만 설치를 완료하기 위해 약간의 조정이 필요합니다.

프로젝트 규칙 세트 구성 결정

규칙 세트가 설치되고 기본값으로 설정됩니다. 그러나 우리가 실행하면 phpcs 다음 메시지를 받게 됩니다.

vendor/bin/phpcs
ERROR: You must supply at least one file or directory to process.
 
Run "phpcs --help" for usage information

우리의 규칙 집합이 기본값이지만 PHPCS에 검사할 파일과 폴더를 지시하는 구성을 제공해야 합니다. 파일을 생성하자 phpcs.xml 프로젝트의 루트에서:

<?xml version="1.0"?>
<!-- @see https://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
<ruleset name="My App">
    <file>app</file>
    <file>tests</file>
 
    <rule ref="Bitpress"></rule>
</ruleset>

당신이 실행하는 경우 phpcs 귀하의 프로젝트에서 (새로운 Laravel 애플리케이션에서 이것을 테스트했습니다) PHPCS는 파일을 스캔합니다 app/ 그리고 tests/ 줄 길이에 대한 몇 가지 주의 사항을 제거해야 합니다. 원하는 대로 이러한 경로를 자유롭게 구성하십시오.

함유되어 있다

PHPCS 규칙의 빠른 정리에서 우리는 조직 전체에서 공유할 수 있는 사용자 지정 규칙 집합이 포함된 작성자 패키지를 게시했습니다. 여러 프로젝트에서 정적 검사를 원하는 경우 이 접근 방식이 유용할 것입니다.