fix: help for positional arg

scaleway · Mar 10, 2020 · fef196c · fef196c
1 parent 21dd700
commit fef196c
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/internal/core/cobra_builder.go b/internal/core/cobra_builder.go
@@ -127,8 +127,8 @@ func (b *cobraBuilder) hydrateCobra(cobraCmd *cobra.Command, cmd *Command) {
 	if cobraCmd.HasAvailableSubCommands() || len(cobraCmd.Commands()) > 0 {
 		cobraCmd.Annotations["CommandUsage"] += " <command>"
 	}
-	if cobraCmd.HasAvailableLocalFlags() || cobraCmd.HasAvailableFlags() || cobraCmd.LocalFlags() != nil {
-		cobraCmd.Annotations["CommandUsage"] += " [flags]"
+	if positionalArg := cmd.ArgSpecs.GetPositionalArg(); positionalArg != nil {
+		cobraCmd.Annotations["CommandUsage"] += " <" + positionalArg.Name + ">"
 	}
 	if len(cmd.ArgSpecs) > 0 {
 		cobraCmd.Annotations["CommandUsage"] += " [arg=value ...]"

diff --git a/internal/core/cobra_utils_test.go b/internal/core/cobra_utils_test.go
@@ -145,4 +145,13 @@ func Test_PositionalArg(t *testing.T) {
 		Cmd:      "scw test-positional plop tag=world",
 		Check:    TestCheckExitCode(0),
 	}))
+
+	t.Run("full command", Test(&TestConfig{
+		Commands: testGetCommands(),
+		Cmd:      "scw test-positional -h",
+		Check: TestCheckCombine(
+			TestCheckExitCode(0),
+			TestCheckGolden(),
+		),
+	}))
 }
diff --git a/internal/core/testdata/test-positional-arg-full-command#01.stderr.golden b/internal/core/testdata/test-positional-arg-full-command#01.stderr.golden
@@ -0,0 +1,14 @@
+USAGE:
+  scw [global-flags] test-positional <name-id> [arg=value ...]
+
+ARGS:
+  [name-id]   
+  [tag]       
+
+FLAGS:
+  -h, --help   help for test-positional
+
+GLOBAL FLAGS:
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human
+  -p, --profile string   The config profile to use