PHP에서 코드 스타일 검사를 위해 PHP-CS-Fixer를 사용하는 방법

개발 과정에서 좋은 코딩 스타일은 코드 품질과 가독성을 향상시키는 데 중요한 요소입니다. 오늘날 시장에서 가장 널리 사용되는 프로그래밍 언어 중 하나인 PHP의 코드 스타일 검사도 특히 중요합니다. 여기서는 PHP 코드 스타일 검사 도구인 PHP-CS-Fixer를 소개하고, 이에 대한 코드 스타일 검사 방법을 자세히 설명하겠습니다.

먼저 PHP-CS-Fixer가 무엇인지 이해해야 합니다. PHP-CS-Fixer는 Symfony 프레임워크에서 만든 PHP 코드 스타일 검사 도구입니다. 이 도구를 통해 PHP 프로젝트의 일관성과 고품질 코딩 스타일을 쉽게 유지할 수 있으므로 코드의 가독성과 유지 관리성이 향상됩니다.

그럼 코드 스타일 확인을 위해 PHP-CS-Fixer를 사용하는 방법은 무엇입니까? 자세한 단계는 다음과 같습니다.

1단계: PHP-CS-Fixer 설치

먼저 Composer를 사용하여 PHP-CS-Fixer를 설치해야 합니다. Composer는 PHP에서 가장 널리 사용되는 종속성 관리자이며 PHP 종속성을 설치하고 관리하는 데 사용할 수 있습니다.

명령줄에서 다음 명령을 실행하여 PHP-CS-Fixer를 설치하세요.

composer require --dev friendsofphp/php-cs-fixer

2단계: PHP-CS-Fixer 구성 파일 만들기

다음으로 PHP-CS-Fixer 구성 파일을 만들어야 합니다. 이 구성 파일은 관용구, 들여쓰기, 공백, 줄 바꿈 등과 같은 세부 사항과 따라야 하는 규칙 등을 지정합니다. 개인이나 팀의 필요에 따라 규칙을 수정하거나 추가할 수 있습니다.

프로젝트 루트 디렉터리에 ".php_cs" 파일을 만들고 여기에 다음 코드를 붙여넣습니다.

<?php

$finder = SymfonyComponentFinderFinder::create()
    ->exclude('vendor')
    ->exclude('node_modules')
    ->exclude('storage')
    ->exclude('public')
    ->in(__DIR__)
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return SymfonyCSConfigConfig::create()
    ->level(SymfonyCSFixerInterface::PSR2_LEVEL)
    ->fixers([
        'array_syntax' => ['syntax' => 'short'],
        'blank_line_after_opening_tag',
        'braces',
        'cast_spaces',
        'class_definition',
        'concat_without_spaces',
        'declare_equal_normalize',
        'function_call_space',
        'function_declaration',
        'indentation',
        'line_after_namespace',
        'linefeed',
        'lowercase_constants',
        'lowercase_keywords',
        'method_argument_space',
        'native_function_casing',
        'new_with_braces',
        'no_blank_lines_after_class_opening',
        'no_empty_phpdoc',
        'no_empty_statement',
        'no_extra_blank_lines',
        'no_leading_import_slash',
        'no_leading_namespace_whitespace',
        'no_mixed_echo_print',
        'no_multiline_whitespace_before_semicolons',
        'no_short_bool_cast',
        'no_spaces_after_function_name',
        'no_spaces_inside_parenthesis',
        'no_trailing_comma_in_list_call',
        'no_trailing_comma_in_singleline_array',
        'no_trailing_whitespace',
        'no_trailing_whitespace_in_comment',
        'no_unneeded_control_parentheses',
        'no_unused_imports',
        'no_whitespace_before_comma_in_array',
        'no_whitespace_in_blank_line',
        'normalize_index_brace',
        'object_operator', 
        'operators_spaces',
        'php_closing_tag',
        'phpdoc_align',
        'phpdoc_no_access',
        'phpdoc_no_empty_return',
        'phpdoc_no_package',
        'phpdoc_scalar',
        'phpdoc_single_line_var_spacing',
        'phpdoc_summary',
        'phpdoc_to_comment',
        'phpdoc_trim',
        'phpdoc_type_to_var',
        'phpdoc_var_without_name',
        'remove_leading_slash_use',
        'remove_lines_between_uses',
        'return',
        'self_accessor',
        'short_array_syntax',
        'single_array_no_trailing_comma',
        'single_blank_line_before_namespace',
        'single_quote',
        'spaces_before_semicolon',
        'spaces_cast',
        'standardize_not_equals',
        'ternary_spaces',
        'trim_array_spaces',
        'unalign_double_arrow',
        'unalign_equals',
        'unary_operators_spaces',
        'unused_use',
    ])
    ->finder($finder);

위 구성에는 다음과 같은 일련의 규칙이 포함되어 있습니다.

• PSR-2 코드 스타일 사양 사용
• 쓸모없는 사용은 금지됩니다.
• 단일 파일에 여러 네임스페이스를 금지합니다.
• 배열 초기화 등에서 중복된 쉼표를 사용하는 것을 금지합니다.

본 규칙은 개인 취향에 따라 변경될 수 있습니다. 이 예에서는 Symfony 프레임워크에서 권장하는 몇 가지 규칙을 사용합니다.

3단계: PHP-CS-Fixer 실행

마지막으로 PHP-CS-Fixer를 사용하여 PHP 코드를 확인할 수 있습니다. 명령줄에 다음 명령을 입력하면 됩니다.

vendor/bin/php-cs-fixer fix

이 명령은 전체 프로젝트에서 모든 PHP 파일을 찾아 해당 파일에 사용된 부적절한 코드 형식을 수정합니다. 물론 이 명령은 지정된 규칙에 따라 코드 스타일을 확인하기 위해 일부 매개변수를 사용할 수도 있습니다. 예:

vendor/bin/php-cs-fixer fix src/ --rules=@PSR2

위 명령은 "src" 폴더에 있는 코드의 PSR-2 스타일을 확인합니다.

요약:

PHP-CS-Fixer는 프로그래머가 프로젝트 코드의 일관성과 가독성을 유지하는 데 도움이 되는 매우 실용적인 PHP 코드 스타일 검사 도구입니다. 위에 소개된 단계를 사용하면 PHP-CS-Fixer를 사용하여 쉽게 코드 스타일 검사를 수행하여 코드 품질을 향상시킬 수 있습니다.

위 내용은 PHP에서 코드 스타일 검사를 위해 PHP-CS-Fixer를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!