refactor: put option blurbs on new line when one breaches threshold

Author: steverusso

examples_test.go

@@ -325,7 +325,9 @@ func ExampleDefaultShortHelp_complex() {
 		Opt(cli.NewOpt("bb").
 			Help("another option that is required and has a really long blurb to show how it will be wrapped").
 			Required()).
-		Opt(cli.NewOpt("short-blurb-but-really-long-name").Help("another option")).
+		Opt(cli.NewOpt("kind-of-a-long-name").
+			Help("due to this option's name, the blurbs for each option on this command " +
+				"will begin on their own non-indented lines")).
 		Arg(cli.NewArg("posarg1").Required().Help("a required positional argument")).
 		Arg(cli.NewArg("posarg2").Env("PA2").Help("an optional positional argument")).
 		Opt(cli.NewBoolOpt("h").
@@ -343,12 +345,16 @@ func ExampleDefaultShortHelp_complex() {
 	//   example [options] [arguments]
 	//
 	// options:
-	//       --aa  <arg>   an option (default: def) [$AA]
-	//       --bb  <arg>   another option that is required and has a really long blurb to show
-	//                     how it will be wrapped (required)
-	//   -h                will show the default short help message
-	//       --short-blurb-but-really-long-name  <arg>
-	//                     another option
+	//   --aa  <arg>
+	//       an option (default: def) [$AA]
+	//   --bb  <arg>
+	//       another option that is required and has a really long blurb to show how it will be
+	//       wrapped (required)
+	//   -h
+	//       will show the default short help message
+	//   --kind-of-a-long-name  <arg>
+	//       due to this option's name, the blurbs for each option on this command will begin on
+	//       their own non-indented lines
 	//
 	// arguments:
 	//   <posarg1>   a required positional argument (required)

help.go

@@ -64,33 +64,76 @@ func DefaultShortHelp(c *CommandInfo) string {
 		return strings.Compare(nameToCmpA, nameToCmpB)
 	})
 
-	var optNameColWidth int
+	var nonCondensedOpts bool
 	for i := range c.Opts {
-		if l := len(c.Opts[i].optUsgNameAndArg()); l > optNameColWidth && l <= helpShortMsgMaxFirstColLen {
-			optNameColWidth = l
+		if l := len(c.Opts[i].optUsgNameAndArg()); l >= helpShortMsgMaxFirstColLen {
+			nonCondensedOpts = true
+			break
 		}
 	}
-	for _, o := range opts {
-		paddedNameAndArg := fmt.Sprintf("  %-*s", optNameColWidth, o.optUsgNameAndArg())
-		desc := o.HelpBlurb
-		if o.IsRequired {
-			desc += " (required)"
-		}
-		if o.HasStrDefault {
-			desc += fmt.Sprintf(" (default: %v)", o.StrDefault)
+
+	if nonCondensedOpts {
+		for _, o := range opts {
+			desc := o.HelpBlurb
+			if o.IsRequired {
+				desc += " (required)"
+			}
+			if o.HasStrDefault {
+				desc += fmt.Sprintf(" (default: %v)", o.StrDefault)
+			}
+			if o.EnvVar != "" {
+				desc += " [$" + o.EnvVar + "]"
+			}
+			var namesAndVal string
+			{
+				if o.NameShort != "" {
+					namesAndVal += "-" + o.NameShort
+				}
+				if o.NameLong != "" {
+					if o.NameShort != "" {
+						namesAndVal += ", "
+					}
+					namesAndVal += "--" + o.NameLong
+				}
+				if an := o.optUsgArgName(); an != "" {
+					namesAndVal += "  " + an
+				}
+			}
+			content := "  " + namesAndVal
+			content += "\n" + strings.Repeat(" ", 6)
+			content += wrapBlurb(desc, 6, helpMsgTextWidth)
+			u.WriteString(content)
+			u.WriteByte('\n')
 		}
-		if o.EnvVar != "" {
-			desc += " [$" + o.EnvVar + "]"
+	} else {
+		var optNameColWidth int
+		for i := range c.Opts {
+			if l := len(c.Opts[i].optUsgNameAndArg()); l > optNameColWidth && l <= helpShortMsgMaxFirstColLen {
+				optNameColWidth = l
+			}
 		}
-		content := paddedNameAndArg
-		if len(paddedNameAndArg) > helpShortMsgMaxFirstColLen {
-			content += "\n" + strings.Repeat(" ", optNameColWidth+5)
-		} else {
-			content += "   "
+		for _, o := range opts {
+			paddedNameAndArg := fmt.Sprintf("  %-*s", optNameColWidth, o.optUsgNameAndArg())
+			desc := o.HelpBlurb
+			if o.IsRequired {
+				desc += " (required)"
+			}
+			if o.HasStrDefault {
+				desc += fmt.Sprintf(" (default: %v)", o.StrDefault)
+			}
+			if o.EnvVar != "" {
+				desc += " [$" + o.EnvVar + "]"
+			}
+			content := paddedNameAndArg
+			if len(paddedNameAndArg) > helpShortMsgMaxFirstColLen {
+				content += "\n" + strings.Repeat(" ", optNameColWidth+5)
+			} else {
+				content += "   "
+			}
+			content += wrapBlurb(desc, len(paddedNameAndArg)+3, helpMsgTextWidth)
+			u.WriteString(content)
+			u.WriteByte('\n')
 		}
-		content += wrapBlurb(desc, len(paddedNameAndArg)+3, helpMsgTextWidth)
-		u.WriteString(content)
-		u.WriteByte('\n')
 	}
 
 	if len(c.Args) > 0 {
@@ -218,14 +261,12 @@ func DefaultFullHelp(c *CommandInfo) string {
 			if o.NameShort != "" {
 				usgNamesAndArg += "-" + o.NameShort
 			}
-
 			if o.NameLong != "" {
 				if o.NameShort != "" {
 					usgNamesAndArg += ", "
 				}
 				usgNamesAndArg += "--" + o.NameLong
 			}
-
 			if an := o.optUsgArgName(); an != "" {
 				usgNamesAndArg += "  " + an
 			}