Static Code Analysis Tools

Transcript

1. Simplify the life while developing in Kotlin Dmytro Kuiko
2. Motivation
3. Motivation Repeatability
4. Motivation Repeatability I’m a robot! No!
5. Motivation Repeatability I’m a robot! No! Let’s focus on something else
7. Static Code Analysis Tools Java: Findbugs PMD Checkstyle
8. Static Code Analysis Tools Java: Findbugs PMD Checkstyle
9. Static Code Analysis Tools Kotlin: ktlint detekt
10. Static Code Analysis Tools ktlint
11. Static Code Analysis Tools Integration
12. Static Code Analysis Tools configurations { ktlint } dependencies { ktlint “com.github.shyiko:ktlint:0.26.0” }
13. Static Code Analysis Tools configurations { ktlint } dependencies { ktlint “com.github.shyiko:ktlint:0.26.0” } task ktlint(type: JavaExec, group: "verification") { description = "Check Kotlin code style." main = "com.github.shyiko.ktlint.Main" classpath = configurations.ktlint args "${project.rootDir}/**/*.kt" args "--reporter=plain" args "--reporter=checkstyle,output=${rootProject.buildDir}/reports/ktlint.xml" }
14. Static Code Analysis Tools Customisation
15. Static Code Analysis Tools .editorconfig
16. Static Code Analysis Tools .editorconfig custom rule set
17. Static Code Analysis Tools .editorconfig
18. Static Code Analysis Tools [*.{kt,kts}] indent_size=4 continuation_indent_size=4 insert_final_newline=unset max_line_length=off
19. Static Code Analysis Tools Custom rule
20. Static Code Analysis Tools Custom rule https://github.com/shyiko/ktlint/tree/master/ktlint-ruleset-template
21. Static Code Analysis Tools Output example
22. Static Code Analysis Tools <?xml version="1.0" encoding="utf-8"?> <checkstyle version=“8.0"> <file name=“/Users/dmytrok/AndroidStudioProjects/.../MainActivity.kt”> <error line=“50" column="52" severity="error" message="Unnecessary semicolon" </file> ... </checkstyle>
23. Static Code Analysis Tools Disable checks
24. Static Code Analysis Tools 
 import org.koin.standalone.* import com.apollographql.apollo.ApolloCall
 import com.apollographql.apollo.ApolloClient

25. Static Code Analysis Tools /* ktlint-disable no-wildcard-imports */ import org.koin.standalone.* ... /* ktlint-enable no-wildcard-imports */ import com.apollographql.apollo.ApolloCall import com.apollographql.apollo.ApolloClient
26. Static Code Analysis Tools /* ktlint-disable no-wildcard-imports */ import org.koin.standalone.* ... /* ktlint-enable no-wildcard-imports */ import com.apollographql.apollo.ApolloCall import com.apollographql.apollo.ApolloClient import org.koin.core.* // ktlint-disable
27. Static Code Analysis Tools detekt
28. Static Code Analysis Tools Integration
29. Static Code Analysis Tools plugins { id "io.gitlab.arturbosch.detekt" version “1.0.0.RC8” }
30. Static Code Analysis Tools plugins { id "io.gitlab.arturbosch.detekt" version “1.0.0.RC8” } detekt { version = "1.0.0.RC8" defaultProfile { input = "$projectDir" config = "$rootDir/detekt-config.yml" filters = ".*/resources/.*,.*/build/.*" output = "${project.buildDir}/reports/detekt" parallel = true } }
31. Static Code Analysis Tools Customisation
32. Static Code Analysis Tools ./gradlew detektGenerateConfig —> detekt-config.yml

33. Static Code Analysis Tools ./gradlew detektGenerateConfig —> detekt-config.yml
 autoCorrect: true build: maxIssues: 10 weights: # LongParameterList: 1 # style: 1 # comments: 1 style: active: true VarCouldBeVal: active: false WildcardImport: active: true excludeImports: "java.util.*,kotlinx.android.synthetic.*"
34. Static Code Analysis Tools Output
35. Static Code Analysis Tools
36. Static Code Analysis Tools detekt-checkstyle.xml <checkstyle version="4.3"> <file name=“/Users/dmytrok/AndroidStudioProjects/…/ NetworkClientImpl.kt”> <error line="10" column="1" severity="warning" message="org.koin.standalone.* is a wildcard import. Replace it with fully qualified imports." /> </file> </checkstyle>
37. Static Code Analysis Tools detekt-report.html
38. Static Code Analysis Tools Which is better?
39. Static Code Analysis Tools ktlint Jetbrains style Simplicity detekt Faster Config Baseline
40. Applying code style formatters Git Hooks
41. Applying code style formatters $projectDir/.git/hooks/
42. Applying code style formatters $projectDir/.git/hooks/ pre-commit.sample
 
 pre-push.sample
 
 commit-msg.sample
 
 prepare-commit-msg.sample
 
 ...
43. Applying code style formatters pre-commit
44. Applying code style formatters if ./gradlew ktlint --daemon; then echo "ktlint found no problems.” exit 0 else fiB
45. Applying code style formatters if ./gradlew ktlint --daemon; then echo "ktlint found no problems.” exit 0 else echo "Ktlint found style problems” echo "ktlintFormat will be launched” if ./gradlew ktlintFormat; then echo "All Style problems were removed” exit 1 else echo 1>&2 "Please fix them by yourself” exit 1 fi fiB
46. Visualising Sonarqube
47. Visualising
48. Visualising
49. Visualising
50. Visualising plugins { id "org.sonarqube" version "2.6.2" }
51. Visualising plugins { id "org.sonarqube" version "2.6.2" } sonarqube { properties { property "sonar.host.url", "$sonarUrl" property "sonar.projectName", "Some App" ... } }
52. Visualising plugins { id "org.sonarqube" version "2.6.2" } sonarqube { properties { property "sonar.host.url", "$sonarUrl" property "sonar.projectName", "Some App" } } subprojects { sonarqube { properties { property "sonar.sources", “src/main/java“ ... } } }
53. Visualising
54. Visualising
55. Visualising
56. Gathering all together ./gradlew ktlint ./gradlew ktlintFormat ./gradlew detektCheck ./gradlew jacocoReport ./gradlew sonarqube
57. Thanks for your Attention! ktlint detekt @dimiKuiko https://speakerdeck.com/dmytrykuiko/static-code-analysis-tools/