快速修正專案 PHP Coding Standards

底下是之前的投影片教導創業團隊制定 PHP 程式碼規範,讓工程師可以遵循此規則達到團隊合作

投影片內容都是現有 PHP FIG Group 所制定的 PSR-0, PSR-1, PSR-2 規則,那如何將既有專案的 Coding Style 轉換成上述標準呢,可以透過 PHP Coding Standards Fixer tool 來快速完成,此工具是由 Symfony Framework 完成。透過此工具可以快速且無痛轉換程式碼風格,舉個簡單例子:

本來

1
2
3
4
5
<?php
if ($a > $b)
{
    .....
}

轉換後變成

1
2
3
4
<?php
if ($a > $b) {
    .....
}

也可以透過指定的方式來修正,例如: indentation (將 Tabs 轉換成 4 Spaces),trailing_spaces (去除單行程式碼結尾空白),php_closing_tag (忽略檔案結尾 ?> 符號) … 等,大家可以到官網看看,如果是透過 wget 方式下載,請務必轉換該執行檔權限

1
$ chmod 755 /usr/local/bin/php-cs-fixer

如果是用在修正其他 Framework 上面,請務必注意 PSR-0 規則會跟 Framework 命名方式相衝突 (如命名方式 by CodeIgniter)


See also