PHPStan による静的解析の導入

[nanasess]

概要(Overview・Refs Issue)

3系より、静的解析ツールとしてScrutinizerを導入しているが、あまり活用されていない。
PHPStan でチェックしたところ、明らかに問題のあるコードが発覚したため、 GitHub Actions に導入してみる

PHPStan については、以下が詳しい

• https://engineering.mercari.com/blog/entry/phpstan/
• PHPで開発が捗るリアルタイムエラーチェック

方針(Policy)

• GitHub Actions で PHPStan の Workflow を実行する
• phpstan.neon.dist でデフォルトの設定をしておく
  • level: 0
  • Twig_Extensions_Extension_Intl で定義されている一部のグローバル関数を PHPStan が見つけてくれないため、エラーから除外
• PHPStan のエラーが発生した場合は、 Workflow をエラーとする

実装に関する補足(Appendix)

PHPStan で発見したエラーについては、別途 PR を作成します(#4838)

テスト（Test)

PHPStan のエラーで Workflow がエラーになることを確認

相談（Discussion）

実験的な導入なので、 GitHub Actions で composer require phpstan/phpstan を実行しているが、良さげなら require-dev に入れたい

マイナーバージョン互換性保持のための制限事項チェックリスト

• 既存機能の仕様変更
• フックポイントの呼び出しタイミングの変更
• フックポイントのパラメータの削除・データ型の変更
• twigファイルに渡しているパラメータの削除・データ型の変更
• Serviceクラスの公開関数の、引数の削除・データ型の変更
• 入出力ファイル(CSVなど)のフォーマット変更

レビュワー確認項目

• 動作確認
• コードレビュー
• E2E/Unit テスト確認(テストの追加・変更が必要かどうか)
• 互換性が保持されているか
• セキュリティ上の問題がないか

[okazy]

#4838 #4845 が取り込まれましたので4.0ブランチの内容をマージしてプッシュします。
一応マージ前のエラー内容を残しておきます。こちらが全て消えるはず。

[nanasess]

@okazy 1箇所漏れがあったので修正しました

[okazy]

通ったので取り込みます。

[okazy]

ありがとうございます！取り込みました！