@code-pushup/cli 0.53.1 → 0.55.0

package/index.js

@@ -37,7 +37,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(
@@ -114,7 +114,6 @@ var fileNameSchema = z.string().trim().regex(filenameRegex, {
   message: `The filename has to be valid`
 }).min(1, { message: "file name is invalid" });
 var positiveIntSchema = z.number().int().positive();
-var nonnegativeIntSchema = z.number().int().nonnegative();
 var nonnegativeNumberSchema = z.number().nonnegative();
 function packageVersionSchema(options2) {
   const { versionDescription = "NPM version of the package", required } = options2 ?? {};
@@ -537,12 +536,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)
     })
   );
 }
@@ -603,19 +599,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)
   })
 );
 
@@ -667,7 +660,7 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   z16.object({
     values: makeComparisonSchema(auditValueSchema).merge(
       z16.object({
-        diff: z16.number().int().describe("Value change (`values.after - values.before`)")
+        diff: z16.number().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -1013,6 +1006,7 @@ function executeProcess(cfg) {
   return new Promise((resolve, reject) => {
     const spawnedProcess = spawn(command2, args ?? [], {
       shell: true,
+      windowsHide: true,
       ...options2
     });
     let stdout = "";
@@ -1781,7 +1775,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: groups2 } = category.refs.reduce(
       (acc, ref) => ({
         ...acc,
@@ -1921,14 +1915,15 @@ function auditDetailsAuditValue({
     String(displayValue ?? value)
   )} (score: ${formatReportScore(score)})`;
 }
+function hasCategories(report) {
+  return !!report.categories && report.categories.length > 0;
+}
 function generateMdReport(report, options2) {
-  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, options2), 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, options2),
+    aboutSection(report)
+  ).rule().paragraph(md4`${FOOTER_PREFIX} ${md4.link(README_LINK, "Code PushUp")}`).toString();
 }
 function auditDetailsIssues(issues = [], options2) {
   if (issues.length === 0) {
@@ -2030,7 +2025,7 @@ function reportMetaTable({
         md4.code(version3),
         formatDuration(duration),
         plugins.length.toString(),
-        categories.length.toString(),
+        (categories?.length ?? 0).toString(),
         plugins.reduce((acc, { audits }) => acc + audits.length, 0).toString()
       ]
     ]
@@ -2362,24 +2357,26 @@ 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: version3 } = report;
+  log(reportToHeaderSection({ packageName, version: version3 }));
   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: version3 } = report;
+function reportToHeaderSection({
+  packageName,
+  version: version3
+}) {
   return `${bold4(REPORT_HEADLINE_TEXT)} - ${packageName}@${version3}`;
 }
 function logPlugins(plugins, verbose) {
   plugins.forEach((plugin) => {
     const { title, audits } = plugin;
-    const filteredAudits = verbose ? audits : audits.filter(({ score }) => score !== 1);
+    const filteredAudits = verbose || audits.length === 1 ? audits : audits.filter(({ score }) => score !== 1);
     const diff = audits.length - filteredAudits.length;
     logAudits(title, filteredAudits);
     if (diff > 0) {
@@ -2419,7 +2416,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,
@@ -2501,7 +2501,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)
   }));
@@ -2564,7 +2564,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.53.1";
+var version = "0.55.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import { bold as bold5 } from "ansis";
@@ -2828,8 +2828,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(
@@ -3070,7 +3070,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) {
@@ -3407,7 +3407,7 @@ function yargsAutorunCommandObject() {
       };
       await collectAndPersistReports(optionsWithFormat);
       collectSuccessfulLog();
-      if (options2.categories.length === 0) {
+      if (!options2.categories || options2.categories.length === 0) {
         renderConfigureCategoriesHint();
       }
       if (options2.upload) {
@@ -3436,7 +3436,7 @@ function yargsCollectCommandObject() {
       ui().logger.info(gray5(`Run ${command2}...`));
       await collectAndPersistReports(options2);
       collectSuccessfulLog();
-      if (options2.categories.length === 0) {
+      if (!options2.categories || options2.categories.length === 0) {
         renderConfigureCategoriesHint();
       }
       const { upload: upload2 = {} } = args;
@@ -3521,7 +3521,7 @@ import yargs from "yargs";
 // packages/cli/src/lib/implementation/validate-filter-options.utils.ts
 var OptionValidationError = class extends Error {
 };
-function validateFilterOption(option, { plugins, categories }, { itemsToFilter, verbose }) {
+function validateFilterOption(option, { plugins, categories = [] }, { itemsToFilter, verbose }) {
   const itemsToFilterSet = new Set(itemsToFilter);
   const validItems = isCategoryOption(option) ? categories : isPluginOption(option) ? plugins : [];
   const invalidItems = itemsToFilter.filter(
@@ -3549,8 +3549,8 @@ function validateFilterOption(option, { plugins, categories }, { itemsToFilter,
   }
 }
 function validateFinalState(filteredItems, originalItems) {
-  const { categories: filteredCategories, plugins: filteredPlugins } = filteredItems;
-  const { categories: originalCategories, plugins: originalPlugins } = originalItems;
+  const { categories: filteredCategories = [], plugins: filteredPlugins } = filteredItems;
+  const { categories: originalCategories = [], plugins: originalPlugins } = originalItems;
   if (filteredCategories.length === 0 && filteredPlugins.length === 0 && (originalPlugins.length > 0 || originalCategories.length > 0)) {
     const availablePlugins = originalPlugins.map((p) => p.slug).join(", ") || "none";
     const availableCategories = originalCategories.map((c) => c.slug).join(", ") || "none";
@@ -3889,7 +3889,6 @@ async function coreConfigMiddleware(processArgs) {
   const {
     persist: rcPersist,
     upload: rcUpload,
-    categories: rcCategories,
     ...remainingRcConfig
   } = importedRc;
   const upload2 = rcUpload == null && cliUpload == null ? void 0 : uploadConfigSchema.parse({
@@ -3906,7 +3905,6 @@ async function coreConfigMiddleware(processArgs) {
       )
     },
     ...upload2 != null && { upload: upload2 },
-    categories: rcCategories ?? [],
     ...remainingRcConfig,
     ...remainingCliOptions
   };
@@ -3917,7 +3915,7 @@ var normalizeFormats = (formats) => (formats ?? []).flatMap((format) => format.s
 function filterMiddleware(originalProcessArgs) {
   const {
     plugins,
-    categories = [],
+    categories,
     skipCategories = [],
     onlyCategories = [],
     skipPlugins = [],
@@ -3925,7 +3923,7 @@ function filterMiddleware(originalProcessArgs) {
     verbose = false
   } = originalProcessArgs;
   if (skipCategories.length === 0 && onlyCategories.length === 0 && skipPlugins.length === 0 && onlyPlugins.length === 0) {
-    return { ...originalProcessArgs, categories };
+    return originalProcessArgs;
   }
   handleConflictingOptions("categories", onlyCategories, skipCategories);
   handleConflictingOptions("plugins", onlyPlugins, skipPlugins);
@@ -3941,10 +3939,10 @@ function filterMiddleware(originalProcessArgs) {
     onlyPlugins,
     verbose
   );
-  const finalCategories = filterItemRefsBy(
+  const finalCategories = filteredCategories ? filterItemRefsBy(
     filteredCategories,
     (ref) => filteredPlugins.some((plugin) => plugin.slug === ref.plugin)
-  );
+  ) : filteredCategories;
   validateFinalState(
     { categories: finalCategories, plugins: filteredPlugins },
     { categories, plugins }
@@ -3962,7 +3960,7 @@ function applyFilters(items, skipItems, onlyItems, key) {
   });
 }
 function applyCategoryFilters({ categories, plugins }, skipCategories, onlyCategories, verbose) {
-  if (skipCategories.length === 0 && onlyCategories.length === 0) {
+  if (skipCategories.length === 0 && onlyCategories.length === 0 || !categories || categories.length === 0) {
     return categories;
   }
   validateFilterOption(
@@ -4001,10 +3999,13 @@ function filterPluginsFromCategories({
   categories,
   plugins
 }) {
+  if (!categories || categories.length === 0) {
+    return plugins;
+  }
   const validPluginSlugs = new Set(
     categories.flatMap((category) => category.refs.map((ref) => ref.plugin))
   );
-  return categories.length > 0 ? plugins.filter((plugin) => validPluginSlugs.has(plugin.slug)) : plugins;
+  return plugins.filter((plugin) => validPluginSlugs.has(plugin.slug));
 }
 
 // packages/cli/src/lib/middlewares.ts
@@ -4107,7 +4108,7 @@ import { blue, dim as dim2, green as green4 } from "ansis";
 import yargs2 from "yargs";
 
 // packages/cli/package.json
-var version2 = "0.53.1";
+var version2 = "0.55.0";
 
 // packages/cli/src/lib/implementation/formatting.ts
 import { bold as bold13, dim, green as green3 } from "ansis";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.53.1",
+  "version": "0.55.0",
   "license": "MIT",
   "description": "A CLI to run all kinds of code quality measurements to align your team with company goals",
   "homepage": "https://code-pushup.dev",
@@ -44,9 +44,9 @@
     "code-pushup": "index.js"
   },
   "dependencies": {
-    "@code-pushup/models": "0.53.1",
-    "@code-pushup/core": "0.53.1",
-    "@code-pushup/utils": "0.53.1",
+    "@code-pushup/models": "0.55.0",
+    "@code-pushup/core": "0.55.0",
+    "@code-pushup/utils": "0.55.0",
     "yargs": "^17.7.2",
     "ansis": "^3.3.0",
     "simple-git": "^3.20.0"

package/src/lib/implementation/filter.model.d.ts

@@ -1,9 +1,6 @@
 import type { GlobalOptions } from '@code-pushup/core';
-import type { CategoryConfig, CoreConfig, PluginConfig } from '@code-pushup/models';
+import type { CoreConfig } from '@code-pushup/models';
 export type FilterOptions = Partial<GlobalOptions> & Pick<CoreConfig, 'categories' | 'plugins'> & FilterCliOptions;
 export type FilterCliOptions = Partial<Record<FilterOptionType, string[]>>;
 export type FilterOptionType = 'skipCategories' | 'onlyCategories' | 'skipPlugins' | 'onlyPlugins';
-export type Filterables = {
-    categories: CategoryConfig[];
-    plugins: PluginConfig[];
-};
+export type Filterables = Pick<CoreConfig, 'plugins' | 'categories'>;