@code-pushup/cli 0.5.2 → 0.5.4

package/index.js

@@ -230,8 +230,7 @@ var persistConfigSchema = z3.object({
   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.
+  format: z3.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
@@ -1385,6 +1384,9 @@ function withColor({ score, text }) {
 }
 
 // packages/utils/src/lib/transformation.ts
+function toArray(val) {
+  return Array.isArray(val) ? val : [val];
+}
 function deepClone(obj) {
   if (obj == null || typeof obj !== "object") {
     return obj;
@@ -1499,18 +1501,18 @@ var PersistError = class extends Error {
 };
 async function persistReport(report, options2) {
   const { outputDir, filename, format } = options2;
-  let scoredReport = scoreReport(report);
+  const scoredReport = scoreReport(report);
   console.info(reportToStdout(scoredReport));
-  const results = [
-    // JSON is always persisted
-    { format: "json", content: JSON.stringify(report, null, 2) }
-  ];
+  const results = [];
+  if (format.includes("json")) {
+    results.push({
+      format: "json",
+      content: JSON.stringify(report, null, 2)
+    });
+  }
   if (format.includes("md")) {
-    scoredReport = scoredReport || scoreReport(report);
     const commitData = await getLatestCommit();
-    if (!commitData) {
-      console.warn("no commit data available");
-    }
+    validateCommitData(commitData);
     results.push({
       format: "md",
       content: reportToMd(scoredReport, commitData)
@@ -1537,6 +1539,11 @@ async function persistReport(report, options2) {
 function logPersistedResults(persistResults) {
   logMultipleFileResults(persistResults, "Generated reports");
 }
+function validateCommitData(commitData) {
+  if (!commitData) {
+    console.warn("no commit data available");
+  }
+}
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk4 from "chalk";
@@ -1653,7 +1660,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.5.2";
+var version = "0.5.4";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options2) {
@@ -1837,7 +1844,16 @@ function yargsAutorunCommandObject() {
       console.info(chalk5.bold(CLI_NAME));
       console.info(chalk5.gray(`Run ${command}...`));
       const options2 = args;
-      await collectAndPersistReports(options2);
+      const optionsWithFormat = {
+        ...options2,
+        persist: {
+          ...options2.persist,
+          format: [
+            .../* @__PURE__ */ new Set([...options2.persist.format, "json"])
+          ]
+        }
+      };
+      await collectAndPersistReports(optionsWithFormat);
       if (!options2.upload) {
         console.warn("Upload skipped because configuration is not set.");
       } else {
@@ -1939,14 +1955,17 @@ function filterPluginsByOnlyPluginsOption(plugins, { onlyPlugins }) {
   }
   return plugins.filter((plugin) => onlyPlugins.includes(plugin.slug));
 }
-function filterCategoryByOnlyPluginsOption(categories, { onlyPlugins }) {
+function filterCategoryByOnlyPluginsOption(categories, {
+  onlyPlugins,
+  verbose = false
+}) {
   if (!onlyPlugins?.length) {
     return categories;
   }
   return categories.filter(
     (category) => category.refs.every((ref) => {
       const isNotSkipped = onlyPlugins.includes(ref.slug);
-      if (!isNotSkipped) {
+      if (!isNotSkipped && verbose) {
         console.info(
           `${chalk8.yellow("\u26A0")} Category "${category.title}" is ignored because it references audits from skipped plugin "${ref.slug}"`
         );
@@ -1955,9 +1974,12 @@ function filterCategoryByOnlyPluginsOption(categories, { onlyPlugins }) {
     })
   );
 }
-function validateOnlyPluginsOption(plugins, { onlyPlugins }) {
+function validateOnlyPluginsOption(plugins, {
+  onlyPlugins,
+  verbose = false
+}) {
   const missingPlugins = onlyPlugins?.length ? onlyPlugins.filter((plugin) => !plugins.some(({ slug }) => slug === plugin)) : [];
-  if (missingPlugins.length > 0) {
+  if (missingPlugins.length > 0 && verbose) {
     console.warn(
       `${chalk8.yellow(
         "\u26A0"
@@ -1968,6 +1990,24 @@ function validateOnlyPluginsOption(plugins, { onlyPlugins }) {
   }
 }
 
+// packages/cli/src/lib/implementation/utils.ts
+function logErrorBeforeThrow(fn) {
+  return async (...args) => {
+    try {
+      return await fn(...args);
+    } catch (err) {
+      console.error(err);
+      await new Promise((resolve) => process.stdout.write("", resolve));
+      throw err;
+    }
+  };
+}
+function coerceArray(param = []) {
+  return [
+    ...new Set(toArray(param).flatMap((f) => f.split(",")) || [])
+  ];
+}
+
 // packages/cli/src/lib/implementation/config-middleware.ts
 async function configMiddleware(processArgs) {
   const args = processArgs;
@@ -1988,7 +2028,9 @@ async function configMiddleware(processArgs) {
     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
+      format: coerceArray(
+        cliOptions?.persist?.format || importedRc?.persist?.format || PERSIST_FORMAT
+      )
     },
     plugins: filterPluginsByOnlyPluginsOption(importedRc.plugins, cliOptions),
     categories: filterCategoryByOnlyPluginsOption(
@@ -2083,21 +2125,6 @@ var options = {
 // packages/cli/src/lib/yargs-cli.ts
 import chalk9 from "chalk";
 import yargs from "yargs";
-
-// packages/cli/src/lib/implementation/utils.ts
-function logErrorBeforeThrow(fn) {
-  return async (...args) => {
-    try {
-      return await fn(...args);
-    } catch (err) {
-      console.error(err);
-      await new Promise((resolve) => process.stdout.write("", resolve));
-      throw err;
-    }
-  };
-}
-
-// packages/cli/src/lib/yargs-cli.ts
 function yargsCli(argv, cfg) {
   const { usageMessage, scriptName, noExitProcess } = cfg;
   let { commands: commands2, options: options2, middlewares: middlewares2 } = cfg;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "bin": {
     "code-pushup": "index.js"
   },
@@ -8,7 +8,8 @@
     "@code-pushup/models": "*",
     "@code-pushup/core": "*",
     "yargs": "^17.7.2",
-    "chalk": "^5.3.0"
+    "chalk": "^5.3.0",
+    "@code-pushup/utils": "*"
   },
   "type": "module",
   "main": "./index.js",

package/src/lib/implementation/only-plugins-options.d.ts

@@ -1,2 +1,3 @@
 import { Options } from 'yargs';
 export declare const onlyPluginsOption: Options;
+export declare function yargsOnlyPluginsOptionsDefinition(): Record<'onlyPlugins', Options>;

package/src/lib/implementation/only-plugins-utils.d.ts

@@ -2,9 +2,11 @@ import { CoreConfig } from '@code-pushup/models';
 export declare function filterPluginsByOnlyPluginsOption(plugins: CoreConfig['plugins'], { onlyPlugins }: {
     onlyPlugins?: string[];
 }): CoreConfig['plugins'];
-export declare function filterCategoryByOnlyPluginsOption(categories: CoreConfig['categories'], { onlyPlugins }: {
+export declare function filterCategoryByOnlyPluginsOption(categories: CoreConfig['categories'], { onlyPlugins, verbose, }: {
     onlyPlugins?: string[];
+    verbose?: boolean;
 }): CoreConfig['categories'];
-export declare function validateOnlyPluginsOption(plugins: CoreConfig['plugins'], { onlyPlugins }: {
+export declare function validateOnlyPluginsOption(plugins: CoreConfig['plugins'], { onlyPlugins, verbose, }: {
     onlyPlugins?: string[];
+    verbose?: boolean;
 }): void;

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

@@ -1 +1,2 @@
 export declare function logErrorBeforeThrow<T extends (...args: any[]) => any>(fn: T): T;
+export declare function coerceArray<T extends string>(param?: T | T[]): T[];

package/src/lib/options.d.ts

@@ -7,6 +7,6 @@ export declare const options: {
     "upload.apiKey": import("yargs").Options;
     "upload.server": import("yargs").Options;
     progress: import("yargs").Options;
-    config: import("yargs").Options;
     verbose: import("yargs").Options;
+    config: import("yargs").Options;
 };