php-cs-fixer - PHP 編碼格式化工具

時間  2019-11-10
標籤 php fixer 編碼 格式化 工具 欄目 PHP 简体版
原文   原文鏈接

php-cs-fixer 是個代碼格式化工具，格式化的標準是 PSR-一、PSR-2 以及一些 symfony 的標準。這個工具也和 symfony、twig 等優秀的 PHP 庫出自同門。php

安裝與更新

須要使用 PHP 5.3.6 以上的版本。git

你能夠直接下載封裝好的 phar 包：php-cs-fixer.phar；github

或者經過 wget 下載（下面的都是 OSX 和 Linux 上的用法）：vim

wget http://get.sensiolabs.org/php-cs-fixer.phar -O php-cs-fixer

或者經過 curl 下載：數組

curl http://get.sensiolabs.org/php-cs-fixer.phar -o php-cs-fixer

下載完成後給可執行的權限，而後移動到 bin 目錄下面便可：緩存

sudo chmod a+x php-cs-fixer
sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer

這樣就能夠在任何地方直接使用 php-cs-fixer 命令來調用了。composer

也能夠用過 Composer 來安裝：curl

composer global require fabpot/php-cs-fixer

若是你是 Mac 用戶、homebrew 用戶而且已經 tap 過 homebrew/php 的話，也能夠直接：phpstorm

brew install php-cs-fixer

或者：編輯器

brew install homebrew/php/php-cs-fixer

若是後續須要更新的話：

php-cs-fixer self-update

若是是經過 homebrew 安裝的：

brew upgrade php-cs-fixer

若是沒有將執行文件放到 bin 目錄下或者在 Windows須要使用 php php-cs-fixer.phar 代替 php-cs-fixer。

用法

用法也很簡單，最基本的命令參數就是 fix，直接執行時會盡量多的根據默認標準格式化代碼：

# 格式化目錄 若是是當前目錄的話能夠省略目錄
php-cs-fixer fix /path/to/dir
# 格式化文件
php-cs-fixer.phar fix /path/to/file

--verbose 選項用於展現應用了的規則，默認是文本（txt）格式。

--level 選項用於控制須要使用的規則層級：

php-cs-fixer fix /path/to/project --level=psr0
php-cs-fixer fix /path/to/project --level=psr1
php-cs-fixer fix /path/to/project --level=psr2
php-cs-fixer fix /path/to/project --level=symfony

默認狀況下執行的是 PSR-2 的全部選項以及一些附加選項（主要是 symfony 相關的）。還有一些屬於『貢獻級別』的選項，你能夠經過 --fixers 選擇性的添加，--fixers 的多個條件要用逗號分開：

php-cs-fixer fix /path/to/dir --fixers=linefeed,short_tag,indentation

若是有須要的話也可使用 -name_of_fixer 採起黑名單的方式設定禁用哪些選項。若是同時設定了 --fixers 和 -name_of_fixer，前者的優先級更高。

同時使用 --dry-run 和 --diff 命令能夠顯示出須要修改的彙總，可是並不實際修改。

經過如下方式也能夠查看有哪些內容是會修改的，可是並不實際改動文件：

cat foo.php | php-cs-fixer fix --diff -

自定義配置

--config 選項能夠用來設置選取目錄以及文件進行分析並格式化，可是這個選項只能設置一些常見的已知的項目，好比 symfony：

# For the Symfony 2.3+ branch
php-cs-fixer fix /path/to/sf23 --config=sf23

已有選項：

  • default 默認配置

  • magento magento 項目

  • sf23 symfony 的項目

更多時候，咱們能夠經過配置文件來自定義格式化選項以及搜索的目錄和文件。自定義配置經過在項目根目錄添加一個 .php_cs 文件的方式實現。

設置自己就是 PHP 代碼，最後返回一個 Symfony\CS\ConfigInterface 的實例便可。你能夠設置格式化的選項、級別、文件以及目錄。

下面是一個簡單的例子：

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->exclude('somedir') // 忽略 somedir
    ->in(__DIR__) // 當前目錄
;

return Symfony\CS\Config\Config::create()
    ->fixers(['strict_param', 'short_array_syntax']) // 添加兩個選項
    ->finder($finder)
;

若是你想徹底自定義格式化選項，就須要將格式化級別清空，並指定好全部須要的選項：

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->in(__DIR__)
;

return Symfony\CS\Config\Config::create()
    ->level(Symfony\CS\FixerInterface::NONE_LEVEL)
    ->fixers(['trailing_spaces', 'encoding'])
    ->finder($finder)
;

你也能夠經過在選項前面添加 - 的方式來禁用某些選項，好比下面這個例子不採用 PSR-0：

<?php

$finder = Symfony\CS\Finder\DefaultFinder::create()
    ->exclude('somedir')
    ->in(__DIR__)
;

return Symfony\CS\Config\Config::create()
    ->fixers(['-psr0'])
    ->finder($finder)
;

默認條件下的格式化級別是 symfony (最嚴格)，你能夠修改這個級別：

<?php

return Symfony\CS\Config\Config::create()
    ->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
;

經過這些設置選項的組合，能夠很輕易的定製出本身想要的效果。

你也能夠經過 --config-file 選項指定 .php_cs 文件的位置。

啓用緩存能夠在後續的執行中加快速度，經過如下方法設置：

<?php

return Symfony\CS\Config\Config::create()
    ->setUsingCache(true)
;

編輯器插件

下面這些編輯器/IDE 的插件能夠幫你簡化格式化的工做：

格式化選項

  • psr0 [PSR-0]
    PSR-0 的路徑和命名空間標準

  • encoding [PSR-1]
    文件必須是不帶 BOM 的 UTF-8 編碼；

  • short_tag [PSR-1]
    只能使用 <?php ?> 和 <?= ?> 兩種 PHP 代碼標籤；

  • braces [PSR-2]
    全部語句塊都必須包含在花括號內，且位置以及縮進是符合標準的；

  • class_definition [PSR-2]
    class、trait、interfaces 關鍵字和名稱之間只能有一個空格；

  • elseif [PSR-2]
    使用 elseif 替代 else if；

  • eof_ending [PSR-2]
    文件必須以空白行結尾；

  • function_call_space [PSR-2]
    調用函數和方法時，函數名和方法名與參數擴展之間不能有空格；

  • function_declaration [PSR-2]
    函數聲明時空格的使用須要符合 PSR-2；

  • indentation [PSR-2]
    代碼必須使用四個空格縮進而不是製表符；

  • line_after_namespace [PSR-2]
    命名空間的聲明後必須有一個空白行；

  • linefeed [PSR-2]
    全部 PHP 文件都只能使用 LF(Unix) 結尾；

  • lowercase_constants [PSR-2]
    PHP 常量 true、false 和 null 必須使用小寫；

  • lowercase_keywords [PSR-2]
    PHP 關鍵字必須都是小寫；

  • method_argument_space [PSR-2]
    方法聲明及調用時，參數之間的逗號前不能有空格，逗號後必須有一個空格；

  • multiple_use [PSR-2]
    每一個 use 只能聲明一個元素；

  • parenthesis [PSR-2]
    圓括號內兩側不能有空格；

  • php_closing_tag [PSR-2]
    純 PHP 文件必須省略 ?> 標籤；

  • single_line_after_imports [PSR-2]
    每一個 use 聲明獨立一行，且 use 語句塊以後要有一個空白行；

  • trailing_spaces [PSR-2]
    刪除非空行以後多餘的空格；

  • visibility [PSR-2]
    每一個屬性和方法都必須指定做用域是 public、protected 仍是 private，abstract 和 final 必須位於做用域關鍵字以前，static 必須位於做用域以後；

  • array_element_no_space_before_comma [symfony]
    數組聲明中，逗號以前不能有空格；

  • array_element_white_space_after_comma [symfony]
    數組聲明中，逗號以後必須有一我的空格；

  • blankline_after_open_tag [symfony]
    PHP 開始標籤的同一行不能有代碼，且下面必須有一個空白行；

  • concat_without_spaces [symfony]
    點鏈接符左右兩邊不能有多餘的空格；

  • double_arrow_multiline_whitespaces [symfony]
    => 操做符兩端不能有多個空白行；

  • duplicate_semicolon [symfony]
    刪除重複的分號；

  • empty_return [symfony]
    return 語句若是沒有任何返回的話直接寫 return 便可（不用 return null）；

  • extra_empty_lines [symfony]
    刪除多餘的空白行；

  • function_typehint_space [symfony]
    修正函數參數和類型提示之間的缺失的空格問題；

  • include [symfony]
    include 和文件路徑之間須要有一個空格，文件路徑不須要用括號括起來；

  • join_function [symfony]
    使用 join 替換 implode 函數；

  • list_commas [symfony]
    刪除 list 語句中多餘的逗號；

  • method_argument_default_value [symfony]
    函數參數中有默認值的參數不能位於無默認值的參數以前；

  • multiline_array_trailing_comma [symfony]
    多行數組最後一個元素應該也有一個逗號；

  • namespace_no_leading_whitespace [symfony]
    命名空間前面不該該有空格；

  • new_with_braces [symfony]
    使用 new 新建實例時後面都應該帶上括號；

  • no_blank_lines_after_class_opening [symfony]
    類開始標籤後不該該有空白行；

  • no_empty_lines_after_phpdocs [symfony]
    PHP 文檔塊開始開始元素下面不該該有空白行；

  • object_operator [symfony]
    T_OBJECT_OPERATOR (->) 兩端不該有空格；

  • operators_spaces [symfony]
    二進制操做符兩端至少有一個空格；

  • phpdoc_indent [symfony]
    phpdoc 應該保持縮進；

  • phpdoc_inline_tag [symfony]
    修正 phpdoc 內聯標籤格式，使標籤與後續內容始終位於一行；

  • phpdoc_no_access [symfony]
    @access 不該該出如今 phpdoc 中；

  • phpdoc_no_empty_return [symfony]
    @return void 和 @return null 不該該出如今 phpdoc 中；

  • phpdoc_no_package [symfony]
    @package 和 @subpackage 不該該出如今 phpdoc 中；

  • phpdoc_params [symfony]
    @param, @throws, @return, @var, 和 @type 等 phpdoc 標籤都要垂直對齊；

  • phpdoc_scalar [symfony]
    phpdoc 標量類型聲明時應該使用 int 而不是 integer，bool 而不是 boolean，float 而不是 real 或者 double；

  • phpdoc_separation [symfony]
    phpdoc 中註釋相同的屬性應該放在一塊兒，不一樣的屬性之間應該有一個空白行分割；

  • phpdoc_short_description [symfony]
    phpdoc 的簡要描述應該以 .、! 或 ? 結尾；

  • phpdoc_to_comment [symfony]
    文檔塊應該都是結構化的元素；

  • phpdoc_trim [symfony]
    除了文檔塊最開始的部分和最後的部分，phpdoc 開始和結束都應該是有內容的；

  • phpdoc_type_to_var [symfony]
    @type 須要使用 @var 代替；

  • phpdoc_types [symfony]
    phpdoc 中應該正確使用大小寫；

  • phpdoc_var_without_name [symfony]
    @var 和 @type 註釋中不該該包含變量名；

  • pre_increment [symfony]
    不該該使用 ++i 或 --i 的用法；

  • print_to_echo [symfony]
    若是可能的話，使用 echo 代替 print 語句；

  • remove_leading_slash_use [symfony]
    刪除 use 前的空行；

  • remove_lines_between_uses [symfony]
    刪除 use 語句塊中的空行；

  • return [symfony]
    return 以前應該有一個空行；

  • self_accessor [symfony]
    在當前類中使用 self 代替類名；

  • short_bool_cast [symfony]
    bool 類型數據前不該該試用兩個感嘆號；

  • single_array_no_trailing_comma [symfony]
    PHP 單行數組最後一個元素後面不該該有空格；

  • single_blank_line_before_namespace [symfony]
    命名空間聲明前應該有一個空白行；

  • single_quote [symfony]
    簡單字符串應該使用單引號代替雙引號；

  • spaces_after_semicolon [symfony]
    修復分號後面的空格；

  • spaces_before_semicolon [symfony]
    禁止只有單行空格和分號的寫法；

  • spaces_cast [symfony]
    變量和修飾符之間應該有一個空格；

  • standardize_not_equal [symfony]
    使用 <> 代替 !=；

  • ternary_spaces [symfony]
    三元運算符之間的空格標準化；

  • trim_array_spaces [symfony]
    數組須要格式化成和函數/方法參數相似，上下沒有空白行；

  • unalign_double_arrow [symfony]
    不對其 =>；

  • unalign_equals [symfony]
    不對其等號；

  • unary_operators_spaces [symfony]
    一元運算符和運算數須要相鄰；

  • unneeded_control_parentheses [symfony]
    刪除控制結構語句中多餘的括號；

  • unused_use [symfony]
    刪除沒有用到的 use 語句；

  • whitespacy_lines [symfony]
    刪除空白行中多餘的空格；

除了以上這些選項之外，還有一些用戶貢獻的選項，這裏就再也不一一介紹了。

對於代碼風格是否統一，執行什麼樣的標準，每一個人、每一個團隊可能都有本身的見解。這裏只是介紹一下這個工具，至於如何選用，還在於你們本身。若是是開源項目，你也能夠試用一下 StyleCI。

私博地址：http://0x1.im

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程