PHPのファイルに差分があるかを(astを使って)調べる君

PHPのファイルに差分があるかを (astを使って)調べる君 ୈ157ճ PHPษڧձˏ౦ژ Hideki Kinjyo
GitHub: o0h / Twitter: @o0h_

自己紹介 • 金城秀樹 / きんじょうひでき • GitHub:@o0h / Twitter:@o0h_ •
好きなFWはCakePHP • アイコンは   美味しい鮭親子丼の写真です

PHPは進化してますね

コーディング規約だって、変わっていく

大体どの会社にも1人はいる人「うちのPJにも   コーディング規約入れましょうよ」

vendor/bin/phpcs、そして─   とっても落ち着く景色(やったね！)

でも、   今やECSやPHP-CS-Fixerがありますもんで。「過去のコードをきれいにする」も、   省エネで出来ちゃう。

???「修正してみました！レビューお願いします！」

このPRを「アリ」にする話

機械に「OK」って言われたら、我々は従うことが出来る

元ネタモノタロウさんのブログで見かけて、ずっと気になっていました https://tech-blog.monotaro.com/entry/2018/09/26/142451

ASTからPHPの世界を見上げる • いわば「品詞」「文法」の変更だけを見ることが出来る • この世界では、インデントや()の省略は「差分がない」 • AST的な変化がない = プログラムも変わってないよね？

スクリプトを「木」構造に

見た目は違うコードも   同じ構造として   解釈される

dumpを取ってみている例 (とっても簡単！)

これを使って、PRを送る時に「AST的な差分」を示せたら良いのでは？

先達も既にいる https://zenn.dev/snowcait/articles/30f44683fed179

作った https://daisuki.nichiyoubi.land/entry/2023/08/15/235930

こんなものを作りました • nikic/php-parser を使って • Gitのコミットハッシュを2つ指定して、差分を検出 • コミットとかブランチとかタグとか • PHPファイルのdiffがあったら、ASTのhashを取って比較
• 変更のある無しを出力

仕組み • `git diff` で差分の発生したファイルを取得 • `git show` で、比較元・比較先のコミットでのファイル全体(ソースコード)を取得
• 取得したソースからASTを生成 <= モノタロウさんの方法ママ • 生成したASTをmd5でハッシュ化 <= モノタロウさんの方法ママ • ハッシュを比較

こんなdiffに・・

こんな結果を出せる「ast-changed」だけ見ればOK

こういうのは差分扱い

こういうのを無視できる • 予約語の大文字/小文字 • スペースやタブ、改行 • 「ヒアドキュメント中の行頭スペース」とかを認識できるのが、git ignore whitespaceとの違い(嬉)
• 省略可能な括弧の有無

今後やりたい • コードはOSSとしてGitHubに晒したい • GitHub Actionsで、PRに対して動かせるようにしたい

まとめ • 安心してクソデカPRを投げられるぞ • 理性的で説明可能な根拠を持って、   レビュアーフレンドリーなPRを投げましょう！ • いろんな便利なものを使って(テストとか静的解析とか)、  
ウキウキPHPライフを！

おしまい！お付き合いいただきありがとうございました!!

PHPのファイルに差分があるかを(astを使って)調べる君

PHPのファイルに差分があるかを(astを使って)調べる君

hideki kinjyo PRO

More Decks by hideki kinjyo

Other Decks in Programming

Featured

Transcript