@code-pushup/cli 0.18.1 → 0.19.0

package/index.js

@@ -971,16 +971,35 @@ function executeProcess(cfg) {
   });
 }
 
+// packages/utils/src/lib/transform.ts
+function toArray(val) {
+  return Array.isArray(val) ? val : [val];
+}
+function deepClone(obj) {
+  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
+}
+function toUnixPath(path) {
+  return path.replace(/\\/g, "/");
+}
+
 // packages/utils/src/lib/git.ts
+import { isAbsolute, join as join2, relative } from "node:path";
 import { simpleGit } from "simple-git";
-var git = simpleGit();
-async function getLatestCommit() {
+async function getLatestCommit(git = simpleGit()) {
   const log = await git.log({
     maxCount: 1,
     format: { hash: "%H", message: "%s", author: "%an", date: "%ad" }
   });
   return log.latest;
 }
+function getGitRoot(git = simpleGit()) {
+  return git.revparse("--show-toplevel");
+}
+function formatGitPath(path, gitRoot) {
+  const absolutePath = isAbsolute(path) ? path : join2(process.cwd(), path);
+  const relativePath = relative(gitRoot, absolutePath);
+  return toUnixPath(relativePath);
+}
 function validateCommitData(commitData, options2 = {}) {
   const { throwError = false } = options2;
   if (!commitData) {
@@ -1003,18 +1022,24 @@ function groupByStatus(results) {
   );
 }
 
-// packages/utils/src/lib/progress.ts
+// packages/utils/src/lib/logging.ts
 import chalk2 from "chalk";
+function link(text) {
+  return chalk2.underline(chalk2.blueBright(text));
+}
+
+// packages/utils/src/lib/progress.ts
+import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 var barStyles = {
-  active: (s) => chalk2.green(s),
-  done: (s) => chalk2.gray(s),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.green(s),
+  done: (s) => chalk3.gray(s),
+  idle: (s) => chalk3.gray(s)
 };
 var messageStyles = {
-  active: (s) => chalk2.black(s),
-  done: (s) => chalk2.green(chalk2.bold(s)),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.black(s),
+  done: (s) => chalk3.green(chalk3.bold(s)),
+  idle: (s) => chalk3.gray(s)
 };
 var mpb;
 function getSingletonProgressBars(options2) {
@@ -1094,7 +1119,7 @@ function h3(text) {
 }
 
 // packages/utils/src/lib/reports/md/link.ts
-function link(href, text) {
+function link2(href, text) {
   return `[${text || href}](${href})`;
 }
 
@@ -1145,7 +1170,7 @@ function generateMdReport(report, commitData) {
     (printCategories ? reportToCategoriesSection(report) + NEW_LINE + NEW_LINE : "") + // audits section
     reportToAuditsSection(report) + NEW_LINE + NEW_LINE + // about section
     reportToAboutSection(report, commitData) + NEW_LINE + NEW_LINE + // footer section
-    `${FOOTER_PREFIX} ${link(README_LINK, "Code PushUp")}`
+    `${FOOTER_PREFIX} ${link2(README_LINK, "Code PushUp")}`
   );
 }
 function reportToHeaderSection() {
@@ -1156,7 +1181,7 @@ function reportToOverviewSection(report) {
   const tableContent = [
     reportOverviewTableHeaders,
     ...categories.map(({ title, refs, score }) => [
-      link(`#${slugify(title)}`, title),
+      link2(`#${slugify(title)}`, title),
       `${getRoundScoreMarker(score)} ${style(formatReportScore(score))}`,
       countCategoryAudits(refs, plugins).toString()
     ])
@@ -1188,7 +1213,7 @@ function reportToCategoriesSection(report) {
 }
 function auditItemToCategorySection(audit, plugins) {
   const pluginTitle = getPluginNameFromSlug(audit.plugin, plugins);
-  const auditTitle = link(
+  const auditTitle = link2(
     `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
     audit.title
   );
@@ -1205,7 +1230,7 @@ function groupItemToCategorySection(group, plugins) {
     `${getRoundScoreMarker(groupScore)} ${group.title} (_${pluginTitle}_)`
   );
   const groupAudits = group.audits.reduce((acc, audit) => {
-    const auditTitle = link(
+    const auditTitle = link2(
       `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
       audit.title
     );
@@ -1292,7 +1317,7 @@ function getDocsAndDescription({
   description
 }) {
   if (docsUrl) {
-    const docsLink = link(docsUrl, "\u{1F4D6} Docs");
+    const docsLink = link2(docsUrl, "\u{1F4D6} Docs");
     if (!description) {
       return docsLink + NEW_LINE + NEW_LINE;
     }
@@ -1313,7 +1338,7 @@ function getAuditResult(audit, isHtml = false) {
 
 // packages/utils/src/lib/reports/generate-stdout-summary.ts
 import cliui from "@isaacs/cliui";
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 import CliTable3 from "cli-table3";
 function addLine(line = "") {
   return line + NEW_LINE;
@@ -1324,7 +1349,7 @@ function generateStdoutSummary(report) {
 }
 function reportToHeaderSection2(report) {
   const { packageName, version: version2 } = report;
-  return `${chalk3.bold(reportHeadlineText)} - ${packageName}@${version2}`;
+  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version2}`;
 }
 function reportToDetailSection(report) {
   const { plugins } = report;
@@ -1344,13 +1369,13 @@ function reportToDetailSection(report) {
           padding: [0, 3, 0, 0]
         },
         {
-          text: chalk3.cyanBright(audit.displayValue || `${audit.value}`),
+          text: chalk4.cyanBright(audit.displayValue || `${audit.value}`),
           width: 10,
           padding: [0, 0, 0, 0]
         }
       );
     });
-    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui2.toString()) + addLine();
+    return acc + addLine() + addLine(chalk4.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui2.toString()) + addLine();
   }, "");
 }
 function reportToOverviewSection2({
@@ -1373,11 +1398,11 @@ function reportToOverviewSection2({
       countCategoryAudits(refs, plugins)
     ])
   );
-  return addLine(chalk3.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
+  return addLine(chalk4.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
 }
 function withColor({ score, text }) {
   const formattedScore = text ?? formatReportScore(score);
-  const style2 = text ? chalk3 : chalk3.bold;
+  const style2 = text ? chalk4 : chalk4.bold;
   if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return style2.green(formattedScore);
   }
@@ -1387,14 +1412,6 @@ function withColor({ score, text }) {
   return style2.red(formattedScore);
 }
 
-// packages/utils/src/lib/transform.ts
-function toArray(val) {
-  return Array.isArray(val) ? val : [val];
-}
-function deepClone(obj) {
-  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
-}
-
 // packages/utils/src/lib/reports/scoring.ts
 var GroupRefInvalidError = class extends Error {
   constructor(auditSlug, pluginSlug) {
@@ -1555,21 +1572,48 @@ 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.18.1";
+var version = "0.19.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk5 from "chalk";
 
+// packages/core/src/lib/normalize.ts
+function normalizePersistConfig(cfg) {
+  return {
+    outputDir: PERSIST_OUTPUT_DIR,
+    filename: PERSIST_FILENAME,
+    format: PERSIST_FORMAT,
+    ...cfg
+  };
+}
+async function normalizeAuditOutputs(audits) {
+  const gitRoot = await getGitRoot();
+  return audits.map((audit) => {
+    if (audit.details?.issues == null || audit.details.issues.every((issue) => issue.source == null)) {
+      return audit;
+    }
+    return {
+      ...audit,
+      details: {
+        ...audit.details,
+        issues: audit.details.issues.map(
+          (issue) => issue.source == null ? issue : {
+            ...issue,
+            source: {
+              ...issue.source,
+              file: formatGitPath(issue.source.file, gitRoot)
+            }
+          }
+        )
+      }
+    };
+  });
+}
+
 // packages/core/src/lib/implementation/runner.ts
-import { join as join2 } from "node:path";
+import { join as join3 } from "node:path";
 async function executeRunnerConfig(cfg, onProgress) {
   const { args, command, outputFile, outputTransform } = cfg;
   const { duration, date } = await executeProcess({
@@ -1577,7 +1621,7 @@ async function executeRunnerConfig(cfg, onProgress) {
     args,
     observer: { onStdout: onProgress }
   });
-  const outputs = await readJsonFile(join2(process.cwd(), outputFile));
+  const outputs = await readJsonFile(join3(process.cwd(), outputFile));
   const audits = outputTransform ? await outputTransform(outputs) : outputs;
   return {
     duration,
@@ -1615,7 +1659,8 @@ async function executePlugin(pluginConfig, onProgress) {
   const { audits: unvalidatedAuditOutputs, ...executionMeta } = runnerResult;
   const auditOutputs = auditOutputsSchema.parse(unvalidatedAuditOutputs);
   auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits);
-  const auditReports = auditOutputs.map(
+  const normalizedAuditOutputs = await normalizeAuditOutputs(auditOutputs);
+  const auditReports = normalizedAuditOutputs.map(
     (auditOutput) => ({
       ...auditOutput,
       ...pluginConfigAudits.find(
@@ -1693,7 +1738,7 @@ async function collect(options2) {
 
 // packages/core/src/lib/implementation/persist.ts
 import { mkdir as mkdir2, stat as stat2, writeFile } from "node:fs/promises";
-import { join as join3 } from "node:path";
+import { join as join4 } from "node:path";
 var PersistDirError = class extends Error {
   constructor(outputDir) {
     super(`outPath: ${outputDir} is no directory.`);
@@ -1737,7 +1782,7 @@ async function persistReport(report, options2) {
   return Promise.allSettled(
     results.map(
       (result) => persistResult(
-        join3(outputDir, `${filename}.${result.format}`),
+        join4(outputDir, `${filename}.${result.format}`),
         result.content
       )
     )
@@ -1753,14 +1798,6 @@ function logPersistedResults(persistResults) {
   logMultipleFileResults(persistResults, "Generated reports");
 }
 
-// packages/core/src/lib/normalize.ts
-var normalizePersistConfig = (cfg) => ({
-  outputDir: PERSIST_OUTPUT_DIR,
-  filename: PERSIST_FILENAME,
-  format: PERSIST_FORMAT,
-  ...cfg
-});
-
 // packages/core/src/lib/collect-and-persist.ts
 async function collectAndPersistReports(options2) {
   const { exec } = verboseUtils(options2.verbose);
@@ -1776,7 +1813,7 @@ async function collectAndPersistReports(options2) {
 }
 
 // packages/core/src/lib/implementation/read-rc-file.ts
-import { join as join4 } from "node:path";
+import { join as join5 } from "node:path";
 var ConfigPathError = class extends Error {
   constructor(configPath) {
     super(`Provided path '${configPath}' is not valid.`);
@@ -1809,7 +1846,7 @@ async function autoloadRc() {
       )}) present in ${process.cwd()}`
     );
   }
-  return readRcByPath(join4(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
+  return readRcByPath(join5(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
 }
 
 // packages/core/src/lib/upload.ts
@@ -1961,7 +1998,7 @@ function ui() {
 function renderConfigureCategoriesHint() {
   ui().logger.info(
     chalk6.gray(
-      `\u{1F4A1} Configure categories to see the scores in an overview table. See: ${link2(
+      `\u{1F4A1} Configure categories to see the scores in an overview table. See: ${link(
         "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md"
       )}`
     )
@@ -1970,7 +2007,7 @@ function renderConfigureCategoriesHint() {
 function uploadSuccessfulLog(options2, commit) {
   ui().logger.success("Upload successful!");
   ui().logger.success(
-    link2(
+    link(
       // @TODO extend config to maintain baseUrl under upload
       portalCommitDashboardLink(
         { ...options2, baseUrl: "<YOUR_PORTAL_URL>" },
@@ -1988,15 +2025,15 @@ function renderIntegratePortalHint() {
       "npx code-pushup upload"
     )}`
   ).add(
-    `  ${link2(
+    `  ${link(
       "https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command"
     )}`
   ).add(
-    `${chalk6.gray("\u276F")} ${chalk6.gray("Portal Integration")} - ${link2(
+    `${chalk6.gray("\u276F")} ${chalk6.gray("Portal Integration")} - ${link(
       "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
     )}`
   ).add(
-    `${chalk6.gray("\u276F")} ${chalk6.gray("Upload Command")} - ${link2(
+    `${chalk6.gray("\u276F")} ${chalk6.gray("Upload Command")} - ${link(
       "https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration"
     )}`
   ).render();
@@ -2111,7 +2148,7 @@ function renderUploadAutorunHint() {
       "Run upload to upload the created report to the server"
     )}`
   ).add(
-    `  ${link2(
+    `  ${link(
       "https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command"
     )}`
   ).add(
@@ -2119,7 +2156,7 @@ function renderUploadAutorunHint() {
       "Run collect & upload"
     )}`
   ).add(
-    `  ${link2(
+    `  ${link(
       "https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command"
     )}`
   ).render();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"