Add Markdown formatting for changelog

Author: egorikftp

gradle/cli.versions.toml

@@ -1,7 +1,10 @@
 [versions]
 cli-version = "0.18.0"
 
+clikt = "5.0.3"
+
 [libraries]
-clikt = "com.github.ajalt.clikt:clikt:5.0.3"
+clikt = { module = "com.github.ajalt.clikt:clikt", version.ref = "clikt" }
+clikt-markdown = { module = "com.github.ajalt.clikt:clikt-markdown", version.ref = "clikt" }
 mockk = "io.mockk:mockk:1.14.6"
 r8 = "com.android.tools:r8:8.11.18"

tools/cli/CHANGELOG.md

@@ -2,61 +2,39 @@
 
 ## [Unreleased]
 
-### Changed
-
 - Separate CLI versioning from plugin versioning
-
-### Added
-
 - Add `changelog` command to print CLI changelog
 
 ## [0.17.3] - 2025-10-14
 
-### Fixed
-
 - Fixed executable permissions for the 'valkyrie' binary in CLI distribution
 
 ## [0.16.0] - 2025-07-24
 
-### Changed
-
 - Use fully qualified imports if icon name conflicts with Compose qualifiers
 
 ## [0.15.0] - 2025-06-28
 
-### Added
-
-- Added `--auto-mirror` option to force add "autoMirror=true" or "autoMirror=false" option to generated ImageVector
+- Added `--auto-mirror` option to forcibly add "autoMirror=true" or "autoMirror=false" option to generated ImageVector
 
 ## [0.14.0] - 2025-04-28
 
-### Changed
-
 - Migrate to hierarchical icon pack structure. CLI options `--iconpack-name` and `--nested-packs` removed in favour of
   `--iconpack`
 
-Single pack:
-❌ ./valkyrie --iconpack-name=ValkyrieIcons
-✅ ./valkyrie --iconpack=ValkyrieIcons
-
-Nested packs:
-❌ ./valkyrie --iconpack-name=ValkyrieIcons --nested-packs=Colored,Filled
-✅ ./valkyrie --iconpack=ValkyrieIcons.Colored,ValkyrieIcons.Filled
-
-### Added
+| Old syntax example                                                       | New syntax example                                                 |
+|--------------------------------------------------------------------------|--------------------------------------------------------------------|
+| `./valkyrie --iconpack-name=ValkyrieIcons`                               | `./valkyrie --iconpack=ValkyrieIcons`                              |
+| `./valkyrie --iconpack-name=ValkyrieIcons --nested-packs=Colored,Filled` | `./valkyrie --iconpack=ValkyrieIcons.Colored,ValkyrieIcons.Filled` |
 
 - Added `--use-compose-colors` option to use predefined Compose colors instead of hex color codes (e.g. Color.Black
   instead of Color(0xFF000000))
 
 ## [0.13.0] - 2025-03-08
 
-### Added
-
 - Added `--preview-annotation-type` option to specify the type of Preview annotation (must be either 'androidx' or '
   jetbrains')
 
 ## [0.11.0] - 2024-11-25
 
-### Added
-
 - Initial release of Valkyrie CLI tool

tools/cli/build.gradle.kts

@@ -100,6 +100,7 @@ dependencies {
     implementation(projects.sdk.ir.core)
 
     implementation(cli.clikt)
+    implementation(cli.clikt.markdown)
     r8(cli.r8)
 
     testImplementation(projects.components.test.resourceLoader)

tools/cli/src/main/kotlin/io/github/composegears/valkyrie/cli/command/ChangelogCommand.kt

@@ -2,17 +2,18 @@ package io.github.composegears.valkyrie.cli.command
 
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.core.Context
+import com.github.ajalt.mordant.markdown.Markdown
 
 internal class ChangelogCommand : CliktCommand(name = "changelog") {
 
     override fun run() {
-        echo(loadResourceText("CHANGELOG.md"))
+        echo(Markdown(loadResourceText("CHANGELOG.md"), showHtml = true))
     }
 
     override fun help(context: Context): String = "Print CLI changelog"
 }
 
-fun Any.loadResourceText(name: String): String {
+private fun Any.loadResourceText(name: String): String {
     val classLoader = this::class.java.classLoader
     val inputStream = classLoader.getResourceAsStream(name) ?: error("Resource '$name' not found")
     return inputStream.bufferedReader().use { it.readText() }

tools/cli/src/main/kotlin/io/github/composegears/valkyrie/cli/command/IconPackCommand.kt

@@ -63,7 +63,7 @@ internal class IconPackCommand : CliktCommand(name = "iconpack") {
 
     override val printHelpOnEmptyArgs: Boolean = true
 
-    override fun help(context: Context): String = "A CLI tool to generate an IconPack object."
+    override fun help(context: Context): String = "A CLI tool to generate an IconPack object"
 
     override fun run() {
         generateIconPack(

tools/cli/src/main/kotlin/io/github/composegears/valkyrie/cli/command/SvgXmlToImageVectorCommand.kt

@@ -126,7 +126,7 @@ internal class SvgXmlToImageVectorCommand : CliktCommand(name = "svgxml2imagevec
 
     override val printHelpOnEmptyArgs: Boolean = true
 
-    override fun help(context: Context): String = "A CLI tool to convert SVG/XML into Compose ImageVector."
+    override fun help(context: Context): String = "A CLI tool to convert SVG/XML into Compose ImageVector"
 
     override fun run() {
         svgXml2ImageVector(

tools/cli/src/test/kotlin/io/github/composegears/valkyrie/cli/command/ChangelogCommandTest.kt

@@ -2,7 +2,6 @@ package io.github.composegears.valkyrie.cli.command
 
 import assertk.assertThat
 import assertk.assertions.contains
-import assertk.assertions.isEqualTo
 import assertk.assertions.isNotEmpty
 import com.github.ajalt.clikt.testing.test
 import kotlin.test.Test
@@ -13,8 +12,7 @@ class ChangelogCommandTest {
     fun `run should print CHANGELOG content`() {
         val result = ChangelogCommand().test()
 
-        val expectedChangelog = loadResourceText("CHANGELOG.md")
-        assertThat(result.output.trim()).isEqualTo(expectedChangelog.trim())
+        assertThat(result.output).contains("CLI Changelog")
     }
 
     @Test