@code-pushup/cli 0.14.3 → 0.15.0

package/index.js

@@ -4,7 +4,7 @@
 import { hideBin } from "yargs/helpers";
 
 // packages/cli/src/lib/autorun/autorun-command.ts
-import chalk5 from "chalk";
+import chalk7 from "chalk";
 
 // packages/models/src/lib/audit.ts
 import { z as z2 } from "zod";
@@ -919,6 +919,13 @@ function compareIssues(a, b) {
   }
   return 0;
 }
+function portalCommitLink(config, commit) {
+  const { organization, project, baseUrl } = config;
+  return `${baseUrl}/portal/${organization}/${project}/commit/${commit}`;
+}
+function portalCommitDashboardLink(config, commit) {
+  return `${portalCommitLink(config, commit)}/dashboard`;
+}
 
 // packages/utils/src/lib/execute-process.ts
 var ProcessError = class extends Error {
@@ -975,6 +982,19 @@ async function getLatestCommit() {
   });
   return log.latest;
 }
+function validateCommitData(commitData, options2 = {}) {
+  const { throwError = false } = options2;
+  if (!commitData) {
+    const msg = "no commit data available";
+    if (throwError) {
+      throw new Error(msg);
+    } else {
+      console.warn(msg);
+      return false;
+    }
+  }
+  return true;
+}
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
@@ -1311,9 +1331,9 @@ function reportToDetailSection(report) {
   const { plugins } = report;
   return plugins.reduce((acc, plugin) => {
     const { title, audits } = plugin;
-    const ui = cliui({ width: TERMINAL_WIDTH });
+    const ui2 = cliui({ width: TERMINAL_WIDTH });
     audits.forEach((audit) => {
-      ui.div(
+      ui2.div(
         {
           text: withColor({ score: audit.score, text: "\u25CF" }),
           width: 2,
@@ -1331,7 +1351,7 @@ function reportToDetailSection(report) {
         }
       );
     });
-    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
+    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui2.toString()) + addLine();
   }, "");
 }
 function reportToOverviewSection2({
@@ -1536,12 +1556,18 @@ var verboseUtils = (verbose = false) => ({
   exec: getExecVerbose(verbose)
 });
 
+// packages/utils/src/lib/logging.ts
+import chalk4 from "chalk";
+function link2(text) {
+  return chalk4.underline(chalk4.blueBright(text));
+}
+
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.14.3";
+var version = "0.15.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
-import chalk4 from "chalk";
+import chalk5 from "chalk";
 
 // packages/core/src/lib/implementation/runner.ts
 import { join as join2 } from "node:path";
@@ -1611,7 +1637,7 @@ async function executePlugins(plugins, options2) {
   const { progress = false } = options2 ?? {};
   const progressBar = progress ? getProgressBar("Run plugins") : null;
   const pluginsResult = await plugins.reduce(async (acc, pluginCfg) => {
-    progressBar?.updateTitle(`Executing ${chalk4.bold(pluginCfg.title)}`);
+    progressBar?.updateTitle(`Executing ${chalk5.bold(pluginCfg.title)}`);
     try {
       const pluginReport = await executePlugin(pluginCfg);
       progressBar?.incrementInSteps(plugins.length);
@@ -1718,11 +1744,6 @@ async function persistReport(report, options2) {
     )
   );
 }
-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);
@@ -1909,6 +1930,60 @@ async function upload(options2, uploadFn = uploadToPortal) {
 var CLI_NAME = "Code PushUp CLI";
 var CLI_SCRIPT_NAME = "code-pushup";
 
+// packages/cli/src/lib/implementation/logging.ts
+import { cliui as cliui2 } from "@poppinss/cliui";
+import chalk6 from "chalk";
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui2();
+  }
+  return singletonUiInstance;
+}
+function renderConfigureCategoriesHint() {
+  ui().logger.info(
+    chalk6.gray(
+      `\u{1F4A1} Configure categories to see the scores in an overview table. See: ${link2(
+        "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md"
+      )}`
+    )
+  );
+}
+function uploadSuccessfulLog(options2, commit) {
+  ui().logger.success("Upload successful!");
+  ui().logger.success(
+    link2(
+      // @TODO extend config to maintain baseUrl under upload
+      portalCommitDashboardLink(
+        { ...options2, baseUrl: "<YOUR_PORTAL_URL>" },
+        commit
+      )
+    )
+  );
+}
+function collectSuccessfulLog() {
+  ui().logger.success("Collecting report successful!");
+}
+function renderIntegratePortalHint() {
+  ui().sticker().add(chalk6.bold(chalk6.gray("\u{1F4A1} Integrate the portal"))).add("").add(
+    `${chalk6.gray("\u276F")} Upload a report to the server - ${chalk6.gray(
+      "npx code-pushup upload"
+    )}`
+  ).add(
+    `  ${link2(
+      "https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command"
+    )}`
+  ).add(
+    `${chalk6.gray("\u276F")} ${chalk6.gray("Portal Integration")} - ${link2(
+      "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
+    )}`
+  ).add(
+    `${chalk6.gray("\u276F")} ${chalk6.gray("Upload Command")} - ${link2(
+      "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
+    )}`
+  ).render();
+}
+
 // packages/cli/src/lib/implementation/global.utils.ts
 function filterKebabCaseKeys(obj) {
   return Object.entries(obj).filter(([key]) => !key.includes("-")).reduce(
@@ -1957,8 +2032,8 @@ function yargsAutorunCommandObject() {
     describe: "Shortcut for running collect followed by upload",
     builder: yargsOnlyPluginsOptionsDefinition(),
     handler: async (args) => {
-      console.info(chalk5.bold(CLI_NAME));
-      console.info(chalk5.gray(`Run ${command}...`));
+      ui().logger.log(chalk7.bold(CLI_NAME));
+      ui().logger.info(chalk7.gray(`Run ${command}...`));
       const options2 = args;
       const optionsWithFormat = {
         ...options2,
@@ -1970,33 +2045,26 @@ function yargsAutorunCommandObject() {
         }
       };
       await collectAndPersistReports(optionsWithFormat);
+      collectSuccessfulLog();
       if (options2.categories.length === 0) {
-        console.info(
-          chalk5.gray(
-            "\u{1F4A1} Configure categories to see the scores in an overview table. See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md"
-          )
-        );
+        renderConfigureCategoriesHint();
       }
       if (options2.upload) {
         await upload(options2);
+        const commitData = await getLatestCommit();
+        if (validateCommitData(commitData, { throwError: true })) {
+          uploadSuccessfulLog(options2.upload, commitData.hash);
+        }
       } else {
-        console.warn("Upload skipped because configuration is not set.");
-        console.info(
-          [
-            "\u{1F4A1} Integrate the portal:",
-            "- npx code-pushup upload - Run upload to upload the created report to the server",
-            "  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command",
-            "- Portal Integration - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration",
-            "- Upload Command - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
-          ].join("\n")
-        );
+        ui().logger.warning("Upload skipped because configuration is not set.");
+        renderIntegratePortalHint();
       }
     }
   };
 }
 
 // packages/cli/src/lib/collect/collect-command.ts
-import chalk6 from "chalk";
+import chalk8 from "chalk";
 function yargsCollectCommandObject() {
   const command = "collect";
   return {
@@ -2005,31 +2073,39 @@ function yargsCollectCommandObject() {
     builder: yargsOnlyPluginsOptionsDefinition(),
     handler: async (args) => {
       const options2 = args;
-      console.info(chalk6.bold(CLI_NAME));
-      console.info(chalk6.gray(`Run ${command}...`));
+      ui().logger.log(chalk8.bold(CLI_NAME));
+      ui().logger.info(chalk8.gray(`Run ${command}...`));
       await collectAndPersistReports(options2);
+      collectSuccessfulLog();
       if (options2.categories.length === 0) {
-        console.info(
-          chalk6.gray(
-            "\u{1F4A1} Configure categories to see the scores in an overview table. See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md"
-          )
-        );
+        renderConfigureCategoriesHint();
       }
       const { upload: upload2 = {} } = args;
       if (Object.keys(upload2).length === 0) {
-        console.info(
-          [
-            "\u{1F4A1} Visualize your reports:",
-            "- npx code-pushup upload - Run upload to upload the created report to the server",
-            "  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command",
-            "- npx code-pushup autorun - Run collect & upload",
-            "  https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command"
-          ].join("\n")
-        );
+        renderUploadAutorunHint();
       }
     }
   };
 }
+function renderUploadAutorunHint() {
+  ui().sticker().add(chalk8.bold(chalk8.gray("\u{1F4A1} Visualize your reports"))).add("").add(
+    `${chalk8.gray("\u276F")} npx code-pushup upload - ${chalk8.gray(
+      "Run upload to upload the created report to the server"
+    )}`
+  ).add(
+    `  ${link2(
+      "https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command"
+    )}`
+  ).add(
+    `${chalk8.gray("\u276F")} npx code-pushup autorun - ${chalk8.gray(
+      "Run collect & upload"
+    )}`
+  ).add(
+    `  ${link2(
+      "https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command"
+    )}`
+  ).render();
+}
 
 // packages/cli/src/lib/print-config/print-config-command.ts
 function yargsConfigCommandObject() {
@@ -2043,35 +2119,31 @@ function yargsConfigCommandObject() {
     handler: (yargsArgs) => {
       const { _, $0, ...args } = yargsArgs;
       const cleanArgs = filterKebabCaseKeys(args);
-      console.info(JSON.stringify(cleanArgs, null, 2));
+      ui().logger.log(JSON.stringify(cleanArgs, null, 2));
     }
   };
 }
 
 // packages/cli/src/lib/upload/upload-command.ts
-import chalk7 from "chalk";
+import chalk9 from "chalk";
 function yargsUploadCommandObject() {
   const command = "upload";
   return {
     command,
     describe: "Upload report results to the portal",
     handler: async (args) => {
-      console.info(chalk7.bold(CLI_NAME));
-      console.info(chalk7.gray(`Run ${command}...`));
+      ui().logger.log(chalk9.bold(CLI_NAME));
+      ui().logger.info(chalk9.gray(`Run ${command}...`));
       const options2 = args;
       if (!options2.upload) {
-        console.info(
-          [
-            "\u{1F4A1} Integrate the portal:",
-            "- npx code-pushup upload - Run upload to upload the created report to the server",
-            "  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command",
-            "- Portal Integration - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration",
-            "- Upload Command - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
-          ].join("\n")
-        );
+        renderIntegratePortalHint();
         throw new Error("Upload configuration not set");
       }
       await upload(options2);
+      const commitData = await getLatestCommit();
+      if (validateCommitData(commitData, { throwError: true })) {
+        uploadSuccessfulLog(options2.upload, commitData.hash);
+      }
     }
   };
 }
@@ -2123,7 +2195,7 @@ async function coreConfigMiddleware(processArgs) {
 }
 
 // packages/cli/src/lib/implementation/only-plugins.utils.ts
-import chalk8 from "chalk";
+import chalk10 from "chalk";
 function filterPluginsBySlug(plugins, { onlyPlugins }) {
   if (!onlyPlugins?.length) {
     return plugins;
@@ -2145,7 +2217,7 @@ function filterCategoryByPluginSlug(categories, {
       const isNotSkipped = onlyPlugins.includes(ref.slug);
       if (!isNotSkipped && verbose) {
         console.info(
-          `${chalk8.yellow("\u26A0")} Category "${category.title}" is ignored because it references audits from skipped plugin "${ref.slug}"`
+          `${chalk10.yellow("\u26A0")} Category "${category.title}" is ignored because it references audits from skipped plugin "${ref.slug}"`
         );
       }
       return isNotSkipped;
@@ -2159,7 +2231,7 @@ function validateOnlyPluginsOption(plugins, {
   const missingPlugins = onlyPlugins?.length ? onlyPlugins.filter((plugin) => !plugins.some(({ slug }) => slug === plugin)) : [];
   if (missingPlugins.length > 0 && verbose) {
     console.warn(
-      `${chalk8.yellow(
+      `${chalk10.yellow(
         "\u26A0"
       )} The --onlyPlugin argument references plugins with "${missingPlugins.join(
         '", "'
@@ -2264,7 +2336,7 @@ var options = {
 };
 
 // packages/cli/src/lib/yargs-cli.ts
-import chalk9 from "chalk";
+import chalk11 from "chalk";
 import yargs from "yargs";
 function yargsCli(argv, cfg) {
   const { usageMessage, scriptName, noExitProcess } = cfg;
@@ -2282,7 +2354,7 @@ function yargsCli(argv, cfg) {
     (config) => Array.isArray(config) ? config.at(-1) : config
   ).options(options2).wrap(TERMINAL_WIDTH);
   if (usageMessage) {
-    cli2.usage(chalk9.bold(usageMessage));
+    cli2.usage(chalk11.bold(usageMessage));
   }
   if (scriptName) {
     cli2.scriptName(scriptName);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.14.3",
+  "version": "0.15.0",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"
@@ -10,7 +10,8 @@
     "@code-pushup/core": "*",
     "yargs": "^17.7.2",
     "chalk": "^5.3.0",
-    "@code-pushup/utils": "*"
+    "@code-pushup/utils": "*",
+    "@poppinss/cliui": "^6.3.0"
   },
   "homepage": "https://github.com/code-pushup/cli#readme",
   "bugs": {

package/src/lib/collect/collect-command.d.ts

@@ -1,2 +1,3 @@
 import { CommandModule } from 'yargs';
 export declare function yargsCollectCommandObject(): CommandModule;
+export declare function renderUploadAutorunHint(): void;

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

@@ -0,0 +1,9 @@
+import { cliui } from '@poppinss/cliui';
+import { UploadConfig } from '@code-pushup/models';
+export type CliUi = ReturnType<typeof cliui>;
+export declare let singletonUiInstance: CliUi | undefined;
+export declare function ui(): CliUi;
+export declare function renderConfigureCategoriesHint(): void;
+export declare function uploadSuccessfulLog(options: UploadConfig, commit: string): void;
+export declare function collectSuccessfulLog(): void;
+export declare function renderIntegratePortalHint(): void;