Group options passed to groupChoice in help (#89)

ajalt · Sep 13, 2019 · e99df80 · e99df80
1 parent 3a0b254
commit e99df80
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 
 ### Fixed
 - Help output missing items when no help text is specified. ([#85](https://github.com/ajalt/clikt/issues/85))
+- Help output not grouping option in groups passed to `groupChoice`. ([#88](https://github.com/ajalt/clikt/issues/88))
 
 ## [2.1.0] - 2019-05-23 
 ### Added

diff --git a/clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt b/clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt
@@ -67,13 +67,6 @@ interface ParameterGroupDelegate<out T> : ParameterGroup, ReadOnlyProperty<Clikt
  *   val userOptions by UserOptions()
  * }
  * ```
- *
- * ### Note:
- *
- * If you're using IntelliJ, bug KT-31319 prevents [provideDelegate] from being imported
- * automatically, so until that's fixed, you'll need to add this import manually:
- *
- * `import com.github.ajalt.clikt.parameters.groups.provideDelegate`
  */
 open class OptionGroup(
         name: String? = null,

diff --git a/clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt b/clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt
@@ -48,7 +48,7 @@ interface Option {
         get() = when {
             hidden -> null
             else -> HelpFormatter.ParameterHelp.Option(names, secondaryNames, metavar, help, nvalues, helpTags,
-                    groupName = if (this is GroupableOption) parameterGroup?.groupName else null)
+                    groupName = if (this is GroupableOption) groupName ?: parameterGroup?.groupName else null)
         }
 
     /**

diff --git a/clikt/src/test/kotlin/com/github/ajalt/clikt/output/CliktHelpFormatterTest.kt b/clikt/src/test/kotlin/com/github/ajalt/clikt/output/CliktHelpFormatterTest.kt
@@ -8,6 +8,7 @@ import com.github.ajalt.clikt.parameters.arguments.argument
 import com.github.ajalt.clikt.parameters.arguments.multiple
 import com.github.ajalt.clikt.parameters.groups.OptionGroup
 import com.github.ajalt.clikt.parameters.groups.cooccurring
+import com.github.ajalt.clikt.parameters.groups.groupChoice
 import com.github.ajalt.clikt.parameters.groups.mutuallyExclusiveOptions
 import com.github.ajalt.clikt.parameters.options.*
 import com.github.ajalt.clikt.parameters.types.int
@@ -405,6 +406,36 @@ class CliktHelpFormatterTest {
                 """.trimMargin("|")
     }
 
+    @Test
+    @Suppress("unused")
+    fun `integration test with choice group`() {
+        class G1 : OptionGroup("G1") {
+            val opt1 by option()
+        }
+        class G2 : OptionGroup("G2") {
+            val opt2 by option()
+        }
+        class C : TestCommand() {
+            val opt by option().groupChoice("g1" to G1(), "g2" to G2())
+        }
+
+        val c = C()
+
+        c.getFormattedHelp() shouldBe """
+                |Usage: c [OPTIONS]
+                |
+                |G1:
+                |  --opt1 TEXT
+                |
+                |G2:
+                |  --opt2 TEXT
+                |
+                |Options:
+                |  --opt TEXT
+                |  -h, --help  Show this message and exit
+                """.trimMargin("|")
+    }
+
     @Test
     @Suppress("unused")
     fun `integration test`() {

diff --git a/docs/options.md b/docs/options.md
@@ -500,7 +500,7 @@ class FromDisk : LoadConfig("Options for loading from disk") {
     val followSymlinks by option().flag()
 }
 
-class FromNetwork: LoadConfig("Option for loading from network") {
+class FromNetwork: LoadConfig("Options for loading from network") {
     val url by option().required()
     val username by option().prompt()
     val password by option().prompt(hideInput = true)