SideCI Blog

自動コードレビューサービスSideCIを提供している株式会社アクトキャットのコーポレートブログです。



PHP_CodeSniffer 3.0への移行のご案内

PHP_CodeSnifferはPHPのコーディングスタンダードのチェックを自動化し、チームで統一するための非常に優れたツールです。SideCIでは、バージョン2.9.1をサポートしており、既に多くのお客様にご利用いただいております。

先日、PHP_CodeSniffer 3.0がリリースされました。従来、解析ツールのアップデートはバックグラウンドで自動的に行われておりましたが、今回のアップデートでは後方互換性のため、設定の切り替えによって2.9.xと3.0を同時にご利用いただけるようになっております。

ご利用方法

ルートディレクトリ配下にsideci.ymlを作成していただき、以下のようにversion: 3を指定することで、今すぐPHP_CodeSniffer 3.0をお試しいただけます。

linter:
  code_sniffer:
    version: 3

なお、特にバージョンを指定されない場合には、従来通り2.9.xによる解析が実行されます。

後方互換性について

多くの場合、特別な設定無しに3.0をそのままご利用いただけますが、PEARやPSR2などの標準で用意されているコーディングスタンダード以外をご利用の場合には、3.0のために設定の修正が必要になる場合がございます。詳しくは公式のアップグレードガイドをご覧ください。

また、2.9.xではCakePHP, CodeIgniter, FuelPHP, Symfony, WordPressなどのサードパーティ製コーディングスタンダードをサポートしておりましたが、3.0では、2017年7月3日時点でCakePHPのみの対応となります。それぞれのバージョンでご利用いただけるコーディングスタンダードは以下の通りです。

2.9.x

$ phpcs -i
The installed coding standards are FuelPHP, Symfony2, CodeIgniter, CakePHP, PEAR, Zend, Squiz, PSR2, PHPCS, PSR1, MySource, WordPress-Docs, WordPress-Extra, WordPress-VIP, WordPress and WordPress-Core

3.0

$ phpcs3 -i
The installed coding standards are MySource, PEAR, PSR1, PSR2, Squiz, Zend and CakePHP

今後のサポートについて

PHP_CodeSnifferの新機能は3.0以降のみに取り込まれていき、2.9.xにはセキュリティパッチと深刻なバグ修正のみの反映となります。そのため、可能な限り多くのお客様に3.0をご利用いただければと考えております。本機能に関しまして、ご不明点がある場合には、お気軽にSideCI上のチャットボタンからお問い合わせください。

※本機能はアビシニアンモードのみ対象となります。クラシックモードをご利用のお客様は従来通り2.9.xのみのサポートとなります。