此文章同步刊登於我的部落格
在PHP的團隊開發中，可以確保每個開發人員的Coding Style相同，是相當重要的工具。本篇文章將會詳細說明PHP CS Fixer在Linux環境下的安裝方式。
注意: 本文撰寫時，PHP CS Fixer支援的PHP最低版本是7.4
安裝
一、下載
- 使用wget指令下載
wget https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
- 修改權限
sudo chmod a+x php-cs-fixer
- 移動到Linux系統的PATH環境變數資料夾(/usr/bin/可以根據需要修改)
sudo mv php-cs-fixer /usr/bin/php-cs-fixer
二、Composer安裝
- 在Linux中安裝Composer文章連結
- 在專案資料夾中執行composer指令
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer - 執行檔路徑如下
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
三、驗證是否安裝成功
- 執行
php-cs-fixer指令php-cs-fixer -V
若出現PHP CS Fixer版本訊息則代表成功安裝
四、直接使用
- 可以指定檔案或資料夾進行修正(不含隱藏檔、vendor中的檔案)，預設使用
@PSR12的規則php-cs-fixer fix /path/to/dir
php-cs-fixer fix /path/to/file - 實際修正前可以先用以下指令，確認有哪些檔案會被改動
php-cs-fixer list-files /path/to/dir
- 也可以指定規則
php-cs-fixer fix /path/to/dir --rules=@PSR12
- 使用自訂的規則檔案(自訂規則檔案的官方文件)
php php-cs-fixer.phar list-files --config=.php-cs-fixer.dist.php
五、編輯設定檔
以下是一個設定檔的範例(官方範例)：
<?php
return (new PhpCsFixer\Config())
->setRules([
'@PSR12' => true,
'array_indentation' => true,
'array_syntax' => ['syntax' => 'short'],
'combine_consecutive_unsets' => true,
'class_attributes_separation' => ['elements' => ['method' => 'one',]],
'multiline_whitespace_before_semicolons' => false,
'single_quote' => true,
'binary_operator_spaces' => [
'operators' => [
// '=>' => 'align',
// '=' => 'align'
]
],
// 'blank_line_after_opening_tag' => true,
// 'blank_line_before_statement' => true,
'braces' => [
'allow_single_line_closure' => true,
],
// 'cast_spaces' => true,
// 'class_definition' => array('singleLine' => true),
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => true,
'function_typehint_space' => true,
'single_line_comment_style' => ['comment_types' => ['hash']],
'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_blank_lines_before_namespace' => true,
// 'no_empty_comment' => true,
// 'no_empty_phpdoc' => true,
// 'no_empty_statement' => true,
'no_extra_blank_lines' => [
'tokens' => [
'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,
// 'increment_style' => 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' => ['elements' => ['arrays']],
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'whitespace_after_comma_in_array' => true,
'space_after_semicolon' => true,
// 'single_blank_line_at_eof' => false
])
// ->setIndent("\t")
->setLineEnding("\n");
如果你使用的是Laravel，也可以使用我的慣用設定檔
$rules = [
'@Symfony' => true,
'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
'cast_spaces' => ['space' => 'none'],
'ordered_class_elements' => true,
// 'method_argument_space' => true,
'list_syntax' => true,
'no_useless_return' => true,
'explicit_string_variable' => true,
'yoda_style' => false,
'no_useless_else' => true,
'global_namespace_import' => true,
'combine_consecutive_unsets' => true,
'declare_equal_normalize' => ['space' => 'single'],
'concat_space' => ['spacing' => 'one'],
'ternary_to_null_coalescing' => true,
'multiline_whitespace_before_semicolons' => true,
'array_indentation' => true,
'blank_line_before_statement' => true,
'method_chaining_indentation' => true,
'phpdoc_to_comment' => false,
'phpdoc_var_annotation_correct_order' => true,
// 'phpdoc_add_missing_param_annotation' => true,
// 'class_definition' => true,
];
$finder = PhpCsFixer\Finder::create();
// ignore laravel blade file
$finder->exclude(['vendor'])
->notName('*.blade.php');
return (new PhpCsFixer\Config())
->setRules($rules)
->setIndent(' ')
->setLineEnding("\n")
->setFinder($finder);
環境
- Elementary OS 7 (Ubuntu 22.04)
- PHP 7.4
