help.go

package gommander

import (
	"fmt"
	"strings"
)

type HelpWriter struct{}

func (HelpWriter) Write(c *Command) {
	app := c._getAppRef()

	// TODO: Check settings

	fmter := NewFormatter(app)

	hasArgs := len(c.arguments) > 0
	hasDiscussion := len(c.discussion) > 0
	hasFlags := len(c.flags) > 0
	hasOptions := len(c.options) > 0
	hasSubcmds := len(c.subCommands) > 0
	hasCustomUsage := len(c.customUsageStr) > 0
	hasSubcmdGroups := len(c.subCmdGroups) > 0

	if len(c.help) > 0 {
		fmter.Add(Description, fmt.Sprintf("\n%v\n", c.help))
	}

	fmter.section("USAGE")
	fmter.Add(Keyword, fmt.Sprintf("    %v", c._getUsageStr()))
	if !hasCustomUsage {
		if hasFlags {
			fmter.Add(Other, " "+app.flagsHelpValue)
		}

		if hasOptions {
			fmter.Add(Other, " "+app.optionsHelpValue)
		}

		if hasArgs {
			fmter.Add(Other, " "+app.argsHelpValue)
		}

		if hasSubcmds {
			fmter.Add(Other, " "+app.subCmdsHelpValue)
		}
	}
	fmter.close()

	if app.settings[ShowCommandAliases] {
		fmter.section("ALIASES")
		fmter.Add(Description, fmt.Sprintf("    [%v]\n", strings.Join(c.aliases, ", ")))
	}

	if hasArgs {
		fmter.section(app.argsHelpHeading)
		fmter.format(standardize(c.arguments))
	}

	if hasFlags {
		fmter.section(app.flagsHelpHeading)
		fmter.format(standardize(c.flags))
	}

	if hasOptions {
		fmter.section(app.optionsHelpHeading)
		fmter.format(standardize(c.options))
	}

	if hasSubcmds && !hasSubcmdGroups {
		fmter.section(app.subCmdsHelpHeading)
		fmter.format(standardize(c.subCommands))
	}

	if hasSubcmds && hasSubcmdGroups {
		for k, v := range c.subCmdGroups {
			fmter.section(k)
			fmter.format(standardize(v))
		}
		// TODO: Simplify this logic
		groupContains := func(val *Command) bool {
			included, total := 0, 0
			for _, g := range c.subCmdGroups {
				total++
				if sliceContains(g, val) {
					included--
				} else {
					included++
				}
			}
			return included != total
		}

		otherCmds := []*Command{}
		for _, sc := range c.subCommands {
			if !groupContains(sc) {
				otherCmds = append(otherCmds, sc)
			}
		}

		if len(otherCmds) > 0 {
			fmter.section("Other Commands")
			fmter.format(standardize(otherCmds))
		}
	}

	if hasDiscussion {
		fmter.section("discussion")
		fmter.discussion(app.discussion)
	}

	fmter.Print()
}

func sliceContains(slice []*Command, val *Command) bool {
	for _, v := range slice {
		if v == val {
			return true
		}
	}

	return false
}

type FormatterType interface {
	*Command | *Flag | *Option | *Argument
	FormatGenerator
}

func standardize[T FormatterType](vals []T) []FormatGenerator {
	values := []FormatGenerator{}
	for _, c := range vals {
		values = append(values, c)
	}
	return values
}