既存コードベースにもPHP_CodeSnifferを導入して楽したい! by 荒巻拓哉

PHP Conference Japan 2023
採択
2023/10/08 15:20〜
トラック4 - 4F コンベンションホール 鶯
レギュラートーク(25分)

既存コードベースにもPHP_CodeSnifferを導入して楽したい!

takaram71 荒巻拓哉 takaram71

多くの現場でコーディング規約が策定され、それに沿った開発が行われています。
私のチームでもコーディング規約があり、実装者とレビュー者がそれぞれチェックを行っていました。
しかし守るべきルールの数は80を超え、人間が限られた時間の中目視でチェックするのは無理がありました。その結果見落としも頻発していました。

大変なことは自動化するのがプログラマの美徳。そこでPHP_CodeSnifferをIDEとCIに導入し、人間の負荷を下げることに成功しました!

しかしその裏では、既存プロジェクトであるが故のいくつもの障壁がありました。
「独自の規約なので、定義済みのルールセットを利用できない……」
「既存コードに違反があるせいで、毎回CIがエラーになる……」

このトークでは、約半年をかけてPHP_CodeSnifferをチームに導入した経験談と、直面した障壁の乗り越え方についてお話しします。