@code-pushup/core 0.54.0 → 0.56.0

package/index.js

@@ -29,7 +29,7 @@ function exists(value) {
   return value != null;
 }
 function getMissingRefsForCategories(categories, plugins) {
-  if (categories.length === 0) {
+  if (!categories || categories.length === 0) {
     return false;
   }
   const auditRefsFromCategory = categories.flatMap(
@@ -528,12 +528,9 @@ var unrefinedCoreConfigSchema = z14.object({
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
   return schema.refine(
-    (coreCfg) => !getMissingRefsForCategories(coreCfg.categories ?? [], coreCfg.plugins),
-    (coreCfg) => ({
-      message: missingRefsForCategoriesErrorMsg(
-        coreCfg.categories ?? [],
-        coreCfg.plugins
-      )
+    ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+    ({ categories, plugins }) => ({
+      message: missingRefsForCategoriesErrorMsg(categories, plugins)
     })
   );
 }
@@ -589,19 +586,16 @@ var reportSchema = packageVersionSchema({
 ).merge(
   z15.object(
     {
-      categories: z15.array(categoryConfigSchema),
       plugins: z15.array(pluginReportSchema).min(1),
+      categories: z15.array(categoryConfigSchema).optional(),
       commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
   )
 ).refine(
-  (report) => !getMissingRefsForCategories(report.categories, report.plugins),
-  (report) => ({
-    message: missingRefsForCategoriesErrorMsg(
-      report.categories,
-      report.plugins
-    )
+  ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+  ({ categories, plugins }) => ({
+    message: missingRefsForCategoriesErrorMsg(categories, plugins)
   })
 );
 
@@ -1667,7 +1661,7 @@ function getSortableGroupByRef({ plugin, slug, weight }, plugins) {
 }
 function sortReport(report) {
   const { categories, plugins } = report;
-  const sortedCategories = categories.map((category) => {
+  const sortedCategories = categories?.map((category) => {
     const { audits, groups } = category.refs.reduce(
       (acc, ref) => ({
         ...acc,
@@ -1807,14 +1801,15 @@ function auditDetailsAuditValue({
     String(displayValue ?? value)
   )} (score: ${formatReportScore(score)})`;
 }
+function hasCategories(report) {
+  return !!report.categories && report.categories.length > 0;
+}
 function generateMdReport(report, options) {
-  return new MarkdownDocument3().heading(HIERARCHY.level_1, REPORT_HEADLINE_TEXT).$if(
-    report.categories.length > 0,
-    (doc) => doc.$concat(
-      categoriesOverviewSection(report),
-      categoriesDetailsSection(report)
-    )
-  ).$concat(auditsSection(report, options), aboutSection(report)).rule().paragraph(md4`${FOOTER_PREFIX} ${md4.link(README_LINK, "Code PushUp")}`).toString();
+  return new MarkdownDocument3().heading(HIERARCHY.level_1, REPORT_HEADLINE_TEXT).$concat(
+    ...hasCategories(report) ? [categoriesOverviewSection(report), categoriesDetailsSection(report)] : [],
+    auditsSection(report, options),
+    aboutSection(report)
+  ).rule().paragraph(md4`${FOOTER_PREFIX} ${md4.link(README_LINK, "Code PushUp")}`).toString();
 }
 function auditDetailsIssues(issues = [], options) {
   if (issues.length === 0) {
@@ -1916,7 +1911,7 @@ function reportMetaTable({
         md4.code(version2),
         formatDuration(duration),
         plugins.length.toString(),
-        categories.length.toString(),
+        (categories?.length ?? 0).toString(),
         plugins.reduce((acc, { audits }) => acc + audits.length, 0).toString()
       ]
     ]
@@ -2248,18 +2243,20 @@ function log(msg = "") {
   ui().logger.log(msg);
 }
 function logStdoutSummary(report, verbose = false) {
-  const printCategories = report.categories.length > 0;
-  log(reportToHeaderSection(report));
+  const { plugins, categories, packageName, version: version2 } = report;
+  log(reportToHeaderSection({ packageName, version: version2 }));
   log();
-  logPlugins(report.plugins, verbose);
-  if (printCategories) {
-    logCategories(report);
+  logPlugins(plugins, verbose);
+  if (categories && categories.length > 0) {
+    logCategories({ plugins, categories });
   }
   log(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
   log();
 }
-function reportToHeaderSection(report) {
-  const { packageName, version: version2 } = report;
+function reportToHeaderSection({
+  packageName,
+  version: version2
+}) {
   return `${bold4(REPORT_HEADLINE_TEXT)} - ${packageName}@${version2}`;
 }
 function logPlugins(plugins, verbose) {
@@ -2305,7 +2302,10 @@ function logRow(score, title, value) {
     ] : []
   ]);
 }
-function logCategories({ categories, plugins }) {
+function logCategories({
+  plugins,
+  categories
+}) {
   const hAlign = (idx) => idx === 0 ? "left" : "right";
   const rows = categories.map(({ title, score, refs, isBinary }) => [
     title,
@@ -2387,7 +2387,7 @@ function scoreReport(report) {
     }
     return item.score;
   }
-  const scoredCategories = report.categories.map((category) => ({
+  const scoredCategories = report.categories?.map((category) => ({
     ...category,
     score: calculateScore(category.refs, catScoreFn)
   }));
@@ -2450,7 +2450,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.54.0";
+var version = "0.56.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import { bold as bold5 } from "ansis";
@@ -2714,8 +2714,8 @@ import { join as join5 } from "node:path";
 // packages/core/src/lib/implementation/compare-scorables.ts
 function compareCategories(reports) {
   const { pairs, added, removed } = matchArrayItemsByKey({
-    before: reports.before.categories,
-    after: reports.after.categories,
+    before: reports.before.categories ?? [],
+    after: reports.after.categories ?? [],
     key: "slug"
   });
   const { changed, unchanged } = comparePairs(
@@ -2956,7 +2956,7 @@ function reportToGQL(report) {
     commandStartDate: report.date,
     commandDuration: report.duration,
     plugins: report.plugins.map(pluginToGQL),
-    categories: report.categories.map(categoryToGQL)
+    categories: (report.categories ?? []).map(categoryToGQL)
   };
 }
 function pluginToGQL(plugin) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.54.0",
+  "version": "0.56.0",
   "license": "MIT",
   "description": "Core business logic for the used by the Code PushUp CLI",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/core#readme",
@@ -41,8 +41,8 @@
   "main": "./index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@code-pushup/models": "0.54.0",
-    "@code-pushup/utils": "0.54.0",
+    "@code-pushup/models": "0.56.0",
+    "@code-pushup/utils": "0.56.0",
     "ansis": "^3.3.0"
   },
   "peerDependencies": {

package/src/lib/collect-and-persist.d.ts

@@ -1,6 +1,6 @@
 import { type CoreConfig, type PersistConfig } from '@code-pushup/models';
 import type { GlobalOptions } from './types';
-export type CollectAndPersistReportsOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & {
+export type CollectAndPersistReportsOptions = Pick<CoreConfig, 'plugins' | 'categories'> & {
     persist: Required<PersistConfig>;
 } & Partial<GlobalOptions>;
 export declare function collectAndPersistReports(options: CollectAndPersistReportsOptions): Promise<void>;

package/src/lib/history.d.ts

@@ -5,7 +5,7 @@ export type HistoryOnlyOptions = {
     skipUploads?: boolean;
     forceCleanStatus?: boolean;
 };
-export type HistoryOptions = Required<Pick<CoreConfig, 'plugins'> & Required<Pick<CoreConfig, 'categories'>>> & {
+export type HistoryOptions = Pick<CoreConfig, 'plugins' | 'categories'> & {
     persist: Required<PersistConfig>;
     upload?: Required<UploadConfig>;
 } & HistoryOnlyOptions & Partial<GlobalOptions>;

package/src/lib/implementation/collect.d.ts

@@ -1,6 +1,6 @@
 import type { CoreConfig, Report } from '@code-pushup/models';
 import type { GlobalOptions } from '../types';
-export type CollectOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & Partial<GlobalOptions>;
+export type CollectOptions = Pick<CoreConfig, 'plugins' | 'categories'> & Partial<GlobalOptions>;
 /**
  * Run audits, collect plugin output and aggregate it into a JSON object
  * @param options