StyleCIを使ってPHPのコーディングスタイルをチェックする (1)

StyleCIはPHPのコーディングスタイルチェックに特化したCI支援サービスです。Travis CIなどと同様に、オープンソースプロジェクトの場合は無料で利用できます。このエントリでは、Githubでホストされているオープンソースプロジェクトに対して、StyleCIの導入と設定を行う方法を解説します。

StyleCIのサインアップ

GithubのOAuthを使い、StyleCIのトップページからサインアップします。Githubアカウントを持っていない場合は、まずGithubで取得しておいて下さい。準備が整ったら、SIGN UP FOR FREEをクリックしてGithubのOAuthの認可ページに遷移します。

スクリーンショット
Style CI sign upページ

Review Permissionsの内容をよく読んで、Style CIによるこのアクセスを了承できるのであれば、Authorize applicationをクリックして認可します。

GithubのOAuthでサインアップする
GithubのOAuthでサインアップする

サインアップに成功すると、StyleCIのユーザーページに遷移するはずです。

StyleCIのアカウントページ
StyleCIのアカウントページ

StyleCIでのコーディングスタイルの解析を有効化する

ユーザーページのReposのタブに、あなたの公開しているGithubリポジトリの一覧が表示されるはずです。表示されていなかったり、これからStyleCIを使った解析を有効化したいリポジトリが見つからない場合はSYNC WITH GITHUBをクリックして同期すると見つけることができるかもしれません。

StyleCIのUIでGithubリポジトリの一覧を表示する
StyleCIのUIでGithubリポジトリの一覧を表示する

目的のリポジトリを探し、ENABLE STYLECIをクリックしてStyleCIでの解析を有効化してください。有効化されるとSHOW ANALYSESボタンが現れ、クリックすることで解析結果のページへ遷移できるようになります。

リポジトリの解析を有効化する
リポジトリの解析を有効化する

WebのGUIからコーディングスタイルを解析してみる

解析結果ページには、このGUIから解析を実行できるANALYZE NOWボタンや、これまでの解析ログのリストなどが表示されています。

解析結果一覧のページ
解析結果一覧のページ

ANALYZE NOWをクリックして、早速解析を行ってみましょう。新しい解析ログが追加されるはずですので、SHOW DETAILSボタンを押して解析結果の詳細を表示してみます。解析により修正すべき点が見つかった場合、ステータスはfailedになります。

コーディングスタイルの解析結果が表示される
コーディングスタイルの解析結果の詳細が表示される

解析結果は、StyleCIがPHPのコーディングスタイルを修正した結果との差分で表示されます。

コーディングスタイルの差分表示
コーディングスタイルの差分表示

この修正を受け入れる場合、CREATE FIX PRのリンクをクリックすることで、Githubリポジトリの当該ブランチへのプルリクエストを作成することができます。GithubのGUIなどからマージしましょう。

自動で作成されたプルリクエスト
自動で作成されたPull Request

なお、このスクリーンショットでは、同時にTravis CIのビルドも走っていることがわかります。StyleCIのデフォルトの設定 (preset: recommended)により、array() (fixer: long_array_syntax)がPHP5.4以降で使用できる[] (fixer: short_array_syntax)で表現されるよう修正がなされ、PHP5.3でのビルドが失敗しています。
https://travis-ci.org/KamataRyo/oembed-travis/jobs/140457723#L380

次回は設定ファイルを使ったコーディングスタイルの詳細な設定や、Githubへのpushにフックして、Style CIにおいて自動でスタイル解析を走らせる方法について解説します。また、上記のビルドエラーを修正する設定を行います。