用 Style-CI 檢測 Coding Style

前言#

用 travis-ci 測試 Laravel 應用程式 這篇文章中,我們嘗試了如何使用 Travis-CI 進行持續測試以保持軟體品質。

而在多人共同開發的情況下,coding style 同時也是不可避免的議題。

Style-CI 就是為此而誕生的產品。

設定 Style-CI#

Style-CI 的設定檔名為 .styleci.yml,針對 Laravel 與 Symfony 等常見的 framework 都有預設值。

如果在開發 Laravel 專案,我們可以使用以下內容進行設定

preset: laravel

當然還有其它詳細的設定,可以參見 官方文件

Style-CI 與 php-cs-fixer 的搭配#

以往,我會使用 php-cs-fixer 對 coding style 進行自動修復。

為了與 Style-CI 進行搭配,我使用 sllh/php-cs-fixer-styleci-bridge 這個 composer 套件進行橋接。

composer require sllh/php-cs-fixer-styleci-bridge --dev

並且設定 .php_cs

<?php

require_once __DIR__.'/vendor/sllh/php-cs-fixer-styleci-bridge/autoload.php';

use SLLH\StyleCIBridge\ConfigBridge;

return ConfigBridge::create();

接著使用

php-cs-fixer fix --config-file=.php_cs

如此一來, php-cs-fixer 便會自動套用 .styleci.yml 的設定檔針對整個專案自動進行修改。


本篇文章同步發表於 Chivincent's Blog

《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。