なぜPHPStanやPHP CodeSnifferを導入するのか 〜受託開発編〜

PHPerKaigi2024の登壇資料です。

Transcript

1. PHPerKaigi 2024 @9rokirishima なぜPHPStanやPHP CodeSnifferを導入するのか 〜受託開発編〜
2. 自己紹介 • 緒方 大佑(おがた だいすけ) • X：くろきり(@9rokirishima) • 所属 ◦ Growfit株式会社 ◦ 開発やったりマネージャーやったり
3. 弊社の現在状況 • 基本的に新規案件に適用 • 使用ツール ◦ PHP-CS-Fixer ◦ PHPStan(レベル6) • BitbucketPipelineを使い、ブランチをpushする時にチェック が走る
4. なぜ導入したのか？
5. 書き方が違うコード読むの辛い
6. • 案件跨いでレビューやデバッグしてると少しづつ違うのが読んでい てストレスになってくる ◦ なんなら同じプロダクト内で書き方が違う ◦ PSR-12で統一するというルールはあるけど形骸化 • 保守が弊社じゃなかったとしてもプロダクトの今後のために極力読 みやすいコードにして他社に渡したい 静的解析入れて読みやすいコードを保ちたい
7. 導入までの道のり
8. メンバーに相談 次のPJから静的解析 入れたいんだけど… (めんどくさがられるかなぁ…)
9. メンバーに相談 わかりました！ !?!?
10. あっさり導入決定！
11. これで全て上手くいく！
12. とはならない
13. 適用したPJの体制 • PM(くろきり) • バックエンドチーム • フロントエンドチーム • ブロックチェーンチーム 静的解析の運用はバックエンドチームにお願いした
14. しばらく経って 納期迫ってるし修正に時間 かかるので全然使ってないです !? 導入してみてどう？
15. 導入自体にはポジティブだけど 継続しようとするとことろにハードルがある 最初はやってたけど 納期が… うち保守やらないし… 他のところは入れなく てもやれてるし…
16. 反省点 • いきなり運用をお願いしてしまったこと ◦ 急にまかせても上手くできないのは当たり前 • 完了の定義に静的解析によるチェックが含まれていなかった ◦ 「実装でやるべきこと」ではなく「新しい作業」が増えてるように 感じて負担になっている
17. 改めていく
18. 変えたこと • 自分の方でみんなが使える所まで設定とフォローを行う ◦ 新規案件用のベースブランチに予め組み込み、pushすれば 自動でBitbucketPipelineでチェックが走るように ◦ IDEの設定もドキュメントにまとめる • 実装完了の定義に静的解析によるチェックも含める ◦ 今の所は回っている ◦ 上手く進まない時にアラートが上がりやすくなってる
19. 改善余地はまだまだあるけど 徐々によくなっていってる
20. • 契約形態は関係なくて、プロダクトに必要ならツール入れよう • 導入したいなら皆がやり切れる仕組みまで作る まとめ
21. ご清聴ありがとうございました！