Function commandMetadataSection

tools/gen-docs/main.go:138–238

(command *cobra.Command)

}

func commandMetadataSection(command *cobra.Command) []byte {
	manifest := cmd.CommandManifestFor(command)
	var buf bytes.Buffer
	buf.WriteString("### Command metadata\n\n")
	fmt.Fprintf(&buf, "* Structured JSON output: %s\n", yesNo(manifest.SupportsStructuredOutput))
	buf.WriteString("* JSON help manifest: yes\n")
	buf.WriteString("* Manifest version: `" + manifest.ManifestVersion + "`\n")
	buf.WriteString("* Auth modes: " + markdownValueList(manifest.AuthModes) + "\n")
	buf.WriteString("* Dropbox scopes: " + markdownValueList(manifest.DropboxScopes) + "\n")

	if aliases := sortedAliases(command); len(aliases) > 0 {
		buf.WriteString("* Aliases: ")
		for i, alias := range aliases {
			if i > 0 {
				buf.WriteString(", ")
			}
			buf.WriteString("`" + alias + "`")
		}
		buf.WriteString("\n")
	}

	if len(manifest.Args) > 0 {
		buf.WriteString("* Arguments: ")
		for i, arg := range manifest.Args {
			if i > 0 {
				buf.WriteString(", ")
			}
			requirement := "optional"
			if arg.Required {
				requirement = "required"
			}
			variadic := ""
			if arg.Variadic {
				variadic = ", variadic"
			}
			streamDash := ""
			if arg.StreamDash {
				streamDash = ", `-` stream operand"
			}
			enumValues := ""
			if len(arg.EnumValues) > 0 {
				enumValues = "; values: " + markdownValueList(arg.EnumValues)
			}
			fmt.Fprintf(&buf, "`%s` (%s, %s%s%s%s)", arg.Name, requirement, arg.ValueKind, variadic, streamDash, enumValues)
		}
		buf.WriteString("\n")
	}

	if len(manifest.Flags) > 0 {
		var describedFlags []string
		for _, flag := range manifest.Flags {
			var details []string
			if len(flag.EnumValues) > 0 {
				details = append(details, "values: "+markdownValueList(flag.EnumValues))
			}
			if len(flag.Conflicts) > 0 {
				details = append(details, "conflicts: "+markdownValueList(flag.Conflicts))
			}