detekt カスタムルールでコーディング規約を運用する

- 公式document
- https://detekt.dev/docs/introduction/extensions/
- 書いた解説記事
- https://zenn.dev/kabos/articles/d31c27cb473fba

Transcript

1. detekt カスタムルールで コーディング規約を運用する 2024.11.8 DroidKaigi.collect { #13@Tokyo } kabos(@chronotrg) 1
2. About Me kabos(@chronotrg) Androidエンジニア_4年目 Github: https://github.com/taratara10 好きなもの Vim KMP WearOS 2
3. 今回伝えたいこと detektカスタムルールの存在を広めたい！ 3
4. コーディングルールを 守るのは難しい 4
5. 開発が進んできたプロジェクト コード量が増えてきた メンバー毎に書き方が違う 命名を揃えたい これ以上多様化するとメンテが大変になりそう 5
6. コードに統一感を持たせたい💭 6
7. コーディング規約を作るぞ ＜️これで解決。平和はもたらされた 7
8. 6か月後🫨 コーディング規約作ったけど、今は忙しいから後で対応しよう コードレビューの時間がない... 動くからとりあえずマージしてヨシ！ 8
9. 1年後 暫定対応のコードがコピペされて蔓延 コーディング規約...そんなのもあったね... カオス！ 9
10. こんなはずでは... 10
11. コーディング規約の運用を阻害する要因 ルールが厳密に明文化されていない 長い文章を読んでも内容が理解しにくいし、覚えられない メンバーが変化して運用されなくなった etc... 11
12. 重要で大変なことは 自動化しよう 12
13. CIと連携しやすくて プロジェクトの独自ルールを作れる Linterさえあれば...🤔 13
15. detekt Kotlin向けの静的コード解析ツール DroidKaigi/conference-app-2024でも採用 標準ルールセットが豊富で柔軟にカスタマイズできる 15
17. Easy to Extend ! 手軽にカスタムルールがつくれるよ！ 17
18. カスタムルールを作ってみる 「Repositoryが公開するメソッドはsuspendであること」 18
20. Repositoryが公開するメソッドはsuspendであること 20
21. Repositoryが公開するメソッドはsuspendであること 21
22. Repositoryが公開するメソッドはsuspendであること 22
23. Repositoryが公開するメソッドはsuspendであること 23
24. Repositoryが公開するメソッドはsuspendであること 24
25. Repositoryが公開するメソッドはsuspendであること 25
26. 直感的に書けそう！ 26
27. 詳しい実装方法はこちら https://zenn.dev/kabos/articles/d31c27cb473fba 27
28. detektカスタムルールで 生産性を爆上げしよう 28
29. ご清聴ありがとうございました！ 29