手書きRBSの運用事例

Transcript

1. 2024/06/14　廣江 亮佑 手書きRBSの運用事例 @rhiroe
2. 2024/06/14　廣江 亮佑 自己紹介 名前: 廣江 亮佑 拠点: 岡山県 趣味: 原神、雀魂 GitHub: @rhiroe X: @buta_botti
3. RBS、書いてますか？
4. 󰢃 Maybe…
5. RBSを「書いている」人はおそらく少ない TypeProf RBS Rails Sord RBS prototype
6. 目次 • 手書きという選択 • 厳密な型定義 • CIでの型検査 • 開発体験の向上 • 困りごと
7. 1 手書きという選択
8. RBSを手書きする
9. 前提として、型定義の自動生成には肯定的です
10. だって楽だから
11. ただ正直、自動生成での型定義の精度はまだ低い
12. YARDから型生成？
13. 表現力に限界がある
14. Rubyで型のある開発がしたい！
15. RBSを手書きすることで、より正確な型定義が行える 正確な型定義により、コスト以上に開発体験が向上する …という仮説
16. それと、興味
17. 2 正確な型定義
20. TypeProf
21. TypeProf
27. untyped💔
33. ❤
34. (注)paramsの正確な型を書くには、現状のActionController::ParametersのRBSがまだ不十分という問題を抱えています
35. 3 CIでの型検査
36. Steep
38. デフォルト設定
46. ❤
47. 4 困りごと
48. ライブラリのRBS定義はまだ不十分
49. ライブラリのRBS定義はまだ不十分
50. ライブラリのRBS定義はまだ不十分 • gem_rbs_collectionにPRを出す • 自前のRBS定義を追加する • steep:ignore コメントを使う
51. ライブラリのRBS定義はまだ不十分 • gem_rbs_collectionにPRを出す • 自前のRBS定義を追加する • steep:ignore コメントを使う 💪
53. まとめ
54. 開発体験は向上したの？ • Steepの多くの項目で型検査を行える ◦ CIでの型検査により、多くの潜在的なエラーに早期で気づける ◦ デッドコードの判定が容易(メタプロが少ない) • RBSを手書きすることによりインターフェースへの意識が高まる ◦ より設計に気を遣うようになり、コードの質が上がる ◦ RBSがインターフェースのレビュー対象として使えるので便利 ◦ RBSフレンドリーな設計により、自然と値オブジェクトのようなものが生まれる • VS CodeのSteep拡張機能が超便利になる ◦ エディタ上に正確な型情報が表示される ◦ Copilotとは異なり、確実に存在するメソッドで補完が行われる ◦ 型検査に引っかかるコードを書くと、エディタ上で赤く知らせてくれる ◦ Ruby LSPよりも正確なコードジャンプが行える
55. 少しでも興味を持っていただけたなら 幸いです