Learning Kotlin with detekt

『detektで学ぶKotlin』

Server-Side Kotlin LT大会 vol.14
2025/02/28 20:45～
https://server-side-kotlin-meetup.connpass.com/event/340992/

Transcript

1. 2025/02/28 Server-Side Kotlin Meetup LT
 detekt で学ぶKotlin 

2. 2
 About Me
 • Hiroki Inoue
 • Software Engineer
 • Engineering Manager at Smartround Inc.

3. 3
 About Me
 • Hiroki Inoue
 • Software Engineer
 • Engineering Manager at Smartround Inc.
 
 • 元々PHPer
 • 昨年10月から現職（ Kotlinを使ってる会社） 
 • ロールはEM（本業で手を動かす機会は少なめ） 

4. 1 LTの概要
 2 学びの事例紹介 
 3 開発対象としての detekt
 4 まとめ
 目次

5. 01 LTの概要

6. 6
 誰向けのトーク？ 
 • Kotlinの学び方を模索している方 
 • detektの開発に興味がある方 

7. 7
 概要
 • detektを読んだり書いたりしました 
 • detektを通じてKotlinの書き方を学びました 
 • 趣味と実益を兼ねた取り組みの話をしに来ました 

8. 8
 detekt is 何？
 • 静的解析ツール 
 • https://github.com/detekt/detekt
 • https://detekt.dev/

9. 9
 detekt is 何？
 • 静的解析ツール 
 • https://github.com/detekt/detekt
 • https://detekt.dev/
 つまり
 Kotlinに詳しいのでは？ 
 （期待） 

10. 10
 detekt is 何？
 • 静的解析ツール 
 • https://github.com/detekt/detekt
 • https://detekt.dev/
 ならば
 Kotlinを教われるのではないか 
 （仮説） 

11. 11
 detekt入門以前の Kotlinとの接点
 • 入門書を読んだ 
 • 採用選考で技術試験的なものを受けた 
 • Kotlinを少し読んだり書いたりしたことがある 

12. 02 学びの事例紹介 

13. 13
 学びの経路 
 1. detektのルール から学ぶ
 2. detektそのもの から学ぶ
 3. issue から学ぶ

14. 14
 学びの経路 
 1. detektのルール
 ◦ Kotlinはこう書くべしというベストプラクティス（のひとつ） 
 2. detektそのもの
 3. issue

15. 15
 学びの経路 
 1. detektのルール
 ◦ Kotlinはこう書くべしというベストプラクティス（のひとつ） 
 2. detektそのもの
 ◦ Kotlinで書かれた運用実績のあるプロダクションコード 
 3. issue

16. 16
 学びの経路 
 1. detektのルール
 ◦ Kotlinはこう書くべしというベストプラクティス（のひとつ） 
 2. detektそのもの
 ◦ Kotlinで書かれた運用実績のあるプロダクションコード 
 3. issue
 ◦ Kotlinの言語仕様や書き方に関する話題 

17. 17
 学べること 
 公式ドキュメント、入門書で見たことの 
 実践例

18. 18
 学べること 
 入門書にカバーされない 
 言語仕様、イディオムやベストプラクティス 

19. 19
 前置き…
 この先、有識者にとってはあたり前のことと思いますが …
 ご容赦ください mm

20. 20
 platform type

21. 21
 platform type
 ??
 タイトルからしてわからない …

22. 22
 platform type
 ??
 タイトルからしてわからない …
 母国語（PHP）には存在しない概念 …

23. 23
 platform type
 "platform types — types which the Kotlin compiler uses, when interoperating with code written for another platform (e.g., Java)."
 
 https://kotlinlang.org/spec/type-system.html#platform-types

24. 24
 inner class

25. 25
 inner class
 母国語には …(ry

26. 26
 このissueが示唆すること 
 • UnnecessaryInnerClassはouter classのメンバにアクセスしないinner classを 指摘するルール
 ⇒outerにアクセスすることが inner classの個性

27. 27
 このissueが示唆すること 
 • UnnecessaryInnerClassはouter classのメンバにアクセスしないinner classを 指摘するルール
 ⇒outerにアクセスすることがinner classの個性
 • しかし兄弟classにアクセスしてても指摘するというfalse positiveがある
 ⇒innerは、outerだけじゃなく outerの別のinnerにもアクセスできる 

28. 28
 inner class
 “Nested and inner classes
”
 
 https://kotlinlang.org/docs/nested-classes.html

29. 29
 nested class
 • Kotlinではclassの中にclassをネストできる 

30. 30
 inner class
 • nested classにinnerを付けたもの 
 • outer classのメンバにアクセスできる 
 • outer objectの参照をもつ 

31. 31
 it

32. 32
 it
 “It's very common for a lambda expression to have only one parameter.
 
 If the compiler can parse the signature without any parameters, the parameter does not need to be declared and -> can be omitted. The parameter will be implicitly declared under the name it:”
 
 https://kotlinlang.org/docs/lambdas.html#it-implicit-name-of-a-single-p arameter

33. 33
 このルールが強制すること 
 • lambdaの引数が1つの場合、引数を省略し、 itで参照する。 

34. 34
 このルールが強制すること 
 • lambdaの引数が1つの場合、引数を省略し、 itで参照する。 
 • 但し、以下の場合 itは使えない。 
 ◦ 引数に型を明示する場合 
 ◦ lambdaの引数が2つ以上ある場合 

35. 35
 その他色々 
 カスタム アノテーション 拡張関数 by lazy with build.gradle.kts mavenLocal
36. 36
 何が言いたいかというと 
 製品は出会いのチャンス 
 実践例との
37. 37
 学べること 
 入門書だけ では学べないこと 

38. 03 開発対象としての detekt 

39. 39
 入門者フレンドリー 
 1. Contribution Guideが充実している 
 2. good first issue や help wanted ラベルがある 

40. 40
 コードを改修するまでの流れ 
 1. ラベルでフィルターして Issuesを読み漁る 
 2. 仕様を理解する 
 ◦ コードを読む 
 ◦ 実行する
 ◦ テストを読む 
 3. 開発流儀を理解する 
 ◦ Contribution Guideを読む
 ◦ マージ済みの PRを読む
 4. 開発に着手する 
 結果として見送った 
 issueからも学べる
41. 41
 Contribution Guide
 • commitメッセージの流儀 
 • ユニットテストの実行方法 
 • 新しいルールの作り方 
 • ルール説明の書き方 
 • エラー検出時のメッセージの書き方 
 etc.

42. 42
 ルール説明 
 https://github.com/detekt/detekt/blob/main/.github/CONTRIBUTING.md

43. 43
 ルールを追加した時に触れたもの 
 • ルール
 • テスト
 • detekt.yml[1]
 • default-detekt-config.yml
 • RuleSetProvider[2]
 1. ルールの有効化・無効化の指定やパラメータを渡すことができる。 
 2. ルールにはカテゴリがあり、カテゴリ毎に RuleSetProviderがある。

44. 44
 detekt.yml
 style: # ルールセット（カテゴリ的なもの） active: true # styleルールセットに含まれるルールを有効にする BracesOnIfStatements: # ルール名 active: false # BracesOnIfStatementsを無効にする singleLine: 'never' # パラメータ
45. 45
 type resolution
 • type resolution[1]が有効でないと実行されないルールがある 
 • `--debug`オプションで確認できる 
 1. https://github.com/detekt/detekt/blob/main/website/docs/gettingstarted/type-resolution.md
 The rule 'AvoidReferentialEquality' requires type resolution but it was run without it.
46. 46
 type resolution
 • type resolution[1]が有効でないと実行されないルールがある 
 • `--debug`オプションで確認できる 
 
 
 • ./gradlew detektMain などして有効化できる 
 • 手元ではmavenLocalで試せる
 1. https://github.com/detekt/detekt/blob/main/website/docs/gettingstarted/type-resolution.md
 The rule 'AvoidReferentialEquality' requires type resolution but it was run without it.
47. 04 まとめ

48. 48
 まとめ
 • detektを読んだり書いたりしました 
 • detektを通じてKotlinの書き方を学びました 
 • 趣味と実益を兼ねた取り組み の話をしに来ました 

49. スマートラウンドでは新しいメンバーを募集中です 
 jobs.smartround.com 
 私たちと一緒に、スタートアップが可能性を最大限に発揮できる世界をつくりませんか？ 

50. ご清聴ありがとうございました