Method String

flag_bool_with_inverse.go:173–208

String implements the standard Stringer interface. Example for BoolFlag{Name: "env"} --[no-]env (default: false) Example for BoolFlag{Name: "env", Aliases: []string{"e"}} --[no-]env, -e (default: false)

()

// Example for BoolFlag{Name: "env", Aliases: []string{"e"}}
// --[no-]env, -e	(default: false)
func (bif *BoolWithInverseFlag) String() string {
	out := FlagStringer(bif)

	i := strings.Index(out, "\t")

	prefix := "--"

	// single character flags are prefixed with `-` instead of `--`
	if len(bif.Name) == 1 {
		prefix = "-"
	}

	// Guard against a FlagStringer that returns a string without a tab (e.g.
	// a custom stringer or the default stringer when the flag does not
	// implement DocGenerationFlag). In that case treat the entire output as
	// the tab-delimited suffix so the slice never goes out of bounds.
	if i < 0 {
		i = 0
	}

	var aliasParts []string
	for _, alias := range bif.Aliases {
		aPrefix := "--"
		if len(alias) == 1 {
			aPrefix = "-"
		}
		aliasParts = append(aliasParts, aPrefix+alias)
	}

	names := fmt.Sprintf("%s[%s]%s", prefix, bif.inversePrefix(), bif.Name)
	if len(aliasParts) > 0 {
		names = names + ", " + strings.Join(aliasParts, ", ")
	}

	return fmt.Sprintf("%s%s", names, out[i:])
}

// IsBoolFlag returns whether the flag doesn't need to accept args
func (bif *BoolWithInverseFlag) IsBoolFlag() bool {