Function parseExamplesFromLong

internal/cmdhelp/json.go:200–256

parseExamplesFromLong extracts the indented invocation lines that follow an "Examples:" header in a cobra Long string. Returns nil when no such section exists or no example lines are found. The block ends at: - a blank line after at least one example was collected, OR - an unindented line after at

(long string)

// Comment lines (starting with `#`) inside the block are dropped.
// Used as a fallback in buildCommand when cmd.Example is empty.
func parseExamplesFromLong(long string) []Example {
	if long == "" {
		return nil
	}
	lines := strings.Split(long, "\n")

	startIdx := -1
	for i, line := range lines {
		if examplesHeaderRE.MatchString(line) {
			startIdx = i + 1
			break
		}
	}
	if startIdx < 0 {
		return nil
	}

	var examples []Example
	for i := startIdx; i < len(lines); i++ {
		line := lines[i]
		trimmed := strings.TrimSpace(line)

		// Blank line: end of block if we already collected something.
		// Skip otherwise (the section may start with a blank line).
		if trimmed == "" {
			if len(examples) > 0 {
				break
			}
			continue
		}
		// Comment lines are dropped from the example set.
		if strings.HasPrefix(trimmed, "#") {
			continue
		}
		// Unindented line after we started collecting → end of block.
		// Detected as: the trimmed text equals the original (no leading
		// whitespace was stripped).
		if line == trimmed && len(examples) > 0 {
			break
		}
		// Strip a trailing same-line comment ("  # blah") so it doesn't
		// pollute the recorded example. Pad's existing Long blocks use
		// this idiom occasionally, e.g.
		//   pad attachment list --item TASK-5    # one item's attachments
		if hashIdx := stripCommentIndex(trimmed); hashIdx >= 0 {
			trimmed = strings.TrimRight(trimmed[:hashIdx], " \t")
		}
		if trimmed == "" {
			continue
		}
		examples = append(examples, Example{Cmd: trimmed})
	}
	if len(examples) == 0 {
		return nil
	}
	return examples
}