my_custom_lint

Transcript

1. զ͕ՈͷCustom Lint @Takako
2. ࣗݾ঺հ
3. ࣗݾ঺հ ɾTakako ɹɾTwitter: Takako(@kotokoto_fire) ɾAndroidΤϯδχΞ ɾmenusͱ͍͏ݙཱΞϓϦΛ࡞ͬͯ·͢
4. ͱ͋Δ೔ͷίϛοτ
5. ͱ͋Δ೔ͷίϛοτ
6. ϨϏϡʔͰݟ͚ͭΔͷ ೉͘͠ͳ͍ʁ
7. ͦ͏ͩʂ CustomLintͩʂ
8. Androidʹ͓͚ΔLint
9. Androidʹ͓͚ΔLint LintΛར༻͢ΔͱΞϓϦΛ࣮ߦͨ͠Γɺςε τέʔεΛ࡞੒ͨ͠Γ͠ͳͯ͘΋ɺίʔυߏ ଄ͷ඼࣭ʹؔ͢Δ໰୊Λಛఆͯ͠मਖ਼͢Δ͜ ͱ͕Ͱ͖·͢ IUUQTEFWFMPQFSBOESPJEDPNTUVEJPXSJUFMJOU IMKB
10. Androidʹ͓͚ΔLint
11. Androidʹ͓͚ΔLint
12. LintʹRuleΛ௥Ճʁ
13. Lintͷछྨ
14. Lintͷछྨ ɾktlint
 ɾandroid-lint ɾ(detekt)
15. Lintͷछྨ ɾktlint
 ɾandroid-lint ɾ(detekt)
16. LintΛCustom͢Δ
17. LintΛCustom͢Δ ~ಋೖ~ <ktlint> https://github.com/pinterest/ktlint <android-lint> https://github.com/googlesamples/android- custom-lint-rules
18. LintΛCustom͢Δ ~AST~ fun sampel() { val a = b + c }
19. զ͕ՈͷRule
20. Check onError in subscribeBy
21. Check onError in subscribeBy <໨త> ɾsubscribe͢Δͱ͖ʹonErrorΛΩϟον͍ͯ͠ͳ ͚Ε͹ܯࠂ <લఏ> ɾݱঢ়͸subscribeΛ࣮ߦ͢Δࡍ͸΄ͱΜͱ subscribeByͰ࣮ߦ͢Δ
22. Check onError in subscribeBy <໨త> ɾsubscribe͢Δͱ͖ʹonErrorΛΩϟον͍ͯ͠ͳ ͚Ε͹ܯࠂ <લఏ> ɾݱঢ়͸subscribeΛ࣮ߦ͢Δࡍ͸΄ͱΜͱ subscribeByͰ࣮ߦ͢Δ
23. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just("").subscribeBy {} } IUUQTHJUIVCDPNHPPHMFTBNQMFTBOESPJETVOqPXFS
24. Check onError in subscribeBy
25. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just(“”).subscribeBy {} } 1"$,"(&@%*3&$5*0/
26. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just(“").subscribeBy {} } ˡ1TJ8IJUF4QBDF
27. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just(“”).subscribeBy {} } ˢ*.1035@-*45
28. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just(“").subscribeBy {} } ˡ1TJ8IJUF4QBDF
29. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just("").subscribeBy {} } ˡ$-"44
30. Check onError in subscribeBy package com.google.samples.apps.sunflower import io.reactivex.Single class Sample { val sample = Single.just(“").subscribeBy {} } ˡ1TJ8IJUF4QBDF
31. Check onError in subscribeBy ˢ461&3@5:1&@-*45ʹFYUFOET΍JNQMFNFOUT͕ฒͿ
32. Check onError in subscribeBy TVCTDSJCF#ZҎ߱ͷUFYU͕ཏྻ͞Ε͍ͯΔ
33. Check onError in subscribeBy class Sample { val sample = Single.just("").subscribeBy( onError = { } ) }
34. Check onError in subscribeBy ͜ͷลΓո͍͠
35. Check onError in subscribeBy
36. Check onError in subscribeBy Detector
 ɾDetector ɾResourceXmlDetector ɾLayoutDetector …. Scanner
 ɾUastScanner ɾClassScanner ɾXmlScanner ….
37. Check onError in subscribeBy Detector
 ɾDetector ɾResourceXmlDetector ɾLayoutDetector …. Scanner
 ɾUastScanner ɾClassScanner ɾXmlScanner ….
38. Check onError in subscribeBy class NotHandledOnError : Detector(), Detector.UastScanner { override fun getApplicableUastTypes(): List<Class<out UElement>>? { return Collections.singletonList( UCallExpression::class.java ) } }
39. Check onError in subscribeBy class NotHandledOnError : Detector(), Detector.UastScanner { override fun createUastHandler(context: JavaContext): UElementHandler? { return object : UElementHandler() { override fun visitCallExpression(node: UCallExpression) { } } } }
40. Check onError in subscribeBy override fun createUastHandler(context: JavaContext): UElementHandler? { return object : UElementHandler() { override fun visitCallExpression(node: UCallExpression) { if ( node.sourcePsi?.context.toString() == "DOT_QUALIFIED_EXPRESSION" && node.methodName?.startsWith("subscribeBy") == true && node.valueArgumentCount > 0 && node.sourcePsi?.text?.contains("onError") == false ) { context.report( NotHandledOnError.ISSUE, node, context.getLocation(node), "Should handle onError" ) } } } }
41. Check onError in subscribeBy override fun createUastHandler(context: JavaContext): UElementHandler? { return object : UElementHandler() { override fun visitCallExpression(node: UCallExpression) { if ( node.sourcePsi?.context.toString() == "DOT_QUALIFIED_EXPRESSION" && node.methodName?.startsWith("subscribeBy") == true && node.valueArgumentCount > 0 && node.sourcePsi?.text?.contains("onError") == false ) { context.report( NotHandledOnError.ISSUE, node, context.getLocation(node), "Should handle onError" ) } } } }
42. Check onError in subscribeBy override fun createUastHandler(context: JavaContext): UElementHandler? { return object : UElementHandler() { override fun visitCallExpression(node: UCallExpression) { if ( node.sourcePsi?.context.toString() == "DOT_QUALIFIED_EXPRESSION" && node.methodName?.startsWith("subscribeBy") == true && node.valueArgumentCount > 0 && node.sourcePsi?.text?.contains("onError") == false ) { context.report( NotHandledOnError.ISSUE, node, context.getLocation(node), "Should handle onError" ) } } } }
43. Check onError in subscribeBy override fun visitCallExpression(node: UCallExpression) { if ( node.sourcePsi?.context.toString() == "DOT_QUALIFIED_EXPRESSION" && node.methodName?.startsWith("subscribeBy") == true && node.valueArgumentCount > 0 && node.sourcePsi?.text?.contains("onError") == false ) { context.report( NotHandledOnError.ISSUE, node, context.getLocation(node), "Should handle onError" ) } }
44. Check onError in subscribeBy class NotHandledOnError : Detector(), Detector.UastScanner { companion object { val ISSUE: Issue = Issue.create( "NotHandledOnError", "Not Handled onError", "Add onError to subscribeBy.", Category.CORRECTNESS, 6, Severity.ERROR, Implementation( NotHandledOnError::class.java, Scope.JAVA_FILE_SCOPE ) ) } }
45. Check onError in subscribeBy class CustomIssueRegistry : IssueRegistry() { override val issues: List<Issue> get() { return Collections.singletonList( NotHandledOnError.ISSUE ) } }
46. Check onError in subscribeBy jar { manifest { attributes("Lint-Registry-v2": "com.example.custom_lint.CustomIssueRegistry") } }
47. Is Drawable attr in TextView
48. Is Drawable attr in TextView <໨త> ɾTextViewʹdrawableXX͕͋Ε͹warning
49. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { override fun getApplicableElements(): Collection<String>? { return Collections.singletonList(SdkConstants.TEXT_VIEW) } override fun visitElement( context: XmlContext, element: Element ) { val attrNode = getDrawableAttribute(element) if (attrNode != null) { // ͜͜ʹ֘౰࣌ͷॲཧ } } private fun getDrawableAttribute(element: Element): Attr? { return element.getAttributeNodeNS(SdkConstants.ANDROID_URI, "drawableEnd") ?: ུ } }
50. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { override fun getApplicableElements(): Collection<String>? { return Collections.singletonList(SdkConstants.TEXT_VIEW) } override fun visitElement( context: XmlContext, element: Element ) { val attrNode = getDrawableAttribute(element) if (attrNode != null) { // ͜͜ʹ֘౰࣌ͷॲཧ } } private fun getDrawableAttribute(element: Element): Attr? { return element.getAttributeNodeNS(SdkConstants.ANDROID_URI, "drawableEnd") ?: ུ } }
51. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { override fun getApplicableElements(): Collection<String>? { return Collections.singletonList(SdkConstants.TEXT_VIEW) } override fun visitElement( context: XmlContext, element: Element ) { val attrNode = getDrawableAttribute(element) if (attrNode != null) { // ͜͜ʹ֘౰࣌ͷॲཧ } } private fun getDrawableAttribute(element: Element): Attr? { return element.getAttributeNodeNS(SdkConstants.ANDROID_URI, "drawableEnd") ?: ུ } }
52. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { override fun getApplicableElements(): Collection<String>? { return Collections.singletonList(SdkConstants.TEXT_VIEW) } override fun visitElement( context: XmlContext, element: Element ) { val attrNode = getDrawableAttribute(element) if (attrNode != null) { // ͜͜ʹ֘౰࣌ͷॲཧ } } private fun getDrawableAttribute(element: Element): Attr? { return element.getAttributeNodeNS(SdkConstants.ANDROID_URI, "drawableEnd") ?: ུ } }
53. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { override fun visitElement( context: XmlContext, element: Element ) { val attrNode = getDrawableAttribute(element) if (attrNode != null) { context.report( ISSUE, attrNode, context.getLocation(attrNode), "If you use vector resource, ུ" ) } } }
54. Is Drawable attr in TextView
55. Is Drawable attr in TextView class NotUseDrawableInTextView : LayoutDetector() { companion object { val ISSUE: Issue = Issue.create( "NotUseDrawableInTextView", "Not use drawable in TextView", "Not use drawable in TextView", Category.LINT, 6, Severity.WARNING, Implementation( NotUseDrawableInTextView::class.java, Scope.RESOURCE_FILE_SCOPE ) ) } }
56. PRͷվળ
57. PR্Ͱ͸…
58. PR্Ͱ͸…
59. ·ͱΊ
60. ·ͱΊ ɾLint͸ΧελϚΠζͰ͖Δ ɾScanner, Detector͸ྟػԠมʹ࢖͍෼͚Α͏ ɾDangerͳͲͱ࿈ܞ͢ΔͱɺPRΛϚʔδ͢Δ લʹbot͔ΒࢦఠͰ͖Δ
61. Let’s improve your code with CustomLint
62. ͝੩ௌ ͋Γ͕ͱ͏͍͟͝·ͨ͠ʂ