Method ModuleDoc

cmd/dagger/shell_help.go:301–382

(m *moduleDef)

}

func (h *shellCallHandler) ModuleDoc(m *moduleDef) string {
	var doc ShellDoc

	meta := new(strings.Builder)
	meta.WriteString(m.Name)

	description := m.Description
	if description == "" {
		if mainObj := m.GetObject(m.Name); mainObj != nil {
			description = mainObj.Description
		}
	}
	if description != "" {
		meta.WriteString("\n\n")
		meta.WriteString(description)
	}
	if meta.Len() > 0 {
		doc.Add("Module", meta.String())
	}

	// When entrypoint proxying is active, MainObject is Query and the
	// constructor is the synthetic `with` function. Look up the module's
	// named main object to get the original constructor and its functions.
	constr := m.MainObject.AsObject.Constructor
	mainObj := m.GetObject(m.Name)
	if mainObj != nil && mainObj.Constructor != nil && mainObj.Constructor.Name != "" {
		constr = mainObj.Constructor
	}

	usage := h.FunctionUseLine(m, constr)

	if len(constr.Args) > 0 {
		constructor := new(strings.Builder)
		constructor.WriteString("Usage: ")
		constructor.WriteString(usage)

		if constr.Description != "" {
			constructor.WriteString("\n\n")
			constructor.WriteString(constr.Description)
		}

		doc.Add("Entrypoint", constructor.String())

		if args := constr.RequiredArgs(); len(args) > 0 {
			doc.AddSection(
				"Required Arguments",
				nameShortWrapped(args, func(a *modFunctionArg) (string, string) {
					return strings.TrimPrefix(a.Usage(), "--"), a.Long()
				}),
			)
		}
		if args := constr.OptionalArgs(); len(args) > 0 {
			doc.AddSection(
				"Optional Arguments",
				nameShortWrapped(args, func(a *modFunctionArg) (string, string) {
					return a.Usage(), a.Long()
				}),
			)