@code-pushup/coverage-plugin 0.26.1 → 0.27.1

package/bin.js

@@ -89,6 +89,9 @@ var descriptionSchema = z.string({ description: "Description (markdown)" }).max(
 var urlSchema = z.string().url();
 var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
 var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -220,6 +223,8 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z4.object(
   {
     issues: z4.array(issueSchema, { description: "List of findings" })
@@ -229,11 +234,9 @@ var auditDetailsSchema = z4.object(
 var auditOutputSchema = z4.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z4.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -556,14 +559,138 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/models/src/lib/reports-diff.ts
+import { z as z14 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z14.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z14.object(
+    {
+      changed: z14.array(diffSchema),
+      unchanged: z14.array(resultSchema),
+      added: z14.array(resultSchema),
+      removed: z14.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z14.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z14.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z14.object({
+        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z14.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z14.object({
+        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z14.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
+
 // packages/utils/src/lib/execute-process.ts
 import { spawn } from "node:child_process";
 
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
-import chalk from "chalk";
+import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
+
+// 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
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui();
+  }
+  return {
+    ...singletonUiInstance,
+    row: (args) => {
+      logListItem(args);
+    }
+  };
+}
+var singletonisaacUi;
+function logListItem(args) {
+  if (singletonisaacUi === void 0) {
+    singletonisaacUi = isaacs_cliui({ width: TERMINAL_WIDTH });
+  }
+  singletonisaacUi.div(...args);
+  const content = singletonisaacUi.toString();
+  singletonisaacUi.rows = [];
+  singletonUiInstance?.logger.log(content);
+}
+
+// packages/utils/src/lib/file-system.ts
 async function readTextFile(path) {
   const buffer = await readFile(path);
   return buffer.toString();
@@ -577,7 +704,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error(error.message);
+    ui().logger.error(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -605,7 +732,7 @@ var ProcessError = class extends Error {
   }
 };
 function executeProcess(cfg) {
-  const { observer, cwd, command, args } = cfg;
+  const { observer, cwd, command, args, alwaysResolve = false } = cfg;
   const { onStdout, onError, onComplete } = observer ?? {};
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
@@ -625,7 +752,7 @@ function executeProcess(cfg) {
     });
     process2.on("close", (code) => {
       const timings = { date, duration: calcDuration(start) };
-      if (code === 0) {
+      if (code === 0 || alwaysResolve) {
         onComplete?.();
         resolve({ code, stdout, stderr, ...timings });
       } else {
@@ -665,17 +792,12 @@ function toOrdinal(value) {
   return `${value}th`;
 }
 
-// packages/utils/src/lib/logging.ts
-import chalk2 from "chalk";
-
 // packages/utils/src/lib/progress.ts
 import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 
-// packages/utils/src/lib/reports/generate-stdout-summary.ts
-import cliui from "@isaacs/cliui";
+// packages/utils/src/lib/reports/log-stdout-summary.ts
 import chalk4 from "chalk";
-import CliTable3 from "cli-table3";
 
 // packages/plugin-coverage/src/lib/runner/constants.ts
 import { join as join2 } from "node:path";
@@ -857,10 +979,14 @@ async function executeRunner() {
       await executeProcess({ command, args });
     } catch (error) {
       if (error instanceof ProcessError) {
-        console.error(chalk5.bold("stdout from failed coverage tool process:"));
-        console.error(error.stdout);
-        console.error(chalk5.bold("stderr from failed coverage tool process:"));
-        console.error(error.stderr);
+        ui().logger.error(
+          chalk5.bold("stdout from failed coverage tool process:")
+        );
+        ui().logger.error(error.stdout);
+        ui().logger.error(
+          chalk5.bold("stderr from failed coverage tool process:")
+        );
+        ui().logger.error(error.stderr);
       }
       throw new Error(
         "Coverage plugin: Running coverage tool failed. Make sure all your provided tests are passing."

package/index.js

@@ -88,6 +88,9 @@ var descriptionSchema = z.string({ description: "Description (markdown)" }).max(
 var urlSchema = z.string().url();
 var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
 var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -219,6 +222,8 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z4.object(
   {
     issues: z4.array(issueSchema, { description: "List of findings" })
@@ -228,11 +233,9 @@ var auditDetailsSchema = z4.object(
 var auditOutputSchema = z4.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z4.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -555,17 +558,141 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/models/src/lib/reports-diff.ts
+import { z as z14 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z14.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z14.object(
+    {
+      changed: z14.array(diffSchema),
+      unchanged: z14.array(resultSchema),
+      added: z14.array(resultSchema),
+      removed: z14.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z14.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z14.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z14.object({
+        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z14.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z14.object({
+        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z14.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
+
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
-import chalk from "chalk";
+import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
+
+// 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
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui();
+  }
+  return {
+    ...singletonUiInstance,
+    row: (args) => {
+      logListItem(args);
+    }
+  };
+}
+var singletonisaacUi;
+function logListItem(args) {
+  if (singletonisaacUi === void 0) {
+    singletonisaacUi = isaacs_cliui({ width: TERMINAL_WIDTH });
+  }
+  singletonisaacUi.div(...args);
+  const content = singletonisaacUi.toString();
+  singletonisaacUi.rows = [];
+  singletonUiInstance?.logger.log(content);
+}
+
+// packages/utils/src/lib/file-system.ts
 async function ensureDirectoryExists(baseDir) {
   try {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error(error.message);
+    ui().logger.error(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -585,52 +712,47 @@ function capitalize(text) {
   )}`;
 }
 
-// packages/utils/src/lib/logging.ts
-import chalk2 from "chalk";
-
 // packages/utils/src/lib/progress.ts
 import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 
-// packages/utils/src/lib/reports/generate-stdout-summary.ts
-import cliui from "@isaacs/cliui";
+// packages/utils/src/lib/reports/log-stdout-summary.ts
 import chalk4 from "chalk";
-import CliTable3 from "cli-table3";
 
 // packages/plugin-coverage/package.json
 var name = "@code-pushup/coverage-plugin";
-var version = "0.26.1";
+var version = "0.27.1";
 
 // packages/plugin-coverage/src/lib/config.ts
-import { z as z14 } from "zod";
-var coverageTypeSchema = z14.enum(["function", "branch", "line"]);
-var coverageResultSchema = z14.union([
-  z14.object({
-    resultsPath: z14.string({
+import { z as z15 } from "zod";
+var coverageTypeSchema = z15.enum(["function", "branch", "line"]);
+var coverageResultSchema = z15.union([
+  z15.object({
+    resultsPath: z15.string({
       description: "Path to coverage results for Nx setup."
     }).includes("lcov"),
-    pathToProject: z14.string({
+    pathToProject: z15.string({
       description: "Path from workspace root to project root. Necessary for LCOV reports which provide a relative path."
     }).optional()
   }),
-  z14.string({
+  z15.string({
     description: "Path to coverage results for a single project setup."
   }).includes("lcov")
 ]);
-var coveragePluginConfigSchema = z14.object({
-  coverageToolCommand: z14.object({
-    command: z14.string({ description: "Command to run coverage tool." }).min(1),
-    args: z14.array(z14.string(), {
+var coveragePluginConfigSchema = z15.object({
+  coverageToolCommand: z15.object({
+    command: z15.string({ description: "Command to run coverage tool." }).min(1),
+    args: z15.array(z15.string(), {
       description: "Arguments to be passed to the coverage tool."
     }).optional()
   }).optional(),
-  coverageTypes: z14.array(coverageTypeSchema, {
+  coverageTypes: z15.array(coverageTypeSchema, {
     description: "Coverage types measured. Defaults to all available types."
   }).min(1).default(["function", "branch", "line"]),
-  reports: z14.array(coverageResultSchema, {
+  reports: z15.array(coverageResultSchema, {
     description: "Path to all code coverage report files. Only LCOV format is supported for now."
   }).min(1),
-  perfectScoreThreshold: z14.number({
+  perfectScoreThreshold: z15.number({
     description: "Score will be 1 (perfect) for this coverage and above. Score range is 0 - 1."
   }).gt(0).max(1).optional()
 });
@@ -728,7 +850,7 @@ async function coveragePlugin(config) {
 import chalk6 from "chalk";
 import { join as join4 } from "node:path";
 async function getNxCoveragePaths(targets = ["test"]) {
-  console.info(
+  ui().logger.info(
     chalk6.bold("\u{1F4A1} Gathering coverage from the following nx projects:")
   );
   const { createProjectGraphAsync } = await import("@nx/devkit");
@@ -741,14 +863,14 @@ async function getNxCoveragePaths(targets = ["test"]) {
       const targetConfig = data.targets?.[target];
       const coveragePath = getCoveragePathForTarget(target, targetConfig, name2);
       const rootToReportsDir = join4(data.root, coveragePath);
-      console.info(`- ${name2}: ${target}`);
+      ui().logger.info(`- ${name2}: ${target}`);
       return {
         pathToProject: data.root,
         resultsPath: join4(rootToReportsDir, "lcov.info")
       };
     });
   });
-  console.info("\n");
+  ui().logger.info("\n");
   return coverageResults.flat();
 }
 function hasNxTarget(project, target) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/coverage-plugin",
-  "version": "0.26.1",
+  "version": "0.27.1",
   "dependencies": {
     "@code-pushup/models": "*",
     "@code-pushup/utils": "*",