Function Build

internal/cmdhelp/json.go:83–109

Build returns a cmdhelp Document without serializing it. Callers that need to inspect or further mutate the document (tests, dynamic enum resolvers in TASK-936) should use this and serialize themselves.

(target, root *cobra.Command, opts Options)

// need to inspect or further mutate the document (tests, dynamic enum
// resolvers in TASK-936) should use this and serialize themselves.
func Build(target, root *cobra.Command, opts Options) *Document {
	binary := opts.Binary
	if binary == "" {
		binary = root.Name()
	}

	doc := &Document{
		CmdhelpVersion: Version,
		Binary:         binary,
		Version:        opts.Version,
		Summary:        firstLine(root.Short),
		Homepage:       opts.Homepage,
		Commands:       map[string]Command{},
	}

	if globals := collectFlags(root.PersistentFlags()); len(globals) > 0 {
		doc.GlobalFlags = globals
	}

	walk(target, root, doc, 0, opts.MaxDepth)

	// Splice dynamic workspace facts after the static walk so callers
	// can inspect Build's output as either pre- or post-resolution.
	opts.Resolver.Apply(doc)

	return doc
}

func walk(cur, root *cobra.Command, doc *Document, depth, maxDepth int) {
	if cur == nil || cur.Hidden {