@code-pushup/cli 0.4.5 → 0.5.1

package/README.md

@@ -144,6 +144,7 @@ Each example is fully tested to give demonstrate best practices for plugin testi
 **Example for custom plugins:**
 
 - [File Size](../../examples/plugins/src/file-size)
+- [Package Json](../../examples/plugins/src/package-json)
 
 ## CLI commands and options
 

package/index.js

@@ -137,12 +137,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 }
   );
@@ -151,6 +153,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(
@@ -196,6 +201,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";
@@ -204,10 +226,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.
 });
@@ -443,17 +465,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) {
@@ -504,15 +519,11 @@ 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/implementation/constants.ts
+var PERSIST_OUTPUT_DIR = ".code-pushup";
+var PERSIST_FORMAT = ["json"];
+var PERSIST_FILENAME = "report";
 
 // packages/models/src/lib/report.ts
 import { z as z12 } from "zod";
@@ -1399,6 +1410,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) {
@@ -1481,11 +1497,8 @@ var PersistError = class extends Error {
     super(`fileName: ${reportPath} could not be saved.`);
   }
 };
-async function persistReport(report, config) {
-  const { persist } = config;
-  const outputDir = persist.outputDir;
-  const filename = persist.filename;
-  const format = persist.format ?? [];
+async function persistReport(report, options2) {
+  const { outputDir, filename, format } = options2;
   let scoredReport = scoreReport(report);
   console.info(reportToStdout(scoredReport));
   const results = [
@@ -1640,7 +1653,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.4.5";
+var version = "0.5.1";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options2) {
@@ -1738,16 +1751,23 @@ function transformSeverity(severity) {
   }
 }
 
+// packages/core/src/lib/normalize.ts
+var normalizePersistConfig = (cfg) => ({
+  outputDir: PERSIST_OUTPUT_DIR,
+  filename: PERSIST_FILENAME,
+  format: PERSIST_FORMAT,
+  ...cfg
+});
+
 // packages/core/src/lib/upload.ts
 async function upload(options2, uploadFn = uploadToPortal) {
-  if (options2?.upload === void 0) {
-    throw new Error("upload config needs to be set");
+  const persist = normalizePersistConfig(options2?.persist);
+  if (!options2?.upload) {
+    throw new Error("upload config must be set");
   }
   const { apiKey, server, organization, project } = options2.upload;
-  const { outputDir, filename } = options2.persist;
   const report = await loadReport({
-    outputDir,
-    filename,
+    ...persist,
     format: "json"
   });
   const commitData = await getLatestCommit();
@@ -1767,7 +1787,8 @@ async function upload(options2, uploadFn = uploadToPortal) {
 async function collectAndPersistReports(options2) {
   const { exec } = verboseUtils(options2.verbose);
   const report = await collect(options2);
-  const persistResults = await persistReport(report, options2);
+  const persist = normalizePersistConfig(options2?.persist);
+  const persistResults = await persistReport(report, persist);
   exec(() => logPersistedResults(persistResults));
   report.plugins.forEach((plugin) => {
     pluginReportSchema.parse(plugin);
@@ -1791,7 +1812,7 @@ async function readCodePushupConfig(filepath) {
     {
       filepath
     },
-    coreConfigSchema.parse
+    (d) => coreConfigSchema.parse(d)
   );
 }
 
@@ -1961,9 +1982,13 @@ async function configMiddleware(processArgs) {
       ...importedRc.upload,
       ...cliOptions.upload
     },
+    // we can't use a async rc file as yargs does not support it. see: https://github.com/yargs/yargs/issues/2234
+    // therefore this can't live in option defaults as the order would be `config`->`provided options`->default
+    // so we have to manually implement the order
     persist: {
-      ...importedRc.persist,
-      ...cliOptions.persist
+      outputDir: cliOptions?.persist?.outputDir || importedRc?.persist?.outputDir || PERSIST_OUTPUT_DIR,
+      filename: cliOptions?.persist?.filename || importedRc?.persist?.filename || PERSIST_FILENAME,
+      format: cliOptions?.persist?.format || importedRc?.persist?.format || PERSIST_FORMAT
     },
     plugins: filterPluginsByOnlyPluginsOption(importedRc.plugins, cliOptions),
     categories: filterCategoryByOnlyPluginsOption(
@@ -1982,6 +2007,14 @@ var middlewares = [
 
 // packages/cli/src/lib/implementation/core-config-options.ts
 function yargsCoreConfigOptionsDefinition() {
+  return {
+    // persist
+    ...yargsPersistConfigOptionsDefinition(),
+    // upload
+    ...yargsUploadConfigOptionsDefinition()
+  };
+}
+function yargsPersistConfigOptionsDefinition() {
   return {
     // persist
     "persist.outputDir": {
@@ -1995,7 +2028,11 @@ function yargsCoreConfigOptionsDefinition() {
     "persist.format": {
       describe: "Format of the report output. e.g. `md`, `json`",
       type: "array"
-    },
+    }
+  };
+}
+function yargsUploadConfigOptionsDefinition() {
+  return {
     // upload
     "upload.organization": {
       describe: "Organization slug from portal",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.4.5",
+  "version": "0.5.1",
   "bin": {
     "code-pushup": "index.js"
   },

package/src/lib/implementation/config-middleware.d.ts

@@ -197,11 +197,6 @@ export declare function configMiddleware<T extends Partial<GeneralCliOptions & C
             docsUrl?: string | undefined;
         }[] | undefined;
     }[];
-    persist: {
-        outputDir: string;
-        filename: string;
-        format?: ("json" | "md")[] | undefined;
-    };
     categories: {
         title: string;
         slug: string;
@@ -215,6 +210,11 @@ export declare function configMiddleware<T extends Partial<GeneralCliOptions & C
         docsUrl?: string | undefined;
         isBinary?: boolean | undefined;
     }[];
+    persist?: {
+        outputDir?: string | undefined;
+        filename?: string | undefined;
+        format?: ("json" | "md")[] | undefined;
+    } | undefined;
     upload?: {
         server: string;
         apiKey: string;

package/src/lib/implementation/core-config-options.d.ts

@@ -1,5 +1,5 @@
 import { Options } from 'yargs';
-import { CoreConfigCliOptions } from './model';
-type ArgNames = keyof CoreConfigCliOptions;
-export declare function yargsCoreConfigOptionsDefinition(): Record<ArgNames, Options>;
-export {};
+import { CoreConfigCliOptions, PersistConfigCliOptions, UploadConfigCliOptions } from './model';
+export declare function yargsCoreConfigOptionsDefinition(): Record<keyof CoreConfigCliOptions, Options>;
+export declare function yargsPersistConfigOptionsDefinition(): Record<keyof PersistConfigCliOptions, Options>;
+export declare function yargsUploadConfigOptionsDefinition(): Record<keyof UploadConfigCliOptions, Options>;