@code-pushup/js-packages-plugin 0.48.0 → 0.50.0

package/README.md

@@ -45,7 +45,7 @@ It supports the following package managers:
      // ...
      plugins: [
        // ...
-       await jsPackagesPlugin({ packageManager: 'npm' }), // replace with your package manager
+       await jsPackagesPlugin(), // the package manager is automatically derived from your file system. Use { packageManager: 'npm' } to configure it.
      ],
    };
    ```
@@ -59,7 +59,7 @@ It supports the following package managers:
      // ...
      plugins: [
        // ...
-       await jsPackagesPlugin({ packageManager: ['yarn-classic'], checks: ['audit'], dependencyGroups: ['prod'] }),
+       await jsPackagesPlugin({ packageManager: 'yarn-classic', checks: ['audit'], dependencyGroups: ['prod'] }),
      ],
    };
    ```

package/bin.js

@@ -670,6 +670,8 @@ var auditResultSchema = scorableWithPluginMetaSchema.merge(
 );
 var reportsDiffSchema = z15.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  portalUrl: urlSchema.optional().describe("Link to comparison page in Code PushUp portal"),
+  label: z15.string().optional().describe("Label (e.g. project name)"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
     categoryResultSchema,
@@ -698,11 +700,74 @@ var reportsDiffSchema = z15.object({
 );
 
 // packages/utils/src/lib/execute-process.ts
-import { spawn } from "node:child_process";
+import {
+  spawn
+} from "node:child_process";
+
+// packages/utils/src/lib/reports/utils.ts
+import ansis from "ansis";
+import { md } from "build-md";
+
+// packages/utils/src/lib/reports/constants.ts
+var TERMINAL_WIDTH = 80;
+
+// packages/utils/src/lib/reports/utils.ts
+function calcDuration(start, stop) {
+  return Math.round((stop ?? performance.now()) - start);
+}
+
+// packages/utils/src/lib/execute-process.ts
+var ProcessError = class extends Error {
+  code;
+  stderr;
+  stdout;
+  constructor(result) {
+    super(result.stderr);
+    this.code = result.code;
+    this.stderr = result.stderr;
+    this.stdout = result.stdout;
+  }
+};
+function executeProcess(cfg) {
+  const { command, args, observer, ignoreExitCode = false, ...options } = cfg;
+  const { onStdout, onStderr, onError, onComplete } = observer ?? {};
+  const date = (/* @__PURE__ */ new Date()).toISOString();
+  const start = performance.now();
+  return new Promise((resolve, reject) => {
+    const spawnedProcess = spawn(command, args ?? [], {
+      shell: true,
+      ...options
+    });
+    let stdout = "";
+    let stderr = "";
+    spawnedProcess.stdout.on("data", (data) => {
+      stdout += String(data);
+      onStdout?.(String(data), spawnedProcess);
+    });
+    spawnedProcess.stderr.on("data", (data) => {
+      stderr += String(data);
+      onStderr?.(String(data), spawnedProcess);
+    });
+    spawnedProcess.on("error", (err) => {
+      stderr += err.toString();
+    });
+    spawnedProcess.on("close", (code2) => {
+      const timings = { date, duration: calcDuration(start) };
+      if (code2 === 0 || ignoreExitCode) {
+        onComplete?.();
+        resolve({ code: code2, stdout, stderr, ...timings });
+      } else {
+        const errorMsg = new ProcessError({ code: code2, stdout, stderr, ...timings });
+        onError?.(errorMsg);
+        reject(errorMsg);
+      }
+    });
+  });
+}
 
 // packages/utils/src/lib/file-system.ts
+import { bold, gray } from "ansis";
 import { bundleRequire } from "bundle-require";
-import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
 
@@ -731,12 +796,7 @@ function isPromiseRejectedResult(result) {
 // packages/utils/src/lib/logging.ts
 import isaacs_cliui from "@isaacs/cliui";
 import { cliui } from "@poppinss/cliui";
-import chalk from "chalk";
-
-// packages/utils/src/lib/reports/constants.ts
-var TERMINAL_WIDTH = 80;
-
-// packages/utils/src/lib/logging.ts
+import { underline } from "ansis";
 var singletonUiInstance;
 function ui() {
   if (singletonUiInstance === void 0) {
@@ -805,37 +865,8 @@ async function crawlFileSystem(options) {
   return resultsNestedArray.flat();
 }
 
-// packages/utils/src/lib/text-formats/constants.ts
-var NEW_LINE = "\n";
-var TAB = "  ";
-
-// packages/utils/src/lib/text-formats/html/details.ts
-function details(title, content, cfg = { open: false }) {
-  return `<details${cfg.open ? " open" : ""}>${NEW_LINE}<summary>${title}</summary>${NEW_LINE}${// ⚠️ The blank line is needed to ensure Markdown in content is rendered correctly.
-  NEW_LINE}${content}${NEW_LINE}${// @TODO in the future we could consider adding it only if the content ends with a code block
-  // ⚠️ The blank line ensure Markdown in content is rendered correctly.
-  NEW_LINE}</details>${// ⚠️ The blank line is needed to ensure Markdown after details is rendered correctly.
-  NEW_LINE}`;
-}
-
-// packages/utils/src/lib/text-formats/html/font-style.ts
-var boldElement = "b";
-function bold(text) {
-  return `<${boldElement}>${text}</${boldElement}>`;
-}
-var italicElement = "i";
-function italic(text) {
-  return `<${italicElement}>${text}</${italicElement}>`;
-}
-var codeElement = "code";
-function code(text) {
-  return `<${codeElement}>${text}</${codeElement}>`;
-}
-
-// packages/utils/src/lib/text-formats/html/link.ts
-function link(href, text) {
-  return `<a href="${href}">${text || href}</a>`;
-}
+// packages/utils/src/lib/git/git.ts
+import { simpleGit } from "simple-git";
 
 // packages/utils/src/lib/transform.ts
 import { platform } from "node:os";
@@ -855,316 +886,6 @@ function fromJsonLines(jsonLines) {
   const unifiedNewLines = toUnixNewlines(jsonLines).trim();
   return JSON.parse(`[${unifiedNewLines.split("\n").join(",")}]`);
 }
-function capitalize(text) {
-  return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
-    1
-  )}`;
-}
-function apostrophize(text, upperCase) {
-  const lastCharMatch = text.match(/(\w)\W*$/);
-  const lastChar = lastCharMatch?.[1] ?? "";
-  return `${text}'${lastChar.toLocaleLowerCase() === "s" ? "" : upperCase ? "S" : "s"}`;
-}
-
-// packages/utils/src/lib/text-formats/table.ts
-function rowToStringArray({ rows, columns = [] }) {
-  if (Array.isArray(rows.at(0)) && typeof columns.at(0) === "object") {
-    throw new TypeError(
-      "Column can`t be object when rows are primitive values"
-    );
-  }
-  return rows.map((row) => {
-    if (Array.isArray(row)) {
-      return row.map(String);
-    }
-    const objectRow = row;
-    if (columns.length === 0 || typeof columns.at(0) === "string") {
-      return Object.values(objectRow).map(
-        (value) => value == null ? "" : String(value)
-      );
-    }
-    return columns.map(
-      ({ key }) => objectRow[key] == null ? "" : String(objectRow[key])
-    );
-  });
-}
-function columnsToStringArray({
-  rows,
-  columns = []
-}) {
-  const firstRow = rows.at(0);
-  const primitiveRows = Array.isArray(firstRow);
-  if (typeof columns.at(0) === "string" && !primitiveRows) {
-    throw new Error("invalid union type. Caught by model parsing.");
-  }
-  if (columns.length === 0) {
-    if (Array.isArray(firstRow)) {
-      return firstRow.map((_, idx) => String(idx));
-    }
-    return Object.keys(firstRow);
-  }
-  if (typeof columns.at(0) === "string") {
-    return columns.map(String);
-  }
-  const cols = columns;
-  return cols.map(({ label, key }) => label ?? capitalize(key));
-}
-function getColumnAlignmentForKeyAndIndex(targetKey, targetIdx, columns = []) {
-  const column = columns.at(targetIdx) ?? columns.find((col) => col.key === targetKey);
-  if (typeof column === "string") {
-    return column;
-  } else if (typeof column === "object") {
-    return column.align ?? "center";
-  } else {
-    return "center";
-  }
-}
-function getColumnAlignmentForIndex(targetIdx, columns = []) {
-  const column = columns.at(targetIdx);
-  if (column == null) {
-    return "center";
-  } else if (typeof column === "string") {
-    return column;
-  } else if (typeof column === "object") {
-    return column.align ?? "center";
-  } else {
-    return "center";
-  }
-}
-function getColumnAlignments(tableData) {
-  const { rows, columns = [] } = tableData;
-  if (rows.at(0) == null) {
-    throw new Error("first row can`t be undefined.");
-  }
-  if (Array.isArray(rows.at(0))) {
-    const firstPrimitiveRow = rows.at(0);
-    return Array.from({ length: firstPrimitiveRow.length }).map(
-      (_, idx) => getColumnAlignmentForIndex(idx, columns)
-    );
-  }
-  const biggestRow = [...rows].sort((a, b) => Object.keys(a).length - Object.keys(b).length).at(-1);
-  if (columns.length > 0) {
-    return columns.map(
-      (column, idx) => typeof column === "string" ? column : getColumnAlignmentForKeyAndIndex(
-        column.key,
-        idx,
-        columns
-      )
-    );
-  }
-  return Object.keys(biggestRow ?? {}).map((_) => "center");
-}
-
-// packages/utils/src/lib/text-formats/html/table.ts
-function wrap(elem, content) {
-  return `<${elem}>${content}</${elem}>${NEW_LINE}`;
-}
-function wrapRow(content) {
-  const elem = "tr";
-  return `<${elem}>${NEW_LINE}${content}</${elem}>${NEW_LINE}`;
-}
-function table(tableData) {
-  if (tableData.rows.length === 0) {
-    throw new Error("Data can't be empty");
-  }
-  const tableHeaderCols = columnsToStringArray(tableData).map((s) => wrap("th", s)).join("");
-  const tableHeaderRow = wrapRow(tableHeaderCols);
-  const tableBody = rowToStringArray(tableData).map((arr) => {
-    const columns = arr.map((s) => wrap("td", s)).join("");
-    return wrapRow(columns);
-  }).join("");
-  return wrap("table", `${NEW_LINE}${tableHeaderRow}${tableBody}`);
-}
-
-// packages/utils/src/lib/text-formats/md/font-style.ts
-var boldWrap = "**";
-function bold2(text) {
-  return `${boldWrap}${text}${boldWrap}`;
-}
-var italicWrap = "_";
-function italic2(text) {
-  return `${italicWrap}${text}${italicWrap}`;
-}
-var strikeThroughWrap = "~";
-function strikeThrough(text) {
-  return `${strikeThroughWrap}${text}${strikeThroughWrap}`;
-}
-var codeWrap = "`";
-function code2(text) {
-  return `${codeWrap}${text}${codeWrap}`;
-}
-
-// packages/utils/src/lib/text-formats/md/headline.ts
-function headline(text, hierarchy = 1) {
-  return `${"#".repeat(hierarchy)} ${text}${NEW_LINE}`;
-}
-function h(text, hierarchy = 1) {
-  return headline(text, hierarchy);
-}
-function h1(text) {
-  return headline(text, 1);
-}
-function h2(text) {
-  return headline(text, 2);
-}
-function h3(text) {
-  return headline(text, 3);
-}
-function h4(text) {
-  return headline(text, 4);
-}
-function h5(text) {
-  return headline(text, 5);
-}
-function h6(text) {
-  return headline(text, 6);
-}
-
-// packages/utils/src/lib/text-formats/md/image.ts
-function image(src, alt) {
-  return `![${alt}](${src})`;
-}
-
-// packages/utils/src/lib/text-formats/md/link.ts
-function link2(href, text) {
-  return `[${text || href}](${href})`;
-}
-
-// packages/utils/src/lib/text-formats/md/list.ts
-function li(text, order = "unordered") {
-  const style = order === "unordered" ? "-" : "- [ ]";
-  return `${style} ${text}`;
-}
-function indentation(text, level = 1) {
-  return `${TAB.repeat(level)}${text}`;
-}
-
-// packages/utils/src/lib/text-formats/md/paragraphs.ts
-function paragraphs(...sections) {
-  return sections.filter(Boolean).join(`${NEW_LINE}${NEW_LINE}`);
-}
-
-// packages/utils/src/lib/text-formats/md/section.ts
-function section(...contents) {
-  return `${lines(...contents)}${NEW_LINE}`;
-}
-function lines(...contents) {
-  const filteredContent = contents.filter(
-    (value) => value != null && value !== "" && value !== false
-  );
-  return `${filteredContent.join(NEW_LINE)}`;
-}
-
-// packages/utils/src/lib/text-formats/md/table.ts
-var alignString = /* @__PURE__ */ new Map([
-  ["left", ":--"],
-  ["center", ":--:"],
-  ["right", "--:"]
-]);
-function tableRow(rows) {
-  return `|${rows.join("|")}|`;
-}
-function table2(data) {
-  if (data.rows.length === 0) {
-    throw new Error("Data can't be empty");
-  }
-  const alignmentRow = getColumnAlignments(data).map(
-    (s) => alignString.get(s) ?? String(alignString.get("center"))
-  );
-  return section(
-    `${lines(
-      tableRow(columnsToStringArray(data)),
-      tableRow(alignmentRow),
-      ...rowToStringArray(data).map(tableRow)
-    )}`
-  );
-}
-
-// packages/utils/src/lib/text-formats/index.ts
-var md = {
-  bold: bold2,
-  italic: italic2,
-  strikeThrough,
-  code: code2,
-  link: link2,
-  image,
-  headline,
-  h,
-  h1,
-  h2,
-  h3,
-  h4,
-  h5,
-  h6,
-  indentation,
-  lines,
-  li,
-  section,
-  paragraphs,
-  table: table2
-};
-var html = {
-  bold,
-  italic,
-  code,
-  link,
-  details,
-  table
-};
-
-// packages/utils/src/lib/reports/utils.ts
-var { image: image2, bold: boldMd } = md;
-function calcDuration(start, stop) {
-  return Math.round((stop ?? performance.now()) - start);
-}
-
-// packages/utils/src/lib/execute-process.ts
-var ProcessError = class extends Error {
-  code;
-  stderr;
-  stdout;
-  constructor(result) {
-    super(result.stderr);
-    this.code = result.code;
-    this.stderr = result.stderr;
-    this.stdout = result.stdout;
-  }
-};
-function executeProcess(cfg) {
-  const { observer, cwd, command, args, ignoreExitCode = false } = cfg;
-  const { onStdout, onError, onComplete } = observer ?? {};
-  const date = (/* @__PURE__ */ new Date()).toISOString();
-  const start = performance.now();
-  return new Promise((resolve, reject) => {
-    const process2 = spawn(command, args, { cwd, shell: true });
-    let stdout = "";
-    let stderr = "";
-    process2.stdout.on("data", (data) => {
-      stdout += String(data);
-      onStdout?.(String(data));
-    });
-    process2.stderr.on("data", (data) => {
-      stderr += String(data);
-    });
-    process2.on("error", (err) => {
-      stderr += err.toString();
-    });
-    process2.on("close", (code3) => {
-      const timings = { date, duration: calcDuration(start) };
-      if (code3 === 0 || ignoreExitCode) {
-        onComplete?.();
-        resolve({ code: code3, stdout, stderr, ...timings });
-      } else {
-        const errorMsg = new ProcessError({ code: code3, stdout, stderr, ...timings });
-        onError?.(errorMsg);
-        reject(errorMsg);
-      }
-    });
-  });
-}
-
-// packages/utils/src/lib/git/git.ts
-import { simpleGit } from "simple-git";
 
 // packages/utils/src/lib/git/git.commits-and-tags.ts
 import { simpleGit as simpleGit2 } from "simple-git";
@@ -1173,34 +894,32 @@ import { simpleGit as simpleGit2 } from "simple-git";
 import { rcompare, valid } from "semver";
 
 // packages/utils/src/lib/progress.ts
-import chalk3 from "chalk";
+import { black, bold as bold2, gray as gray2, green } from "ansis";
 import { MultiProgressBars } from "multi-progress-bars";
 
+// packages/utils/src/lib/reports/generate-md-report.ts
+import { MarkdownDocument as MarkdownDocument3, md as md4 } from "build-md";
+
 // packages/utils/src/lib/reports/formatting.ts
-var { headline: headline2, lines: lines2, link: link3, section: section2, table: table3 } = md;
+import {
+  MarkdownDocument,
+  md as md2
+} from "build-md";
 
 // packages/utils/src/lib/reports/generate-md-report-categoy-section.ts
-var { link: link4, section: section3, h2: h22, lines: lines3, li: li2, bold: boldMd2, h3: h32, indentation: indentation2 } = md;
-
-// packages/utils/src/lib/reports/generate-md-report.ts
-var { h1: h12, h2: h23, h3: h33, lines: lines4, link: link5, section: section4, code: codeMd } = md;
-var { bold: boldHtml, details: details2 } = html;
+import { MarkdownDocument as MarkdownDocument2, md as md3 } from "build-md";
 
 // packages/utils/src/lib/reports/generate-md-reports-diff.ts
-var {
-  h1: h13,
-  h2: h24,
-  lines: lines5,
-  link: link6,
-  bold: boldMd3,
-  italic: italicMd,
-  table: table4,
-  section: section5
-} = md;
-var { details: details3 } = html;
+import {
+  MarkdownDocument as MarkdownDocument5,
+  md as md6
+} from "build-md";
+
+// packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts
+import { MarkdownDocument as MarkdownDocument4, md as md5 } from "build-md";
 
 // packages/utils/src/lib/reports/log-stdout-summary.ts
-import chalk4 from "chalk";
+import { bold as bold4, cyan, cyanBright, green as green2, red } from "ansis";
 
 // packages/plugin-js-packages/src/lib/config.ts
 import { z as z16 } from "zod";
@@ -1256,9 +975,7 @@ var jsPackagesPluginConfigSchema = z16.object({
   checks: z16.array(packageCommandSchema, {
     description: "Package manager commands to be run. Defaults to both audit and outdated."
   }).min(1).default(["audit", "outdated"]),
-  packageManager: packageManagerIdSchema.describe(
-    "Package manager to be used."
-  ),
+  packageManager: packageManagerIdSchema.describe("Package manager to be used.").optional(),
   dependencyGroups: z16.array(dependencyGroupSchema).min(1).default(["prod", "dev"]),
   auditLevelMapping: z16.record(packageAuditLevelSchema, issueSeveritySchema, {
     description: "Mapping of audit levels to issue severity. Custom mapping or overrides may be entered manually, otherwise has a default preset."
@@ -1787,6 +1504,9 @@ var packageManagers = {
   pnpm: pnpmPackageManager
 };
 
+// packages/plugin-js-packages/src/lib/runner/audit/transform.ts
+import { md as md7 } from "build-md";
+
 // packages/plugin-js-packages/src/lib/runner/audit/constants.ts
 var auditScoreModifiers = {
   critical: 1,
@@ -1837,14 +1557,16 @@ function vulnerabilitiesToIssues(vulnerabilities, auditLevelMapping) {
     return [];
   }
   return vulnerabilities.map((detail) => {
-    const versionRange = detail.versionRange === "*" ? "**all** versions" : `versions **${detail.versionRange}**`;
-    const directDependency = typeof detail.directDependency === "string" && detail.directDependency !== "" ? `\`${detail.directDependency}\`` : "";
-    const depHierarchy = directDependency === "" ? `\`${detail.name}\` dependency` : `${apostrophize(directDependency)} dependency \`${detail.name}\``;
-    const vulnerabilitySummary = `has a **${detail.severity}** vulnerability in ${versionRange}.`;
+    const versionRange = detail.versionRange === "*" ? md7`${md7.bold("all")} versions` : md7`versions ${md7.bold(detail.versionRange)}`;
+    const directDependency = typeof detail.directDependency === "string" && detail.directDependency !== "" ? md7.code(detail.directDependency) : "";
+    const depHierarchy = directDependency ? md7`${directDependency}'s dependency ${md7.code(detail.name)}` : md7`${md7.code(detail.name)} dependency`;
+    const vulnerabilitySummary = md7`has a ${md7.bold(
+      detail.severity
+    )} vulnerability in ${versionRange}.`;
     const fixInfo = detail.fixInformation ? ` ${detail.fixInformation}` : "";
-    const additionalInfo = detail.title != null && detail.url != null ? ` More information: [${detail.title}](${detail.url})` : "";
+    const additionalInfo = detail.title != null && detail.url != null ? md7` More information: ${md7.link(detail.url, detail.title)}` : "";
     return {
-      message: `${depHierarchy} ${vulnerabilitySummary}${fixInfo}${additionalInfo}`,
+      message: md7`${depHierarchy} ${vulnerabilitySummary}${fixInfo}${additionalInfo}`.toString(),
       severity: auditLevelMapping[detail.severity]
     };
   });
@@ -1861,6 +1583,7 @@ var PLUGIN_CONFIG_PATH = join2(
 );
 
 // packages/plugin-js-packages/src/lib/runner/outdated/transform.ts
+import { md as md8 } from "build-md";
 import { clean, diff, neq } from "semver";
 
 // packages/plugin-js-packages/src/lib/runner/outdated/constants.ts
@@ -1931,9 +1654,11 @@ function outdatedToIssues(dependencies) {
   return dependencies.map((dep) => {
     const { name, current, latest, url } = dep;
     const outdatedLevel = diff(current, latest);
-    const packageReference = url == null ? `\`${name}\`` : `[\`${name}\`](${url})`;
+    const packageReference = url == null ? md8.code(name) : md8.link(url, md8.code(name));
     return {
-      message: `Package ${packageReference} requires a **${outdatedLevel}** update from **${current}** to **${latest}**.`,
+      message: md8`Package ${packageReference} requires a ${md8.bold(
+        outdatedLevel
+      )} update from ${md8.bold(current)} to ${md8.bold(latest)}.`.toString(),
       severity: outdatedSeverity[outdatedLevel]
     };
   });