Remove indent when generating Example lines in usage

Signed-off-by: Vui Lam <vui.lam@broadcom.com>
vmware-tanzu · May 2, 2024 · 68d7c2f · 68d7c2f
1 parent ad724a2
commit 68d7c2f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/plugin/usage.go b/plugin/usage.go
@@ -289,7 +289,11 @@ func printHelp(cmd *cobra.Command) string {
 
 	if cmd.HasExample() {
 		output.WriteString("\n" + component.Bold(examplesStr) + "\n")
-		output.WriteString(indentStr + cmd.Example + "\n")
+
+		// matches cobra default help template's behavior of not indenting the
+		// Example value, which has the added benefit of ensuring multiline
+		// .Example values are aligned
+		output.WriteString(cmd.Example + "\n")
 	}
 
 	if cmd.HasAvailableSubCommands() {

diff --git a/plugin/usage_test.go b/plugin/usage_test.go
@@ -179,7 +179,7 @@ Aliases:
   test, t
 
 Examples:
-  sample example usage of the test command
+sample example usage of the test command
 
 Available Commands:
   fetch         Fetch the plugin tests
@@ -240,7 +240,7 @@ Aliases:
   test, t
 
 Examples:
-  sample example usage of the test command
+sample example usage of the test command
 
 Available Commands:
   fetch         Fetch the plugin tests
@@ -301,7 +301,7 @@ Aliases:
   test, t
 
 Examples:
-  sample example usage of the test command
+sample example usage of the test command
 
 Available Commands:
   fetch         Fetch the plugin tests
@@ -357,7 +357,7 @@ Usage:
   tanzu test fetch [flags]
 
 Examples:
-  sample example usage of the fetch command
+sample example usage of the fetch command
 
 Flags:
   -h, --help           help for fetch
@@ -415,7 +415,7 @@ Usage:
   tanzu fetch [flags]
 
 Examples:
-  sample example usage of the fetch command
+sample example usage of the fetch command
 
 Flags:
   -h, --help           help for fetch
@@ -469,7 +469,7 @@ Usage:
   tanzu kubernetes test fetch [flags]
 
 Examples:
-  sample example usage of the fetch command
+sample example usage of the fetch command
 
 Flags:
   -h, --help           help for fetch
@@ -521,7 +521,7 @@ Usage:
   tanzu mission-control test fetch [flags]
 
 Examples:
-  sample example usage of the fetch command
+sample example usage of the fetch command
 
 Flags:
   -h, --help           help for fetch
@@ -584,7 +584,7 @@ Aliases:
   pu, psh
 
 Examples:
-  sample example usage of the push command
+sample example usage of the push command
 
 Available Commands:
   more        Push more