使用 PHP-CS-Fixer 自動規範化你的 PHP 代碼

良好的代碼規範能夠提升代碼可讀性,團隊溝通維護成本。最推薦你們遵照的是 php-fig(PHP Framework Interop Group) 組織定義的 PSR-1PSR-2 兩個。不瞭解的同窗能夠先經過鏈接點擊過去閱讀下。php

PHP-CS-Fixer

項目地址: https://github.com/FriendsOfPHP/PHP-CS-Fixerlaravel

用來自動格式化你的代碼。git

經過安裝 Composer 安裝

composer.phar global require fabpot/php-cs-fixer

請確保~/.composer/vendor/bin目錄在你的系統PATH中。github

export PATH="$PATH:$HOME/.composer/vendor/bin"

更多請查看installationcomposer

使用fix命令

使用 fix 指令修復文件夾或文件的代碼風格curl

php php-cs-fixer.phar fix /path/to/dir
php php-cs-fixer.phar fix /path/to/file

使用 --level 選項設置修復至的「規範」。ide

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

更多使用方式參見 Usage工具

同類型的還有phpmd網站

PHPCS

項目地址: https://github.com/squizlabs/PHP_CodeSniffer/ui

用來檢測你的代碼規範。

經過安裝 Composer 安裝

composer global require "squizlabs/php_codesniffer=*"

還能夠使用PEAR

pear install PHP_CodeSniffer

下載phar(PHP-CS-Fixer也能夠使用此方法)

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar -h
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
php phpcbf.phar -h

而後移動到命令目錄,並添加執行權限:

// 也許須要 sudo
mv phpcs.phar /usr/bin/phpcs
mv phpcbf.phar /usr/bin/phpcbf
chmod +x /usr/bin/phpcs
chmod +x /usr/bin/phpcbf

更多細節請參考:https://github.com/squizlabs/PHP_CodeSniffer/#installation

StyleCI

github上的一款檢測代碼規範的工具 StyleCI 是一個 Laravel5 項目,功能實現也是由 PHP-CS-Fixer 驅動。

它能夠本身分析你項目的 pull request,而且在你 merge 前顯示出分析的結果。

項目地址:https://github.com/StyleCI/StyleCI

官方網站:https://styleci.io/

相關連接

http://blog.csdn.net/cyaspnet/article/details/51773331 https://laravel-china.org/topics/547

相關文章
相關標籤/搜索