feat(core): enhance config validation

Author: hanna-skryl

packages/core/src/lib/implementation/read-rc-file.ts

@@ -8,9 +8,9 @@ import {
   coreConfigSchema,
 } from '@code-pushup/models';
 import {
-  coreConfigMessageBuilder,
   fileExists,
   importModule,
+  zodErrorMessageBuilder,
 } from '@code-pushup/utils';
 
 export class ConfigPathError extends Error {
@@ -44,7 +44,7 @@ export async function readRcByPath(
     return coreConfigSchema.parse(cfg);
   } catch (error) {
     const validationError = fromError(error, {
-      messageBuilder: coreConfigMessageBuilder,
+      messageBuilder: zodErrorMessageBuilder,
     });
     throw isZodErrorLike(error)
       ? new ConfigValidationError(filepath, validationError.message)

packages/models/src/lib/category-config.unit.test.ts

@@ -176,7 +176,7 @@ describe('categoryConfigSchema', () => {
         ],
       } satisfies CategoryConfig),
     ).toThrow(
-      /In a category, there has to be at least one ref with weight > 0. Affected refs: \\"functional\/immutable-data\\", \\"lighthouse-experimental\\"/,
+      'In a category, there has to be at least one ref with weight > 0. Affected refs: functional/immutable-data, lighthouse-experimental',
     );
   });
 });

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

@@ -182,7 +182,7 @@ export function scorableSchema<T extends ReturnType<typeof weightedRefSchema>>(
         )
         // category weights are correct
         .refine(hasNonZeroWeightedRef, refs => {
-          const affectedRefs = refs.map(ref => `"${ref.slug}"`).join(', ');
+          const affectedRefs = refs.map(ref => ref.slug).join(', ');
           return {
             message: `In a category, there has to be at least one ref with weight > 0. Affected refs: ${affectedRefs}`,
           };

packages/plugin-lighthouse/src/lib/lighthouse-plugin.unit.test.ts

@@ -57,7 +57,7 @@ describe('lighthousePlugin-config-object', () => {
     });
 
     expect(() => pluginConfigSchema.parse(pluginConfig)).toThrow(
-      /In a category, there has to be at least one ref with weight > 0. Affected refs: \\"csp-xss\\"/,
+      'In a category, there has to be at least one ref with weight > 0. Affected refs: csp-xss',
     );
   });
 });

packages/utils/src/index.ts

@@ -122,4 +122,4 @@ export type {
   WithRequired,
 } from './lib/types.js';
 export { verboseUtils } from './lib/verbose-utils.js';
-export { coreConfigMessageBuilder } from './lib/zod-validation.js';
+export { zodErrorMessageBuilder } from './lib/zod-validation.js';

packages/utils/src/lib/zod-validation.ts

@@ -12,7 +12,7 @@ export function formatErrorPath(errorPath: (string | number)[]): string {
     .join('');
 }
 
-export const coreConfigMessageBuilder: MessageBuilder = issues =>
+export const zodErrorMessageBuilder: MessageBuilder = issues =>
   issues
     .map(issue => {
       const formattedMessage = red(`${bold(issue.code)}: ${issue.message}`);

packages/utils/src/lib/zod-validation.unit.test.ts

@@ -8,7 +8,7 @@ describe('formatErrorPath', () => {
     [['categories'], 'categories'],
     [[], ''],
     [['path', 5], 'path[5]'],
-  ])('formats error path correctly for $input', (input, expected) => {
+  ])('should format error path %j as %j', (input, expected) => {
     expect(formatErrorPath(input)).toBe(expected);
   });
 });