Improve suggestion text clarity when printing ErrorWithSuggestion

[JeffreyCA]

Originally posted by @ellismg in #4585 (comment):

One of the things that jumped out at me with them (which I don't think is a problem introduced by this PR) is that the suggestion text is sort of hard to find, especially with the large amount of red text before.

In a future PR we might want to introduce some whitespace (and maybe some color?) to help it pop a little more - just my two cents.

The place where this happens is in:

azure-dev/cli/azd/cmd/middleware/ux.go

Lines 46 to 48 in 84b605c

	if errors.As(err, &suggestionErr) {
	m.console.Message(ctx, suggestionErr.Suggestion)
	}

I think to customize this we could use one of the pre-defined text formats in colors.go or possibly define a new format for error suggestions:

Current

With newline

Bold

Italics

Underline

Warning

[JeffreyCA]

@SophCarp @ccbarragan I don't think this is high priority, but wanted to get your thoughts on how we could improve the clarity here. I included screenshots of some styling options we could explore (not an exhaustive list).

[ccbarragan]

@JeffreyCA YES, love these explorations.

Should definitely add the new line after the error for better readability. As for the suggestion, IMO would be nice for suggestions to take the same styling as the existing Hint pattern as those two are similar -- will defer to @SophCarp on that one.

[JeffreyCA]

@JeffreyCA YES, love these explorations.

Should definitely add the new line after the error for better readability. As for the suggestion, IMO would be nice for suggestions to take the same styling as the existing Hint pattern as those two are similar -- will defer to @SophCarp on that one.

Do you mind sharing what that Hint pattern looks like, and what scenarios it shows up in?