@code-pushup/models - npm Package Compare versions

Comparing version 0.60.2 to 0.61.0

package.json

 {
   "name": "@code-pushup/models",
-  "version": "0.60.2",
+  "version": "0.61.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "description": "Model definitions and validators for the Code PushUp CLI",

src/lib/audit.d.ts

@@ -7,3 +7,3 @@ import { z } from 'zod';
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -20,3 +20,3 @@ }>, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -38,3 +38,3 @@ }>;
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -51,3 +51,3 @@ }>, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -64,4 +64,4 @@ }>, "many">, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
 }[]>;

src/lib/category-config.d.ts

@@ -70,3 +70,3 @@ import { z } from 'zod';
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -98,3 +98,3 @@ }>, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -155,3 +155,3 @@ isBinary?: boolean | undefined;
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -183,3 +183,3 @@ }>, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -210,5 +210,5 @@ isBinary?: boolean | undefined;
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }[]>;

src/lib/group.d.ts

@@ -24,3 +24,3 @@ import { z } from 'zod';
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -35,3 +35,3 @@ }, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -75,3 +75,3 @@ }>;
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -96,3 +96,3 @@ }>, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -136,3 +136,3 @@ }>;
     description: z.ZodOptional<z.ZodString>;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
@@ -157,3 +157,3 @@ }>, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -178,4 +178,4 @@ }>, "many">>, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
 }[] | undefined>;

src/lib/implementation/schemas.d.ts

@@ -34,3 +34,3 @@ import { type ZodObject, type ZodOptional, type ZodString, z } from 'zod';
 /**  Schema for a docsUrl */
-export declare const docsUrlSchema: z.ZodUnion<[ZodOptional<ZodString>, z.ZodLiteral<"">]>;
+export declare const docsUrlSchema: z.ZodCatch<z.ZodUnion<[ZodOptional<ZodString>, z.ZodLiteral<"">]>>;
 /** Schema for a title of a plugin, category and audit */
@@ -55,3 +55,3 @@ export declare const titleSchema: ZodString;
     description: ZodOptional<ZodString>;
-    docsUrl: z.ZodUnion<[ZodOptional<ZodString>, z.ZodLiteral<"">]>;
+    docsUrl: z.ZodCatch<z.ZodUnion<[ZodOptional<ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: ZodOptional<z.ZodBoolean>;
@@ -66,3 +66,3 @@ }, "strip", z.ZodTypeAny, {
     description?: string | undefined;
-    docsUrl?: string | undefined;
+    docsUrl?: unknown;
     isSkipped?: boolean | undefined;
@@ -69,0 +69,0 @@ }>;

src/lib/implementation/schemas.js

@@ -39,4 +39,15 @@ import { MATERIAL_ICONS } from 'vscode-material-icons';
     .optional()
-    .or(z.literal(''))
-    .describe('Documentation site'); // allow empty string (no URL validation)
+    .or(z.literal('')) // allow empty string (no URL validation)
+    // eslint-disable-next-line unicorn/prefer-top-level-await, unicorn/catch-error-name
+    .catch(ctx => {
+    // if only URL validation fails, supress error since this metadata is optional anyway
+    if (ctx.error.errors.length === 1 &&
+        ctx.error.errors[0]?.code === 'invalid_string' &&
+        ctx.error.errors[0].validation === 'url') {
+        console.warn(`Ignoring invalid docsUrl: ${ctx.input}`);
+        return '';
+    }
+    throw ctx.error;
+})
+    .describe('Documentation site');
 /** Schema for a title of a plugin, category and audit */
@@ -43,0 +54,0 @@ export const titleSchema = z

No alert changes

Improved metrics

Lines of code

26016

increased by0.04%

Worsened metrics

Total package byte prevSize

2280944

decreased by-0.02%

No dependency changes