Method ExamplesList

internal/docs/docs.go:177–243

()

}

func (cmd Command) ExamplesList() []Example {
	type exampleBuilder struct {
		desc      string
		codeLines []string
	}

	var examples []Example
	current := exampleBuilder{}

	flush := func() {
		code := strings.TrimSpace(strings.Join(current.codeLines, "\n"))
		if code == "" {
			current = exampleBuilder{}
			return
		}

		formattedExample := Example{
			Desc: current.desc,
			Code: code,
		}
		if cmd.RunInWebCLI &&
			!strings.Contains(code, ">") &&
			!strings.Contains(code, "<") &&
			!strings.Contains(code, "output") &&
			!strings.Contains(code, "-F") &&
			!strings.Contains(code, "|") {
			formattedExample.WebCLICommand = strings.ReplaceAll(code, `"`, `\"`)
		}

		examples = append(examples, formattedExample)
		current = exampleBuilder{}
	}

	for _, rawLine := range strings.Split(cmd.Examples, "\n") {
		line := strings.TrimSpace(rawLine)
		if line == "" {
			if len(current.codeLines) > 0 {
				flush()
			}
			continue
		}

		switch {
		case strings.HasPrefix(line, "#"):
			flush()
			current.desc = strings.TrimSpace(strings.TrimPrefix(line, "#"))
		case strings.HasPrefix(line, "$"):
			if current.desc == "" && len(current.codeLines) > 0 {
				flush()
			}
			current.codeLines = append(
				current.codeLines,
				strings.TrimSpace(strings.TrimPrefix(line, "$")),
			)
		case len(current.codeLines) > 0:
			current.codeLines = append(current.codeLines, line)
		case current.desc == "":
			current.desc = line