feat(utils): prettify zod errors in stringifyError utility

Author: matejchalk

packages/models/src/lib/implementation/validate.ts

@@ -23,6 +23,7 @@ export class SchemaValidationError extends Error {
       .filter(Boolean)
       .join(' ');
     super(`${summary}\n${formattedError}\n`);
+    this.name = SchemaValidationError.name;
   }
 }
 

packages/utils/package.json

@@ -37,7 +37,8 @@
     "multi-progress-bars": "^5.0.3",
     "semver": "^7.6.0",
     "simple-git": "^3.20.0",
-    "ora": "^9.0.0"
+    "ora": "^9.0.0",
+    "zod": "^4.0.5"
   },
   "files": [
     "src",

packages/utils/src/lib/errors.ts

@@ -1,5 +1,13 @@
+import { ZodError, z } from 'zod';
+
 export function stringifyError(error: unknown): string {
-  // TODO: special handling for ZodError instances
+  if (error instanceof ZodError) {
+    const formattedError = z.prettifyError(error);
+    if (formattedError.includes('\n')) {
+      return `${error.name}:\n${formattedError}\n`;
+    }
+    return `${error.name}: ${formattedError}`;
+  }
   if (error instanceof Error) {
     if (error.name === 'Error' || error.message.startsWith(error.name)) {
       return error.message;

packages/utils/src/lib/errors.unit.test.ts

@@ -1,3 +1,6 @@
+import ansis from 'ansis';
+import { z } from 'zod';
+import { SchemaValidationError } from '@code-pushup/models';
 import { stringifyError } from './errors.js';
 
 describe('stringifyError', () => {
@@ -22,4 +25,52 @@ describe('stringifyError', () => {
       '{"status":400,"statusText":"Bad Request"}',
     );
   });
+
+  it('should prettify ZodError instances spanning multiple lines', () => {
+    const schema = z.object({
+      name: z.string().min(1),
+      address: z.string(),
+      dateOfBirth: z.iso.date().optional(),
+    });
+    const { error } = schema.safeParse({ name: '', dateOfBirth: '' });
+
+    expect(stringifyError(error)).toBe(`ZodError:
+✖ Too small: expected string to have >=1 characters
+  → at name
+✖ Invalid input: expected string, received undefined
+  → at address
+✖ Invalid ISO date
+  → at dateOfBirth
+`);
+  });
+
+  it('should prettify ZodError instances on one line if possible', () => {
+    const schema = z.enum(['json', 'md']);
+    const { error } = schema.safeParse('html');
+
+    expect(stringifyError(error)).toBe(
+      'ZodError: ✖ Invalid option: expected one of "json"|"md"',
+    );
+  });
+
+  it('should use custom SchemaValidationError formatted messages', () => {
+    const schema = z
+      .object({
+        name: z.string().min(1),
+        address: z.string(),
+        dateOfBirth: z.iso.date().optional(),
+      })
+      .meta({ title: 'User' });
+    const { error } = schema.safeParse({ name: '', dateOfBirth: '' });
+
+    expect(stringifyError(new SchemaValidationError(error!, schema, {})))
+      .toBe(`SchemaValidationError: Invalid ${ansis.bold('User')}
+✖ Too small: expected string to have >=1 characters
+  → at name
+✖ Invalid input: expected string, received undefined
+  → at address
+✖ Invalid ISO date
+  → at dateOfBirth
+`);
+  });
 });