Human Readable Error Messages

[stuft2]

I've struggled to find a great way to print human readable error messages given a set of TypeBox ValueErrors. This was my best attempt without diving too far into specific types and rewording error messages (e.g. not replacing Expected required property with Missing property).

import type { ValueErrorIterator } from '@sinclair/typebox/value'

function humanizeValueErrors (errors: ValueErrorIterator): string {
  return Array.from(errors)
    .map((error, index) => {
      let valueStr: string
      try {
        // If the value is an object, format it as JSON with indentation for readability.
        valueStr =
              typeof error.value === 'object' && error.value !== null
                ? JSON.stringify(error.value, null, 2)
                : String(error.value)
      } catch {
        valueStr = String(error.value)
      }
      return `${error.message} at ${error.path || '/'}, but got ${valueStr}`
    }).join('\n')
}

It outputs messages like the following:

Expected required property at /foo, but got undefined
Expected string at /bar, but got undefined
Expected union value at /, but got {}
Expected all values to match at /, but got {}

I'm not sure how to improve the messages around union values. I'd love to hear others' thoughts or see other solutions!