PSR 코딩을위해 VS Code 에 php-cs-fixer 적용

그동안 내가 좋게 보이는대로 코딩을 진행해 왔는데.. 더 이상은 그러면 안될 것 같아서 PSR 표준에 맞춰서 코딩을 진행하기 위해 VS Code 에 php-cs-fixer 확장을 설치하기로 했다. 표준에 맞게 코딩을 하면 좋은 거겠지만 하다보면 빼먹는 부분도 있을테니.. 그리고 자동화된 툴이 있다면 그 툴을 사용하는 게 효과적인 코딩이라고 생각한다.

VS Code 에 설치한 php-cs-fixer 확장이다. 서치 과정에서 composer를 이용해 php-cs-fixer 를 먼저 설치해야한다는 등의 내용이 있어 나도 일단 설치를 진행했었는데.. 이거 VS Code 확장 중 Remote Development 확장을 이용해 원격 서버에 직접 연결해 작업을 진행하는 경우는 php-cs-fixer 가 작동하지 않는 현상이 있었다. 그래서 원격 서버에서는 composer 로 설치한 php-cs-fixer 를 제거하고 Remote Development 로 연결된 원격 서버에 위의 확장을 설치하니 정상 작동됨을 확인할 수 있었다. 로컬에서 개발 작업을 진행한다면 composer 로 php-cs-fixer를 설치해야만 한다.

composer global require friendsofphp/php-cs-fixer

로컬에 php-cs-fixer 를 설치했다면 윈도우 환경의 경우 아래와 같이 환경 변수에 php-cs-fixer 경로를 추가해줘야 한다.

php-cs-fixer 확장 설치 후 settings.json 파일에 아래 설정을 추가한다.

"[php]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "junstyle.php-cs-fixer",
},
"php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar",
"php-cs-fixer.executablePathWindows": "php-cs-fixer.bat",
"php-cs-fixer.onsave": true,
"php-cs-fixer.rules": "@PSR2",
"php-cs-fixer.config": ".php_cs;.php_cs.dist",
"php-cs-fixer.allowRisky": false, //it is safe not to allow risky linting
"php-cs-fixer.pathMode": "override",
"php-cs-fixer.exclude": [],
"php-cs-fixer.autoFixByBracket": true,
"php-cs-fixer.autoFixBySemicolon": false,
"php-cs-fixer.formatHtml": false,
"php-cs-fixer.documentFormattingProvider": true,

Remote Development 확장을 사용하여 원격 서버에서 작업하는 경우는 "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar", 부분에 의해 php-cs-fixer 확장에 포함된 php-cs-fixer.phar 이 실행된다. 추가적으로 워크스페이스의 루트 디렉토리에 .php_cs 또는 .php_cs.dist 의 설정 파일이 존재하면 이 파일을 이용한다. .php_cs 파일의 설정 예저는 아래와 같다.

<?php

return PhpCsFixer\Config::create()
    ->setRules(array(
        '@PSR2' => true,
        'array_indentation' => true,
        'array_syntax' => array('syntax' => 'short'),
        'combine_consecutive_unsets' => true,
        'method_separation' => true,
        'no_multiline_whitespace_before_semicolons' => true,
        'single_quote' => true,

        'binary_operator_spaces' => array(
            'align_double_arrow' => false,
            'align_equals' => false,
        ),
        // 'blank_line_after_opening_tag' => true,
        // 'blank_line_before_return' => true,
        'braces' => array(
            'allow_single_line_closure' => true,
        ),
        // 'cast_spaces' => true,
        // 'class_definition' => array('singleLine' => true),
        'concat_space' => array('spacing' => 'one'),
        'declare_equal_normalize' => true,
        'function_typehint_space' => true,
        'hash_to_slash_comment' => true,
        'include' => true,
        'lowercase_cast' => true,
        // 'native_function_casing' => true,
        // 'new_with_braces' => true,
        // 'no_blank_lines_after_class_opening' => true,
        // 'no_blank_lines_after_phpdoc' => true,
        // 'no_empty_comment' => true,
        // 'no_empty_phpdoc' => true,
        // 'no_empty_statement' => true,
        'no_extra_consecutive_blank_lines' => array(
            'curly_brace_block',
            'extra',
            'parenthesis_brace_block',
            'square_brace_block',
            'throw',
            'use',
        ),
        // 'no_leading_import_slash' => true,
        // 'no_leading_namespace_whitespace' => true,
        // 'no_mixed_echo_print' => array('use' => 'echo'),
        'no_multiline_whitespace_around_double_arrow' => true,
        // 'no_short_bool_cast' => true,
        // 'no_singleline_whitespace_before_semicolons' => true,
        'no_spaces_around_offset' => true,
        // 'no_trailing_comma_in_list_call' => true,
        // 'no_trailing_comma_in_singleline_array' => true,
        // 'no_unneeded_control_parentheses' => true,
        // 'no_unused_imports' => true,
        'no_whitespace_before_comma_in_array' => true,
        'no_whitespace_in_blank_line' => true,
        // 'normalize_index_brace' => true,
        'object_operator_without_whitespace' => true,
        // 'php_unit_fqcn_annotation' => true,
        // 'phpdoc_align' => true,
        // 'phpdoc_annotation_without_dot' => true,
        // 'phpdoc_indent' => true,
        // 'phpdoc_inline_tag' => true,
        // 'phpdoc_no_access' => true,
        // 'phpdoc_no_alias_tag' => true,
        // 'phpdoc_no_empty_return' => true,
        // 'phpdoc_no_package' => true,
        // 'phpdoc_no_useless_inheritdoc' => true,
        // 'phpdoc_return_self_reference' => true,
        // 'phpdoc_scalar' => true,
        // 'phpdoc_separation' => true,
        // 'phpdoc_single_line_var_spacing' => true,
        // 'phpdoc_summary' => true,
        // 'phpdoc_to_comment' => true,
        // 'phpdoc_trim' => true,
        // 'phpdoc_types' => true,
        // 'phpdoc_var_without_name' => true,
        // 'pre_increment' => true,
        // 'return_type_declaration' => true,
        // 'self_accessor' => true,
        // 'short_scalar_cast' => true,
        'single_blank_line_before_namespace' => true,
        // 'single_class_element_per_statement' => true,
        // 'space_after_semicolon' => true,
        // 'standardize_not_equals' => true,
        'ternary_operator_spaces' => true,
        // 'trailing_comma_in_multiline_array' => true,
        'trim_array_spaces' => true,
        'unary_operator_spaces' => true,
        'whitespace_after_comma_in_array' => true,
    ))
    //->setIndent("\t")
    ->setLineEnding("\n")
;