Function FormatImportCycleError

pkg/parser/import_error.go:38–69

FormatImportCycleError formats an import cycle error with a delightful multiline indented display

(err *ImportCycleError)

// FormatImportCycleError formats an import cycle error with a delightful multiline indented display
func FormatImportCycleError(err *ImportCycleError) error {
	importErrorLog.Printf("Formatting import cycle error: chain=%v, workflow=%s", err.Chain, err.WorkflowFile)

	if len(err.Chain) < 2 {
		return errors.New("circular import detected (invalid chain)")
	}

	// Build a multiline, indented representation of the import chain
	var messageBuilder strings.Builder
	messageBuilder.WriteString("Import cycle detected\n\n")
	messageBuilder.WriteString("The following import chain creates a circular dependency:\n\n")

	// Show each step in the chain with indentation to emphasize the flow
	for i, file := range err.Chain {
		indent := strings.Repeat("  ", i)
		if i == 0 {
			fmt.Fprintf(&messageBuilder, "%s%s (starting point)\n", indent, file)
		} else if i == len(err.Chain)-1 {
			// Last item is the back-edge - highlight it
			fmt.Fprintf(&messageBuilder, "%s↳ %s ⚠️  cycles back to %s\n", indent, file, err.Chain[0])
		} else {
			fmt.Fprintf(&messageBuilder, "%s↳ imports %s\n", indent, file)
		}
	}

	messageBuilder.WriteString("\nTo fix this issue:\n")
	messageBuilder.WriteString("1. Review the import dependencies in the files listed above\n")
	messageBuilder.WriteString("2. Remove one of the imports to break the cycle\n")
	messageBuilder.WriteString("3. Consider restructuring your workflow imports to avoid circular dependencies\n")

	return &FormattedParserError{formatted: messageBuilder.String(), cause: err}
}

// FormattedParserError is a sentinel error type returned by FormatImportError (and similar
// parser-level formatters) to signal that the error message is already console-formatted