PHPStanをチームに内緒で開発に取り入れる方法

PHP勉強会 in 大阪(03/27)
CLI/PHPStormでの実行方法とLaravel用拡張larastanの導入方法を「おまけ①②③」として末尾に入れています。
https://kansai-web-app-dev.connpass.com/event/311195/

Transcript

1. PHPStanをチームに内緒で 開発に取り入れる方法 株式会社ヘッドジャパン Natsuki
2. PHPStan使ってますか?
3. PHPStan使ってますか? • PHPの静的解析ツール
4. PHPStan使ってますか? • PHPの静的解析ツール • PHPDocに書いた型でチェックしてくれる
5. PHPStan使ってますか? • PHPの静的解析ツール • PHPDocに書いた型でチェックしてくれる • 未然に潜在的なエラーや問題を見つける
6. PHPStan使ってますか? • PHPの静的解析ツール • PHPDocに書いた型でチェックしてくれる • 未然に潜在的なエラーや問題を見つける • levelの設定でルールの厳しさを調整できる
7. PHPStanが無いとき ‘aaaa’が渡されたとき nullが返る 引数が数値を表す文字列で あれば、int型に変換する
8. PHPStanがあるとき 指摘してくれる！！
9. こんなエラーが出る int型を返すべきなのに、return文がmissingだよ
10. PHPStanすごい！うちのPJにも欲しい！！
11. PHPStanすごい！うちのPJにも欲しい！！ • composer.jsonに変更が入るから仕事で触ってるPJに入れるには、 チームの同意が要る でも、、、
12. PHPStanすごい！うちのPJにも欲しい！！ • composer.jsonに変更が入るから仕事で触ってるPJに入れるには、 チームの同意が要る でも、、、 • 個人的なPJなら自由に入れられるけど、大した規模じゃ無いからあん まりエラーも無い
13. PHPStanすごい！うちのPJにも欲しい！！ • composer.jsonに変更が入るから仕事で触ってるPJに入れるには、 チームの同意が要る でも、、、 • 個人的なPJなら自由に入れられるけど、大した規模じゃ無いからあん まりエラーも無い ごめんよ、うちでは飼ってあげられないんだ
14. PHPStanすごい！うちのPJにも欲しい！！ • composer.jsonに変更が入るから仕事で触ってるPJに入れるには、 チームの同意が要る でも、、、 • 個人的なPJなら自由に入れられるけど、大した規模じゃ無いからあん まりエラーも無い ごめんよ、うちでは飼ってあげられないんだ そんなことない！！！
15. 仕事で触ってるPJに入れてみよう！！
16. 仕事で触ってるPJに入れてみよう！！ project-a composer.json L src L vendor L
17. 仕事で触ってるPJに入れてみよう！！ project-a composer.json L src L vendor L my-phpstan composer.json L vendor L phpstan.neon L
18. 仕事で触ってるPJに入れてみよう！！ project-a composer.json L src L vendor L my-phpstan composer.json L vendor L phpstan.neon L .gitignore
19. 1. サブディレクトリにPHPStanをインストール 2. phpstan.neonを作成 3. IDEの設定(vscode) 4. 実行 手順
20. 1.サブディレクトリにPHPStanをインストール composer init PJを初期化 my-phpstan内で
21. 1.サブディレクトリにPHPStanをインストール composer init composer install phpstan/phpstan --dev PJを初期化 PHPStanをインストール my-phpstan内で ~/.config/git/ignore にmy-phpstanを追記
22. 2. phpstan.neonを作成 ルールの厳しさ(0〜8) 解析する対象のパス (project-aのsrc) NEON(YAMLみたいなやつ)で記述
23. 2. phpstan.neonを作成 project-a composer.json L src L vendor L my-phpstan composer.json L vendor L phpstan.neon L
24. 4. IDEの設定(vscode) 拡張機能をインストール https://marketplace.visualstudio.com/items?itemName=SanderRonde.phpstan-vscode
25. 4. IDEの設定(vscode) 設定を変更
26. 5. 実行！！
27. 5. 実行！！ 戻り値の型が定義されていない関数だと
28. 5. 実行！！ 「戻り値の型を指定してね」
29. 注意
30. 注意 • 常にエラーが出てるので他のエラーに気付きにくくなる
31. 注意 • 常にエラーが出てるので他のエラーに気付きにくくなる • 型情報を書かない人への不満が溜まる （PHPStanが絶対正しいわけじゃない）
32. 注意 • 常にエラーが出てるので他のエラーに気付きにくくなる • 型情報を書かない人への不満が溜まる （PHPStanが絶対正しいわけじゃない） • あくまで使い方を学ぶため ◦ levelを変えてみたり、色んな型を試したり
33. 注意 • 常にエラーが出てるので他のエラーに気付きにくくなる • あくまで使い方を学ぶため ◦ levelを変えてみたり、色んな型を試したり そして、ある程度使えるようになったらチームに布教して 型安全な開発体験の素晴らしさを共有 • 型情報を書かない人への不満が溜まる （PHPStanが絶対正しいわけじゃない）
34. おまけ①（PHPStormの場合） PHPStormは標準でvscodeの拡張機能と同等の機能がある この辺の設定が必要
35. my-phpstan\\vendor\\bin\\phpstan analyze --configuration="./my-phpstan/phpstan.neon" cliのコマンドだと おまけ②（CLIでの実行）
36. おまけ③（Laravelの場合） 1. phpstan/phpstanは不要でnunomaduro/larastanを使う 使用しているlaravelのバージョンによってlarastanのバージョンも違うので注意 2. サブディレクトリにorchestra/testbenchをインストール Laravelを普通に入れてもいいけどこっちの方が軽量 3. phpstan.neonにincludesを追加 4. GooGee/ide-helper-file/から_ide_helper.phpをダウンロード 5. 自作Facadeがあれば追記 6. excludePathsに_ide_helper.phpを追加しておくといいかも larastanのREADME.mdを参考にしてください