@code-pushup/cli 0.8.13 → 0.8.15

package/index.js

@@ -7,8 +7,7 @@ import { hideBin } from "yargs/helpers";
 import chalk5 from "chalk";
 
 // packages/core/src/lib/implementation/persist.ts
-import { existsSync, mkdirSync } from "node:fs";
-import { stat as stat2, writeFile } from "node:fs/promises";
+import { mkdir as mkdir2, stat as stat2, writeFile } from "node:fs/promises";
 import { join as join2 } from "node:path";
 
 // packages/utils/src/lib/execute-process.ts
@@ -656,6 +655,14 @@ async function fileExists(path) {
     return false;
   }
 }
+async function directoryExists(path) {
+  try {
+    const stats = await stat(path);
+    return stats.isDirectory();
+  } catch {
+    return false;
+  }
+}
 async function ensureDirectoryExists(baseDir) {
   try {
     await mkdir(baseDir, { recursive: true });
@@ -1556,47 +1563,55 @@ async function persistReport(report, options2) {
   const { outputDir, filename, format } = options2;
   const sortedScoredReport = sortReport(scoreReport(report));
   console.info(generateStdoutSummary(sortedScoredReport));
-  const results = [];
-  if (format.includes("json")) {
-    results.push({
-      format: "json",
-      content: JSON.stringify(report, null, 2)
-    });
-  }
-  if (format.includes("md")) {
-    const commitData = await getLatestCommit();
-    validateCommitData(commitData);
-    results.push({
-      format: "md",
-      content: generateMdReport(sortedScoredReport, commitData)
-    });
-  }
-  if (!existsSync(outputDir)) {
+  const results = await Promise.all(
+    format.map(async (reportType) => {
+      switch (reportType) {
+        case "json":
+          return {
+            format: "json",
+            content: JSON.stringify(report, null, 2)
+          };
+        case "md":
+          const commitData = await getLatestCommit();
+          validateCommitData(commitData);
+          return {
+            format: "md",
+            content: generateMdReport(sortedScoredReport, commitData)
+          };
+      }
+    })
+  );
+  if (!await directoryExists(outputDir)) {
     try {
-      mkdirSync(outputDir, { recursive: true });
-    } catch (e) {
-      console.warn(e);
+      await mkdir2(outputDir, { recursive: true });
+    } catch (error) {
+      console.warn(error);
       throw new PersistDirError(outputDir);
     }
   }
   return Promise.allSettled(
-    results.map(({ format: format2, content }) => {
-      const reportPath = join2(outputDir, `${filename}.${format2}`);
-      return writeFile(reportPath, content).then(() => stat2(reportPath)).then((stats) => [reportPath, stats.size]).catch((e) => {
-        console.warn(e);
-        throw new PersistError(reportPath);
-      });
-    })
+    results.map(
+      (result) => persistResult(
+        join2(outputDir, `${filename}.${result.format}`),
+        result.content
+      )
+    )
   );
 }
-function logPersistedResults(persistResults) {
-  logMultipleFileResults(persistResults, "Generated reports");
-}
 function validateCommitData(commitData) {
   if (!commitData) {
     console.warn("no commit data available");
   }
 }
+async function persistResult(reportPath, content) {
+  return writeFile(reportPath, content).then(() => stat2(reportPath)).then((stats) => [reportPath, stats.size]).catch((error) => {
+    console.warn(error);
+    throw new PersistError(reportPath);
+  });
+}
+function logPersistedResults(persistResults) {
+  logMultipleFileResults(persistResults, "Generated reports");
+}
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk4 from "chalk";
@@ -1610,12 +1625,8 @@ async function executeRunnerConfig(cfg, onProgress) {
     args,
     observer: { onStdout: onProgress }
   });
-  let audits = await readJsonFile(
-    join3(process.cwd(), outputFile)
-  );
-  if (outputTransform) {
-    audits = await outputTransform(audits);
-  }
+  const outputs = await readJsonFile(join3(process.cwd(), outputFile));
+  const audits = outputTransform ? await outputTransform(outputs) : outputs;
   return {
     duration,
     date,
@@ -1670,30 +1681,31 @@ async function executePlugin(pluginConfig, onProgress) {
   };
 }
 async function executePlugins(plugins, options2) {
-  const { progress = false } = options2 || {};
-  const progressName = "Run Plugins";
-  const progressBar = progress ? getProgressBar(progressName) : null;
+  const { progress = false } = options2 ?? {};
+  const progressBar = progress ? getProgressBar("Run plugins") : null;
   const pluginsResult = await plugins.reduce(async (acc, pluginCfg) => {
-    const outputs = await acc;
-    progressBar?.updateTitle(`Executing  ${chalk4.bold(pluginCfg.title)}`);
+    progressBar?.updateTitle(`Executing ${chalk4.bold(pluginCfg.title)}`);
     try {
       const pluginReport = await executePlugin(pluginCfg);
       progressBar?.incrementInSteps(plugins.length);
-      return outputs.concat(Promise.resolve(pluginReport));
-    } catch (e) {
+      return [...await acc, Promise.resolve(pluginReport)];
+    } catch (error) {
       progressBar?.incrementInSteps(plugins.length);
-      return outputs.concat(
-        Promise.reject(e instanceof Error ? e.message : String(e))
-      );
+      return [
+        ...await acc,
+        Promise.reject(error instanceof Error ? error.message : String(error))
+      ];
     }
   }, Promise.resolve([]));
   progressBar?.endProgress("Done running plugins");
-  const errorsCallback = ({ reason }) => console.error(reason);
+  const errorsCallback = ({ reason }) => {
+    console.error(reason);
+  };
   const results = await Promise.allSettled(pluginsResult);
   logMultipleResults(results, "Plugins", void 0, errorsCallback);
   const { fulfilled, rejected } = groupByStatus(results);
-  if (rejected.length) {
-    const errorMessages = rejected.map(({ reason }) => reason).join(", ");
+  if (rejected.length > 0) {
+    const errorMessages = rejected.map(({ reason }) => String(reason)).join(", ");
     throw new Error(
       `Plugins failed: ${rejected.length} errors: ${errorMessages}`
     );
@@ -1713,14 +1725,11 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.8.13";
+var version = "0.8.15";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options2) {
   const { plugins, categories } = options2;
-  if (!plugins?.length) {
-    throw new Error("No plugins registered");
-  }
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
   const pluginOutputs = await executePlugins(plugins, options2);
@@ -1743,62 +1752,74 @@ import {
   IssueSourceType,
   IssueSeverity as PortalIssueSeverity
 } from "@code-pushup/portal-client";
-function jsonToGql(report) {
+function jsonReportToGql(report) {
   return {
     packageName: report.packageName,
     packageVersion: report.version,
     commandStartDate: report.date,
     commandDuration: report.duration,
-    plugins: report.plugins.map((plugin) => ({
-      audits: plugin.audits.map((audit) => ({
-        description: audit.description,
-        details: {
-          issues: audit.details?.issues.map((issue) => ({
-            message: issue.message,
-            severity: transformSeverity(issue.severity),
-            sourceEndColumn: issue.source?.position?.endColumn,
-            sourceEndLine: issue.source?.position?.endLine,
-            sourceFilePath: issue.source?.file,
-            sourceStartColumn: issue.source?.position?.startColumn,
-            sourceStartLine: issue.source?.position?.startLine,
-            sourceType: IssueSourceType.SourceCode
-          })) || []
-        },
-        docsUrl: audit.docsUrl,
-        formattedValue: audit.displayValue,
-        score: audit.score,
-        slug: audit.slug,
-        title: audit.title,
-        value: audit.value
-      })),
-      description: plugin.description,
-      docsUrl: plugin.docsUrl,
-      groups: plugin.groups?.map((group) => ({
-        slug: group.slug,
-        title: group.title,
-        description: group.description,
-        refs: group.refs.map((ref) => ({ slug: ref.slug, weight: ref.weight }))
-      })),
-      icon: plugin.icon,
-      slug: plugin.slug,
-      title: plugin.title,
-      packageName: plugin.packageName,
-      packageVersion: plugin.version,
-      runnerDuration: plugin.duration,
-      runnerStartDate: plugin.date
+    plugins: pluginReportsToGql(report.plugins),
+    categories: categoryConfigsToGql(toArray(report.categories))
+  };
+}
+function pluginReportsToGql(plugins) {
+  return plugins.map((plugin) => ({
+    audits: auditReportsToGql(plugin.audits),
+    description: plugin.description,
+    docsUrl: plugin.docsUrl,
+    groups: plugin.groups?.map((group) => ({
+      slug: group.slug,
+      title: group.title,
+      description: group.description,
+      refs: group.refs.map((ref) => ({ slug: ref.slug, weight: ref.weight }))
     })),
-    categories: report.categories.map((category) => ({
-      slug: category.slug,
-      title: category.title,
-      description: category.description,
-      refs: category.refs.map((ref) => ({
-        plugin: ref.plugin,
-        type: ref.type === "audit" ? CategoryConfigRefType.Audit : CategoryConfigRefType.Group,
-        weight: ref.weight,
-        slug: ref.slug
-      }))
+    icon: plugin.icon,
+    slug: plugin.slug,
+    title: plugin.title,
+    packageName: plugin.packageName,
+    packageVersion: plugin.version,
+    runnerDuration: plugin.duration,
+    runnerStartDate: plugin.date
+  }));
+}
+function auditReportsToGql(audits) {
+  return audits.map((audit) => ({
+    description: audit.description,
+    details: {
+      issues: issuesToGql(audit.details?.issues)
+    },
+    docsUrl: audit.docsUrl,
+    formattedValue: audit.displayValue,
+    score: audit.score,
+    slug: audit.slug,
+    title: audit.title,
+    value: audit.value
+  }));
+}
+function issuesToGql(issues) {
+  return issues?.map((issue) => ({
+    message: issue.message,
+    severity: transformSeverity(issue.severity),
+    sourceEndColumn: issue.source?.position?.endColumn,
+    sourceEndLine: issue.source?.position?.endLine,
+    sourceFilePath: issue.source?.file,
+    sourceStartColumn: issue.source?.position?.startColumn,
+    sourceStartLine: issue.source?.position?.startLine,
+    sourceType: IssueSourceType.SourceCode
+  })) ?? [];
+}
+function categoryConfigsToGql(categories) {
+  return categories.map((category) => ({
+    slug: category.slug,
+    title: category.title,
+    description: category.description,
+    refs: category.refs.map((ref) => ({
+      plugin: ref.plugin,
+      type: ref.type === "audit" ? CategoryConfigRefType.Audit : CategoryConfigRefType.Group,
+      weight: ref.weight,
+      slug: ref.slug
     }))
-  };
+  }));
 }
 function transformSeverity(severity) {
   switch (severity) {
@@ -1821,8 +1842,8 @@ var normalizePersistConfig = (cfg) => ({
 
 // packages/core/src/lib/upload.ts
 async function upload(options2, uploadFn = uploadToPortal) {
-  const persist = normalizePersistConfig(options2?.persist);
-  if (!options2?.upload) {
+  const persist = normalizePersistConfig(options2.persist);
+  if (!options2.upload) {
     throw new Error("upload config must be set");
   }
   const { apiKey, server, organization, project } = options2.upload;
@@ -1838,7 +1859,7 @@ async function upload(options2, uploadFn = uploadToPortal) {
     organization,
     project,
     commit: commitData.hash,
-    ...jsonToGql(report)
+    ...jsonReportToGql(report)
   };
   return uploadFn({ apiKey, server, data });
 }
@@ -1847,9 +1868,11 @@ async function upload(options2, uploadFn = uploadToPortal) {
 async function collectAndPersistReports(options2) {
   const { exec } = verboseUtils(options2.verbose);
   const report = await collect(options2);
-  const persist = normalizePersistConfig(options2?.persist);
+  const persist = normalizePersistConfig(options2.persist);
   const persistResults = await persistReport(report, persist);
-  exec(() => logPersistedResults(persistResults));
+  exec(() => {
+    logPersistedResults(persistResults);
+  });
   report.plugins.forEach((plugin) => {
     pluginReportSchema.parse(plugin);
   });
@@ -1868,6 +1891,10 @@ async function readCodePushupConfig(filepath) {
   return coreConfigSchema.parse(await importEsmModule({ filepath }));
 }
 
+// packages/cli/src/lib/constants.ts
+var CLI_NAME = "Code PushUp CLI";
+var CLI_SCRIPT_NAME = "code-pushup";
+
 // packages/cli/src/lib/implementation/only-plugins-options.ts
 var onlyPluginsOption = {
   describe: "List of plugins to run. If not set all plugins are run.",
@@ -1902,10 +1929,10 @@ function yargsAutorunCommandObject() {
         }
       };
       await collectAndPersistReports(optionsWithFormat);
-      if (!options2.upload) {
-        console.warn("Upload skipped because configuration is not set.");
-      } else {
+      if (options2.upload) {
         await upload(options2);
+      } else {
+        console.warn("Upload skipped because configuration is not set.");
       }
     }
   };
@@ -1930,19 +1957,13 @@ function yargsCollectCommandObject() {
 
 // packages/cli/src/lib/implementation/filter-kebab-case-keys.ts
 function filterKebabCaseKeys(obj) {
-  const newObj = {};
-  Object.keys(obj).forEach((key) => {
-    if (key.includes("-")) {
-      return;
-    }
-    if (typeof obj[key] === "string" || typeof obj[key] === "object" && Array.isArray(obj[key])) {
-      newObj[key] = obj[key];
-    }
-    if (typeof obj[key] === "object" && !Array.isArray(obj[key]) && obj[key] != null) {
-      newObj[key] = filterKebabCaseKeys(obj[key]);
-    }
-  });
-  return newObj;
+  return Object.entries(obj).filter(([key]) => !key.includes("-")).reduce(
+    (acc, [key, value]) => typeof value === "string" || typeof value === "object" && Array.isArray(obj[key]) ? { ...acc, [key]: value } : typeof value === "object" && !Array.isArray(value) && value != null ? {
+      ...acc,
+      [key]: filterKebabCaseKeys(value)
+    } : { ...acc, [key]: value },
+    {}
+  );
 }
 
 // packages/cli/src/lib/print-config/print-config-command.ts
@@ -2041,10 +2062,10 @@ function logErrorBeforeThrow(fn) {
   return async (...args) => {
     try {
       return await fn(...args);
-    } catch (err) {
-      console.error(err);
+    } catch (error) {
+      console.error(error);
       await new Promise((resolve) => process.stdout.write("", resolve));
-      throw err;
+      throw error;
     }
   };
 }
@@ -2072,10 +2093,10 @@ async function configMiddleware(processArgs) {
     // 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: {
-      outputDir: cliOptions?.persist?.outputDir || importedRc?.persist?.outputDir || PERSIST_OUTPUT_DIR,
-      filename: cliOptions?.persist?.filename || importedRc?.persist?.filename || PERSIST_FILENAME,
+      outputDir: cliOptions.persist?.outputDir || importedRc.persist?.outputDir || PERSIST_OUTPUT_DIR,
+      filename: cliOptions.persist?.filename || importedRc.persist?.filename || PERSIST_FILENAME,
       format: coerceArray(
-        cliOptions?.persist?.format || importedRc?.persist?.format || PERSIST_FORMAT
+        cliOptions.persist?.format ?? importedRc.persist?.format ?? PERSIST_FORMAT
       )
     },
     plugins: filterPluginsByOnlyPluginsOption(importedRc.plugins, cliOptions),
@@ -2173,19 +2194,19 @@ import chalk9 from "chalk";
 import yargs from "yargs";
 function yargsCli(argv, cfg) {
   const { usageMessage, scriptName, noExitProcess } = cfg;
-  let { commands: commands2, options: options2, middlewares: middlewares2 } = cfg;
-  commands2 = Array.isArray(commands2) ? commands2 : [];
-  middlewares2 = Array.isArray(middlewares2) ? middlewares2 : [];
-  options2 = options2 || {};
+  const commands2 = cfg.commands ?? [];
+  const middlewares2 = cfg.middlewares ?? [];
+  const options2 = cfg.options ?? {};
   const cli2 = yargs(argv);
-  cli2.help().version(false).alias("h", "help").parserConfiguration({
+  cli2.help().version(false).alias("h", "help").check((args) => {
+    const persist = args["persist"];
+    return persist == null || validatePersistFormat(persist);
+  }).parserConfiguration({
     "strip-dashed": true
-  }).array("persist.format").coerce("config", (config) => {
-    if (Array.isArray(config)) {
-      return config[config.length - 1];
-    }
-    return config;
-  }).options(options2);
+  }).coerce(
+    "config",
+    (config) => Array.isArray(config) ? config.at(-1) : config
+  ).options(options2);
   if (usageMessage) {
     cli2.usage(chalk9.bold(usageMessage));
   }
@@ -2201,9 +2222,7 @@ function yargsCli(argv, cfg) {
   commands2.forEach((commandObj) => {
     cli2.command({
       ...commandObj,
-      ...commandObj.handler && {
-        handler: logErrorBeforeThrow(commandObj.handler)
-      },
+      handler: logErrorBeforeThrow(commandObj.handler),
       ...typeof commandObj.builder === "function" && {
         builder: logErrorBeforeThrow(commandObj.builder)
       }
@@ -2214,10 +2233,22 @@ function yargsCli(argv, cfg) {
   }
   return cli2;
 }
+function validatePersistFormat(persist) {
+  try {
+    if (persist?.format != null) {
+      persist.format.forEach((format) => formatSchema.parse(format));
+    }
+    return true;
+  } catch {
+    throw new Error(
+      `Invalid persist.format option. Valid options are: ${Object.values(
+        formatSchema.Values
+      ).join(", ")}`
+    );
+  }
+}
 
 // packages/cli/src/lib/cli.ts
-var CLI_NAME = "Code PushUp CLI";
-var CLI_SCRIPT_NAME = "code-pushup";
 var cli = (args) => yargsCli(args, {
   usageMessage: CLI_NAME,
   scriptName: CLI_SCRIPT_NAME,
@@ -2227,4 +2258,4 @@ var cli = (args) => yargsCli(args, {
 });
 
 // packages/cli/src/index.ts
-cli(hideBin(process.argv)).argv;
+await cli(hideBin(process.argv)).argv;

package/package.json

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

package/src/lib/cli.d.ts

@@ -1,3 +1 @@
-export declare const CLI_NAME = "Code PushUp CLI";
-export declare const CLI_SCRIPT_NAME = "code-pushup";
 export declare const cli: (args: string[]) => import("yargs").Argv<unknown>;

package/src/lib/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const CLI_NAME = "Code PushUp CLI";
+export declare const CLI_SCRIPT_NAME = "code-pushup";