Method ToDisplayString

common/errors.go:84–112

ToDisplayString returns the error set to a newline delimited string.

()

// ToDisplayString returns the error set to a newline delimited string.
func (e *Errors) ToDisplayString() string {
	errorsInString := e.maxErrorsToReport
	if e.numErrors > e.maxErrorsToReport {
		// add one more error to indicate the number of errors truncated.
		errorsInString++
	} else {
		// otherwise the error set will just contain the number of errors.
		errorsInString = e.numErrors
	}

	result := make([]string, errorsInString)
	sort.SliceStable(e.errors, func(i, j int) bool {
		ei := e.errors[i].Location
		ej := e.errors[j].Location
		return ei.Line() < ej.Line() ||
			(ei.Line() == ej.Line() && ei.Column() < ej.Column())
	})
	for i, err := range e.errors {
		// This can happen during the append of two errors objects
		if i >= e.maxErrorsToReport {
			break
		}
		result[i] = err.ToDisplayString(e.source)
	}
	if e.numErrors > e.maxErrorsToReport {
		result[e.maxErrorsToReport] = fmt.Sprintf("%d more errors were truncated", e.numErrors-e.maxErrorsToReport)
	}
	return strings.Join(result, "\n")
}