Caupain_-_présentation.pdf

Transcript

1. Caupain (or how you too can release an open source Kotlin Tool) Valentin Rocher
2. Valentin Rocher
3. Valentin Rocher Deezer since 2024
4. Valentin Rocher Deezer since 2024 Android since 2010
5. Valentin Rocher Deezer since 2024 Android since 2010 Loves tinkering and CLI tools!
6. What’s Caupain?
7. What’s Caupain? • It’s an open source tool that generates dependency updates reports from a Gradle version catalog
8. What’s Caupain? • It’s an open source tool that generates dependency updates reports from a Gradle version catalog • Available both as a Gradle Plugin and as a CLI tool for all major platforms
9. What’s Caupain? • It’s an open source tool that generates dependency updates reports from a Gradle version catalog • Available both as a Gradle Plugin and as a CLI tool for all major platforms • It directly queries Maven repositories
10. How does it work?
11. How does it work? Parse version catalog to get versions
12. How does it work? Parse version catalog to get versions maven-metadata.xml Repository
13. How does it work? Parse version catalog to get versions maven-metadata.xml Repository Repository maven-metadata.xml
14. How does it work? Parse version catalog to get versions maven-metadata.xml Repository Repository maven-metadata.xml Repository maven-metadata.xml
15. How does it work? Parse version catalog to get versions maven-metadata.xml Repository dependency-version.pom Repository maven-metadata.xml Repository maven-metadata.xml
16. How does it work? Parse version catalog to get versions maven-metadata.xml Repository dependency-version.pom Repository maven-metadata.xml Repository maven-metadata.xml Forma tt er
17. How did it start?
18. How did it start? • First dra ft was a snippet of code in an internal plugin because other solutions weren’t matching our needs
19. How did it start? • First dra ft was a snippet of code in an internal plugin because other solutions weren’t matching our needs
20. How did it start? • First dra ft was a snippet of code in an internal plugin because other solutions weren’t matching our needs • Talked about it with Martin Bonnin at Android Makers
21. How did it start? • First dra ft was a snippet of code in an internal plugin because other solutions weren’t matching our needs • Talked about it with Martin Bonnin at Android Makers • A few beers later…The hype is here!
22. Let’s build a tool!
23. What do we need?
24. What do we need? • It needs to be available as a CLI and as a plugin
25. What do we need? • It needs to be available as a CLI and as a plugin • It needs to work fl awlessly on all platforms
26. What do we need? • It needs to be available as a CLI and as a plugin • It needs to work fl awlessly on all platforms • It has to be easily installable
27. What do we need? • It needs to be available as a CLI and as a plugin • It needs to work fl awlessly on all platforms • It has to be easily installable Solution: use KMP !
28. Library grocery list Serialization
29. Library grocery list Serialization • KotlinX serialization and all its formats!
30. Library grocery list Serialization • KotlinX serialization and all its formats! • TOML: tomlkt
31. Library grocery list Serialization • KotlinX serialization and all its formats! • TOML: tomlkt • XML: xmlutil
32. Library grocery list Serialization • KotlinX serialization and all its formats! • TOML: tomlkt • XML: xmlutil • JSON: kotlinx-serialization-json
33. Library grocery list Serialization • KotlinX serialization and all its formats! • TOML: tomlkt • XML: xmlutil • JSON: kotlinx-serialization-json • Properties: properties-serializer
34. Library grocery list Serialization • KotlinX serialization and all its formats! • TOML: tomlkt • XML: xmlutil • JSON: kotlinx-serialization-json • Properties: properties-serializer • ANTLR Kotlin for low-level parsing
35. Library grocery list I/O
36. Library grocery list I/O • Ktor for network operations
37. Library grocery list I/O • Ktor for network operations • Using native engines for each platform
38. Library grocery list I/O • Ktor for network operations • Using native engines for each platform • Okio for all fi le-based operations
39. Library grocery list HTML forma tt ing • kotlinx.html • DSL to write HTML directly in Kotlin
40. Library grocery list CLI interactions • Clikt for writing command-lines interfaces
41. Library grocery list CLI interactions • Clikt for writing command-lines interfaces • Easy option handling
42. Library grocery list CLI interactions • Clikt for writing command-lines interfaces • Easy option handling • Takes care of help pages and errors
43. Library grocery list CLI interactions • Mordant for rendering styled text in the terminal
44. Library grocery list CLI interactions • Mordant for rendering styled text in the terminal • Progress bars
45. Library grocery list CLI interactions • Mordant for rendering styled text in the terminal • Progress bars • Text colors
46. Library grocery list CLI interactions • Mordant for rendering styled text in the terminal • Progress bars • Text colors • Tables
47. Let’s share it!
48. Make the code usable and readable
49. Make the code usable and readable • Checks via Github Actions
50. Make the code usable and readable • Checks via Github Actions • A lot of unit tests
51. Make the code usable and readable • Checks via Github Actions • A lot of unit tests • Binary compatibility check
52. Make the code usable and readable • Checks via Github Actions • A lot of unit tests • Binary compatibility check • Transitive dependency check via dependency-guard
53. Make the code usable and readable • Checks via Github Actions • A lot of unit tests • Binary compatibility check • Transitive dependency check via dependency-guard • Style check (via Detekt)
54. Make the code usable and readable • Checks via Github Actions • A lot of unit tests • Binary compatibility check • Transitive dependency check via dependency-guard • Style check (via Detekt) • Explicit API
55. Easy ways to access it
56. Easy ways to access it • MacOS: Brew via an external tap
57. Easy ways to access it • MacOS: Brew via an external tap • Debian: APT repository • Uses Net fl ix Nebula Plugins for easy DEB build
58. Easy ways to access it • MacOS: Brew via an external tap • Debian: APT repository • Uses Net fl ix Nebula Plugins for easy DEB build • Windows: Chocolatey
59. Easy ways to access it • MacOS: Brew via an external tap • Debian: APT repository • Uses Net fl ix Nebula Plugins for easy DEB build • Windows: Chocolatey • Plugin: Gradle Plugin Portal
60. Easy ways to access it • MacOS: Brew via an external tap • Debian: APT repository • Uses Net fl ix Nebula Plugins for easy DEB build • Windows: Chocolatey • Plugin: Gradle Plugin Portal • Core library: Maven Central
61. Easy ways to access it • MacOS: Brew via an external tap • Debian: APT repository • Uses Net fl ix Nebula Plugins for easy DEB build • Windows: Chocolatey • Plugin: Gradle Plugin Portal • Core library: Maven Central • The rest is in releases !
62. Open source is never done!
63. Open source is never done !
64. Open source is never done ! • We’re currently at version 1.5.1
65. Open source is never done ! • We’re currently at version 1.5.1 • 120 stars, around 50 issues or PRs, people are using it and liking it !
66. Open source is never done ! • We’re currently at version 1.5.1 • 120 stars, around 50 issues or PRs, people are using it and liking it ! • Mainly maintained by me, but you’re free to help !
67. Open source is never done ! • We’re currently at version 1.5.1 • 120 stars, around 50 issues or PRs, people are using it and liking it ! • Mainly maintained by me, but you’re free to help ! • Idea is to keep maintaining it as long as people use it
68. Open source is never done ! • We’re currently at version 1.5.1 • 120 stars, around 50 issues or PRs, people are using it and liking it ! • Mainly maintained by me, but you’re free to help ! • Idea is to keep maintaining it as long as people use it • Come look at it at h tt p://github.com/deezer/caupain !
69. And now, a demo !
71. Thank you !