在 vs code 使用 php cs fixer 進行 coding style 的格式修正

在 vs code 中，使用 PSR1、PSR2 及 Symfony 的 Coding Style 進行格式修正。

安裝

1. 在 command line 使用 homebrew 安裝 php cs fixer

   $ brew install php-cs-fixer

2. 在 vs code 安裝 extension - 由 junstyle 開發的 php cs fixer，extension_id junstyle.php-cs-fixer

3. 其他安裝方式可參考 Install guide

設定

1. 快速鍵 cmd + shift + p 後輸入 workspace settings 貼上

   {
     "php.suggest.basic": false,
     "php.validate.executablePath": "php",
     "php-cs-fixer.executablePath": "php-cs-fixer",
     "php-cs-fixer.executablePathWindows": "",   //eg: php-cs-fixer.bat
     "php-cs-fixer.onsave": false,
     "php-cs-fixer.rules": "",
     "php-cs-fixer.config": ".php_cs",
     "php-cs-fixer.allowRisky": false,
     "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,
   }

   說明：

   • "php-cs-fixer.onsave": true,: true 為存檔時即執行。我個人習慣是設定成 false，在確定程式沒問題後才執行檢查，因此必須按右鍵，再從選單中點擊「Format Document」進行檢查。
   • "php-cs-fixer.rules": "",: 留空字串
   • "php-cs-fixer.config": ".php_cs",: 使用 project root path 下的 config file 最為 formating 基準

2. 在 project root 新增檔案 .php_cs，內容如下

   <?php
   
   $header = <<<'EOF'
   This file is part of PHP CS Fixer.
   
   (c) Fabien Potencier <fabien@symfony.com>
       Dariusz Rumiński <dariusz.ruminski@gmail.com>
   
   This source file is subject to the MIT license that is bundled
   with this source code in the file LICENSE.
   EOF;
   
   $finder = PhpCsFixer\Finder::create()
       ->exclude('tests/Fixtures')
       ->in(__DIR__)
   ;
   
   $config = PhpCsFixer\Config::create()
       ->setRiskyAllowed(true)
       ->setRules([
           '@PHP56Migration' => true,
           '@PHPUnit60Migration:risky' => true,
           '@PSR1' => true,
           '@PSR2' => true,
           '@Symfony' => true,
           '@Symfony:risky' => true,
           'align_multiline_comment' => true,
           'array_indentation' => true,
           'array_syntax' => ['syntax' => 'short'],
           'blank_line_before_statement' => true,
           'binary_operator_spaces' => [
               'align_double_arrow' => true,
               'align_equals' => false,
           ],
           'combine_consecutive_issets' => true,
           'combine_consecutive_unsets' => true,
           'comment_to_phpdoc' => true,
           'compact_nullable_typehint' => true,
           'concat_space' => ['spacing' => 'one'],
           'escape_implicit_backslashes' => true,
           'explicit_indirect_variable' => true,
           'explicit_string_variable' => true,
           'final_internal_class' => true,
           'fully_qualified_strict_types' => true,
           'function_to_constant' => ['functions' => ['get_class', 'get_called_class', 'php_sapi_name', 'phpversion', 'pi']],
           //'header_comment' => ['header' => $header],
           'heredoc_to_nowdoc' => true,
           'increment_style' => false,
           'list_syntax' => ['syntax' => 'short'],
           'logical_operators' => true,
           'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
           'method_chaining_indentation' => true,
           'multiline_comment_opening_closing' => true,
           'no_alternative_syntax' => true,
           'no_binary_string' => true,
           'no_extra_blank_lines' => ['tokens' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block']],
           'no_null_property_initialization' => true,
           'no_short_echo_tag' => true,
           'no_superfluous_elseif' => true,
           'no_unneeded_curly_braces' => true,
           'no_unneeded_final_method' => true,
           'no_unreachable_default_argument_value' => true,
           'no_unset_on_property' => true,
           'no_useless_else' => true,
           'no_useless_return' => true,
           'ordered_class_elements' => true,
           'ordered_imports' => true,
           'php_unit_internal_class' => true,
           'php_unit_ordered_covers' => true,
           'php_unit_set_up_tear_down_visibility' => true,
           'php_unit_strict' => true,
           'php_unit_test_annotation' => true,
           'php_unit_test_case_static_method_calls' => ['call_type' => 'this'],
           'php_unit_test_class_requires_covers' => true,
           'phpdoc_add_missing_param_annotation' => true,
           'phpdoc_order' => true,
           'phpdoc_trim_consecutive_blank_line_separation' => true,
           'phpdoc_types_order' => true,
           'return_assignment' => true,
           'semicolon_after_instruction' => true,
           'single_line_comment_style' => true,
           'strict_comparison' => true,
           'strict_param' => true,
           'string_line_ending' => true,
           'ternary_operator_spaces' => true,
           'trim_array_spaces' => true,
           'unary_operator_spaces' => true,
           'yoda_style' => true,
           'whitespace_after_comma_in_array' => true,
       ])
       ->setFinder($finder)
   ;
   
   // special handling of fabbot.io service if it's using too old PHP CS Fixer version
   if (false !== getenv('FABBOT_IO')) {
       try {
           PhpCsFixer\FixerFactory::create()
               ->registerBuiltInFixers()
               ->registerCustomFixers($config->getCustomFixers())
               ->useRuleSet(new PhpCsFixer\RuleSet($config->getRules()));
       } catch (PhpCsFixer\ConfigurationException\InvalidConfigurationException $e) {
           $config->setRules([]);
       } catch (UnexpectedValueException $e) {
           $config->setRules([]);
       } catch (InvalidArgumentException $e) {
           $config->setRules([]);
       }
   }
   
   return $config;

   說明：

   • 加入 '@PSR1' => true, 及 '@Symfony' => true,

3. 重新啟動 vs code（建議使用 cmd + Q，再重新啟動）

4. 編輯檔案後存檔，即自動執行 php-cs-fixer 進行 coding style 修正