Skip to content

Commit 162e9a8

Browse files
committed
Ensure markdown bullet points aren't printed in help outputs
1 parent aeb1886 commit 162e9a8

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

modules/cli/src/main/scala/scala/cli/commands/config/ConfigOptions.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ object ConfigOptions {
9393
s"""$helpHeader
9494
|
9595
|Available keys:
96-
| ${configKeysBulletPoints(includeHidden = false).mkString(s"${System.lineSeparator} ")}
96+
| ${configKeyMessages(includeHidden = false).mkString(s"${System.lineSeparator} ")}
9797
|
9898
|${HelpMessages.commandFullHelpReference(cmdName)}
9999
|${HelpMessages.commandDocWebsiteReference(websiteSuffix)}""".stripMargin
100-
private def configKeysBulletPoints(includeHidden: Boolean): Seq[String] = {
100+
private def configKeyMessages(includeHidden: Boolean): Seq[String] = {
101101
val allKeys: Seq[Key[_]] = Keys.map.values.toSeq
102102
val keys: Seq[Key[_]] = if includeHidden then allKeys else allKeys.filterNot(_.hidden)
103103
val maxFullNameLength = keys.map(_.fullName.length).max
@@ -108,7 +108,7 @@ object ConfigOptions {
108108
if currentKeyFullNameLength > 0 then " " * currentKeyFullNameLength else ""
109109
val hiddenString =
110110
if key.hidden then s"${ScalaCliConsole.GRAY}(hidden)${Console.RESET} " else ""
111-
s"- ${Console.YELLOW}${key.fullName}${Console.RESET}$extraSpaces $hiddenString${key.description}"
111+
s"${Console.YELLOW}${key.fullName}${Console.RESET}$extraSpaces $hiddenString${key.description}"
112112
}
113113
}
114114
val detailedHelpMessage: String =
@@ -120,7 +120,7 @@ object ConfigOptions {
120120
| ${Console.BOLD}$progName $cmdName interactive true${Console.RESET}
121121
|
122122
|Available keys:
123-
| ${configKeysBulletPoints(includeHidden = true).mkString(s"${System.lineSeparator} ")}
123+
| ${configKeyMessages(includeHidden = true).mkString(s"${System.lineSeparator} ")}
124124
|
125125
|${HelpMessages.commandDocWebsiteReference(websiteSuffix)}""".stripMargin
126126
}

modules/generate-reference-doc/src/main/scala/scala/cli/doc/ReferenceDocUtils.scala

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,16 @@ object ReferenceDocUtils {
4545
}
4646
def filterOutHiddenStrings: String =
4747
s.replace(s"${ScalaCliConsole.GRAY}(hidden)${Console.RESET} ", "")
48+
def consoleYellowToMdBullets: String = s.replace(Console.YELLOW, "- ")
49+
def consoleToMarkdown: String = s.filterOutHiddenStrings.consoleYellowToMdBullets.consoleToFence
4850
}
4951
extension (helpMessage: HelpMessage) {
50-
def referenceDocMessage: String = helpMessage.message.filterOutHiddenStrings.consoleToFence
52+
def referenceDocMessage: String = helpMessage.message.consoleToMarkdown
5153
def referenceDocDetailedMessage: String = {
5254
val msg =
5355
if helpMessage.detailedMessage.nonEmpty then helpMessage.detailedMessage
5456
else helpMessage.message
55-
msg.filterOutHiddenStrings.consoleToFence
57+
msg.consoleToMarkdown
5658
}
5759
}
5860

0 commit comments

Comments
 (0)