KotlinのソースコードをASTレベルで書き換えるツールを作っている話

■ 発表者
Bill One Engineering Unit
加藤 耕太

■ Bill One 開発エンジニア 採用情報
https://media.sansan-engineering.com/billone-engineer

Transcript

1. Sansan株式会社 部署 名前 Kotlinのソースコードを ASTレベルで書き換えるツールを 作っている話 Bill One Engineering Unit 加藤 耕太
2. 写真が入ります 加藤 耕太（Kota Kato） Sansan株式会社 技術本部 Bill One Engineering Unit＠関⻄⽀店 Sansan株式会社所属のソフトウェアエンジニア。 インボイス管 理サービス「Bill One」のアーキテクトとして、サーバーサイド Kotlinを含む技術選定から⽴ち上げに関わり、現在に⾄るまで開 発および技術マネジメントに従事。 最近は Kotlin / TypeScript / React / Google Cloud をよく触っている。 著書：Pythonクローリング&スクレイピング データ収集・解析のための実践開発ガイド
3. 今⽇お話ししたいこと - KotlinのソースコードをASTレベルで書き換えるツールを作っている話 > 背景 > 作っているツール: ktcodeshift > まとめ ※AST: Abstract Syntax Tree, 抽象構⽂⽊ ⽊構造として表現
4. 背景
5. モチベーション Kotlinで⻑く開発する上で、Kotlinのソースコードを ⼀括で書き換える⼿段を持っておきたい 括弧の対応など、正規表現による単純な⼀括置換では難しい場合もある 例えば - JUnit 4 → 5への移⾏ - Ktor 1.x → 2.xへの移⾏（Location→Resourceへの移⾏） - アプリケーションで共通利⽤している関数のシグネチャ変更
6. IntelliJ IDEAのStructural search and replace機能 既存の⽅法1 Structural search and replace | IntelliJ IDEA https://www.jetbrains.com/help/idea/structural-search-and-replace.html
7. Structural search and replaceの制約 - UIからしか実⾏できず、試⾏錯誤しづらい - ⼤きく変えようとすると予期しない結果になった 期待 実際
8. kastreeというKotlinのASTを操作するライブラリのMutableVisitor 既存の⽅法2 引⽤元: cretz/kastree: Simple Kotlin Source AST and Syntax Parsing, Editing, and Writing https://github.com/cretz/kastree
9. kastreeの制約 - 2019年で開発が⽌まっている > 類似プロジェクトとして紹介されている kotlinx/ast には AST→ソースコードの変換機能がない - 最新のKotlinでは動作しない - 変換時に⼀部のコメントが⽋落してしまうことがある
10. 他の⾔語での選択肢 - JavaParser - Home https://javaparser.org/ - facebook/jscodeshift: A JavaScript codemod toolkit. https://github.com/facebook/jscodeshift jscodeshiftを参考に作ってみよう （所属企業ではなく個⼈としての取り組み）
11. コマンド jscodeshiftの使い⽅ 引⽤元: https://github.com/facebook/jscodeshift 変換スクリプト (transform.js)
12. 作っているツール: ktcodeshift
13. ktcodeshift - Kotlinのソースコードを⼀括で書き換えるツール - 変換関数をKotlin Scriptで記述 - 複数ファイルに⼀括適⽤するためのコマンドを提供 - ktastをラップした変換⽤のAPIを提供 > ktastはkastreeをフォークしたライブラリで、 Kotlin 1.7対応とコメントや空⽩を維持した変換を実現 > kastreeと同様にKotlin Compiler APIを使⽤ orangain/ktcodeshift: Toolkit for running codemods over multiple Kotlin files inspired by jscodeshift. https://github.com/orangain/ktcodeshift
14. コマンド ktcodeshiftの使い⽅ 変換スクリプト (*.transform.kts)
15. 変換例: JUnit 4→5への移⾏ JUnit4 JUnit5
16. 変換スクリプト例: JUnit 4→5への移⾏（抜粋） https://github.com/orangain/ktcodeshift/blob/main/ktcodeshift-cli/src/test/resources/examples/JUnit4To5.transform.kts
17. 変換スクリプト例: JUnit 4→5への移⾏（抜粋） https://github.com/orangain/ktcodeshift/blob/main/ktcodeshift-cli/src/test/resources/examples/JUnit4To5.transform.kts
18. 今後の課題 - 変換⽤APIのブラッシュアップ - IntelliJ IDEAでの補完 - 型情報の参照 - K2コンパイラへの対応？
19. まとめ
20. まとめ - ktcodeshiftというKotlinのASTレベルで書き換えるツールを作っている > 変換関数をKotlin Scriptで記述 > 複数ファイルに⼀括適⽤するためのコマンドを提供 > ktastをラップした変換⽤のAPIを提供 - 開発中ですが、もし良ければ使ってみてフィードバックいただけると嬉しいで す - 他にもっと良い⽅法をご存知の⽅はぜひ教えてください
22. Get started with Kotlin custom scripting – tutorial | Kotlin https://kotlinlang.org/docs/custom-script-deps-tutorial.html おまけ: プログラムからKotlin Scriptを実⾏する⽅法