@code-pushup/utils 0.4.5 → 0.5.2

package/index.js

@@ -124,12 +124,14 @@ function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessa
   return z.object(
     {
       slug: slugSchema('Human-readable unique ID, e.g. "performance"'),
-      refs: z.array(refSchema).refine(
+      refs: z.array(refSchema).min(1).refine(
         (refs) => !duplicateCheckFn(refs),
         (refs) => ({
           message: duplicateMessageFn(refs)
         })
-      )
+      ).refine(hasWeightedRefsInCategories, () => ({
+        message: `In a category there has to be at least one ref with weight > 0`
+      }))
     },
     { description }
   );
@@ -138,6 +140,9 @@ var materialIconSchema = z.enum(
   MATERIAL_ICONS,
   { description: "Icon from VSCode Material Icons extension" }
 );
+function hasWeightedRefsInCategories(categoryRefs) {
+  return categoryRefs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
+}
 
 // packages/models/src/lib/category-config.ts
 var categoryRefSchema = weightedRefSchema(
@@ -183,6 +188,23 @@ function getDuplicateRefsInCategoryMetrics(metrics) {
     metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`)
   );
 }
+var categoriesSchema = z2.array(categoryConfigSchema, {
+  description: "Categorization of individual audits"
+}).min(1).refine(
+  (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
+  (categoryCfg) => ({
+    message: duplicateSlugCategoriesErrorMsg(categoryCfg)
+  })
+);
+function duplicateSlugCategoriesErrorMsg(categories) {
+  const duplicateStringSlugs = getDuplicateSlugCategories(categories);
+  return `In the categories, the following slugs are duplicated: ${errorItems(
+    duplicateStringSlugs
+  )}`;
+}
+function getDuplicateSlugCategories(categories) {
+  return hasDuplicateStrings(categories.map(({ slug }) => slug));
+}
 
 // packages/models/src/lib/core-config.ts
 import { z as z11 } from "zod";
@@ -191,10 +213,10 @@ import { z as z11 } from "zod";
 import { z as z3 } from "zod";
 var formatSchema = z3.enum(["json", "md"]);
 var persistConfigSchema = z3.object({
-  outputDir: filePathSchema("Artifacts folder"),
-  filename: fileNameSchema("Artifacts file name (without extension)").default(
-    "report"
-  ),
+  outputDir: filePathSchema("Artifacts folder").optional(),
+  filename: fileNameSchema(
+    "Artifacts file name (without extension)"
+  ).optional(),
   format: z3.array(formatSchema).default(["json"]).optional()
   // @TODO remove default or optional value and otherwise it will not set defaults.
 });
@@ -430,17 +452,10 @@ var unrefinedCoreConfigSchema = z11.object({
     description: "List of plugins to be used (official, community-provided, or custom)"
   }),
   /** portal configuration for persisting results */
-  persist: persistConfigSchema,
+  persist: persistConfigSchema.optional(),
   /** portal configuration for uploading results */
   upload: uploadConfigSchema.optional(),
-  categories: z11.array(categoryConfigSchema, {
-    description: "Categorization of individual audits"
-  }).refine(
-    (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
-    (categoryCfg) => ({
-      message: duplicateSlugCategoriesErrorMsg(categoryCfg)
-    })
-  )
+  categories: categoriesSchema
 });
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
@@ -491,15 +506,6 @@ function getMissingRefsForCategories(coreCfg) {
   }
   return missingRefs.length ? missingRefs : false;
 }
-function duplicateSlugCategoriesErrorMsg(categories) {
-  const duplicateStringSlugs = getDuplicateSlugCategories(categories);
-  return `In the categories, the following slugs are duplicated: ${errorItems(
-    duplicateStringSlugs
-  )}`;
-}
-function getDuplicateSlugCategories(categories) {
-  return hasDuplicateStrings(categories.map(({ slug }) => slug));
-}
 
 // packages/models/src/lib/report.ts
 import { z as z12 } from "zod";
@@ -1474,6 +1480,11 @@ function calculateScore(refs, scoreFn) {
     },
     { numerator: 0, denominator: 0 }
   );
+  if (!numerator && !denominator) {
+    throw new Error(
+      "0 division for score. This can be caused by refs only weighted with 0 or empty refs"
+    );
+  }
   return numerator / denominator;
 }
 function scoreReport(report) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.4.5",
+  "version": "0.5.2",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/lib/file-system.d.ts

@@ -12,7 +12,7 @@ export declare function logMultipleFileResults(fileResults: MultipleFileResults,
 export declare class NoExportError extends Error {
     constructor(filepath: string);
 }
-export declare function importEsmModule<T = unknown>(options: Options, parse?: (d: unknown) => T): Promise<T>;
+export declare function importEsmModule<T = unknown>(options: Options, parse?: (d: any) => T): Promise<T>;
 export declare function pluginWorkDir(slug: string): string;
 export type CrawlFileSystemOptions<T> = {
     directory: string;