@code-pushup/cli 0.4.4 → 0.5.0

package/README.md

@@ -8,6 +8,12 @@
 
 ---
 
+|                  📊 Getting Started                  |               🌐 Portal Integration                |              🛠️ CI Automation              |
+| :--------------------------------------------------: | :------------------------------------------------: | :----------------------------------------: |
+| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** |
+
+---
+
 The Code PushUp CLI serves to **collect audit results**, and optionally **upload the report** to the Code PushUp portal.
 
 It can be used locally in your repository, or integrated in your CI environment.
@@ -109,7 +115,7 @@ export default {
 };
 ```
 
-## CI automation
+## 🛠 CI automation
 
 Example for GitHub Actions:
 
@@ -138,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(
@@ -448,10 +453,10 @@ var unrefinedCoreConfigSchema = z11.object({
   upload: uploadConfigSchema.optional(),
   categories: z11.array(categoryConfigSchema, {
     description: "Categorization of individual audits"
-  }).refine(
-    (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
-    (categoryCfg) => ({
-      message: duplicateSlugCategoriesErrorMsg(categoryCfg)
+  }).min(1).refine(
+    (categories) => !getDuplicateSlugCategories(categories),
+    (categories) => ({
+      message: duplicateSlugCategoriesErrorMsg(categories)
     })
   )
 });
@@ -1399,6 +1404,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) {
@@ -1640,7 +1650,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.4.4";
+var version = "0.5.0";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options2) {

package/package.json

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