@code-pushup/coverage-plugin 0.46.0 → 0.47.0

package/bin.js

@@ -68,7 +68,7 @@ function missingRefsForCategoriesErrorMsg(categories, plugins) {
 }
 
 // packages/models/src/lib/implementation/schemas.ts
-var primitiveValueSchema = z.union([z.string(), z.number()]);
+var tableCellValueSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]).default(null);
 function executionMetaSchema(options = {
   descriptionDate: "Execution start date and time",
   descriptionDuration: "Execution duration in ms"
@@ -232,10 +232,10 @@ var tableColumnObjectSchema = z4.object({
   label: z4.string().optional(),
   align: tableAlignmentSchema.optional()
 });
-var tableRowObjectSchema = z4.record(primitiveValueSchema, {
+var tableRowObjectSchema = z4.record(tableCellValueSchema, {
   description: "Object row"
 });
-var tableRowPrimitiveSchema = z4.array(primitiveValueSchema, {
+var tableRowPrimitiveSchema = z4.array(tableCellValueSchema, {
   description: "Primitive row"
 });
 var tableSharedSchema = z4.object({
@@ -792,7 +792,7 @@ function code(text) {
 
 // packages/utils/src/lib/text-formats/html/link.ts
 function link(href, text) {
-  return `<a href="${href}">${text || href}"</a>`;
+  return `<a href="${href}">${text || href}</a>`;
 }
 
 // packages/utils/src/lib/transform.ts
@@ -825,7 +825,7 @@ function toOrdinal(value) {
   return `${value}th`;
 }
 
-// packages/utils/src/lib/table.ts
+// 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(
@@ -838,14 +838,19 @@ function rowToStringArray({ rows, columns = [] }) {
     }
     const objectRow = row;
     if (columns.length === 0 || typeof columns.at(0) === "string") {
-      return Object.values(objectRow).map(String);
+      return Object.values(objectRow).map(
+        (value) => value == null ? "" : String(value)
+      );
     }
     return columns.map(
-      ({ key }) => String(objectRow[key])
+      ({ key }) => objectRow[key] == null ? "" : String(objectRow[key])
     );
   });
 }
-function columnsToStringArray({ rows, columns = [] }) {
+function columnsToStringArray({
+  rows,
+  columns = []
+}) {
   const firstRow = rows.at(0);
   const primitiveRows = Array.isArray(firstRow);
   if (typeof columns.at(0) === "string" && !primitiveRows) {
@@ -885,10 +890,8 @@ function getColumnAlignmentForIndex(targetIdx, columns = []) {
     return "center";
   }
 }
-function getColumnAlignments({
-  rows,
-  columns = []
-}) {
+function getColumnAlignments(tableData) {
+  const { rows, columns = [] } = tableData;
   if (rows.at(0) == null) {
     throw new Error("first row can`t be undefined.");
   }
@@ -898,10 +901,17 @@ function getColumnAlignments({
       (_, idx) => getColumnAlignmentForIndex(idx, columns)
     );
   }
-  const firstObject = rows.at(0);
-  return Object.keys(firstObject).map(
-    (key, idx) => getColumnAlignmentForKeyAndIndex(key, 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
@@ -998,7 +1008,10 @@ function section(...contents) {
   return `${lines(...contents)}${NEW_LINE}`;
 }
 function lines(...contents) {
-  return `${contents.filter(Boolean).join(NEW_LINE)}`;
+  const filteredContent = contents.filter(
+    (value) => value != null && value !== "" && value !== false
+  );
+  return `${filteredContent.join(NEW_LINE)}`;
 }
 
 // packages/utils/src/lib/text-formats/md/table.ts
@@ -1393,12 +1406,12 @@ var recordToStatFunctionMapper = {
 function lcovCoverageToAuditOutput(stat2, coverageType) {
   const coverage = calculateCoverage(stat2.totalHit, stat2.totalFound);
   const MAX_DECIMAL_PLACES = 4;
-  const roundedIntValue = toNumberPrecision(coverage * 100, 0);
+  const coveragePercentage = coverage * 100;
   return {
     slug: `${coverageType}-coverage`,
     score: toNumberPrecision(coverage, MAX_DECIMAL_PLACES),
-    value: roundedIntValue,
-    displayValue: `${roundedIntValue} %`,
+    value: coveragePercentage,
+    displayValue: `${toNumberPrecision(coveragePercentage, 1)} %`,
     details: {
       issues: stat2.issues
     }

package/index.js

@@ -67,7 +67,7 @@ function missingRefsForCategoriesErrorMsg(categories, plugins) {
 }
 
 // packages/models/src/lib/implementation/schemas.ts
-var primitiveValueSchema = z.union([z.string(), z.number()]);
+var tableCellValueSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]).default(null);
 function executionMetaSchema(options = {
   descriptionDate: "Execution start date and time",
   descriptionDuration: "Execution duration in ms"
@@ -231,10 +231,10 @@ var tableColumnObjectSchema = z4.object({
   label: z4.string().optional(),
   align: tableAlignmentSchema.optional()
 });
-var tableRowObjectSchema = z4.record(primitiveValueSchema, {
+var tableRowObjectSchema = z4.record(tableCellValueSchema, {
   description: "Object row"
 });
-var tableRowPrimitiveSchema = z4.array(primitiveValueSchema, {
+var tableRowPrimitiveSchema = z4.array(tableCellValueSchema, {
   description: "Primitive row"
 });
 var tableSharedSchema = z4.object({
@@ -747,20 +747,12 @@ async function ensureDirectoryExists(baseDir) {
     }
   }
 }
-var NoExportError = class extends Error {
-  constructor(filepath) {
-    super(`No default export found in ${filepath}`);
+async function importModule(options) {
+  const { mod } = await bundleRequire(options);
+  if (typeof mod === "object" && "default" in mod) {
+    return mod.default;
   }
-};
-async function importEsmModule(options) {
-  const { mod } = await bundleRequire({
-    format: "esm",
-    ...options
-  });
-  if (!("default" in mod)) {
-    throw new NoExportError(options.filepath);
-  }
-  return mod.default;
+  return mod;
 }
 function pluginWorkDir(slug) {
   return join("node_modules", ".code-pushup", slug);
@@ -798,7 +790,7 @@ function code(text) {
 
 // packages/utils/src/lib/text-formats/html/link.ts
 function link(href, text) {
-  return `<a href="${href}">${text || href}"</a>`;
+  return `<a href="${href}">${text || href}</a>`;
 }
 
 // packages/utils/src/lib/transform.ts
@@ -808,7 +800,7 @@ function capitalize(text) {
   )}`;
 }
 
-// packages/utils/src/lib/table.ts
+// 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(
@@ -821,14 +813,19 @@ function rowToStringArray({ rows, columns = [] }) {
     }
     const objectRow = row;
     if (columns.length === 0 || typeof columns.at(0) === "string") {
-      return Object.values(objectRow).map(String);
+      return Object.values(objectRow).map(
+        (value) => value == null ? "" : String(value)
+      );
     }
     return columns.map(
-      ({ key }) => String(objectRow[key])
+      ({ key }) => objectRow[key] == null ? "" : String(objectRow[key])
     );
   });
 }
-function columnsToStringArray({ rows, columns = [] }) {
+function columnsToStringArray({
+  rows,
+  columns = []
+}) {
   const firstRow = rows.at(0);
   const primitiveRows = Array.isArray(firstRow);
   if (typeof columns.at(0) === "string" && !primitiveRows) {
@@ -868,10 +865,8 @@ function getColumnAlignmentForIndex(targetIdx, columns = []) {
     return "center";
   }
 }
-function getColumnAlignments({
-  rows,
-  columns = []
-}) {
+function getColumnAlignments(tableData) {
+  const { rows, columns = [] } = tableData;
   if (rows.at(0) == null) {
     throw new Error("first row can`t be undefined.");
   }
@@ -881,10 +876,17 @@ function getColumnAlignments({
       (_, idx) => getColumnAlignmentForIndex(idx, columns)
     );
   }
-  const firstObject = rows.at(0);
-  return Object.keys(firstObject).map(
-    (key, idx) => getColumnAlignmentForKeyAndIndex(key, 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
@@ -981,7 +983,10 @@ function section(...contents) {
   return `${lines(...contents)}${NEW_LINE}`;
 }
 function lines(...contents) {
-  return `${contents.filter(Boolean).join(NEW_LINE)}`;
+  const filteredContent = contents.filter(
+    (value) => value != null && value !== "" && value !== false
+  );
+  return `${filteredContent.join(NEW_LINE)}`;
 }
 
 // packages/utils/src/lib/text-formats/md/table.ts
@@ -1085,7 +1090,7 @@ import chalk4 from "chalk";
 
 // packages/plugin-coverage/package.json
 var name = "@code-pushup/coverage-plugin";
-var version = "0.46.0";
+var version = "0.47.0";
 
 // packages/plugin-coverage/src/lib/config.ts
 import { z as z16 } from "zod";
@@ -1212,7 +1217,7 @@ async function coveragePlugin(config) {
 
 // packages/plugin-coverage/src/lib/nx/coverage-paths.ts
 import chalk6 from "chalk";
-import { join as join4 } from "node:path";
+import { isAbsolute, join as join4 } from "node:path";
 async function getNxCoveragePaths(targets = ["test"], verbose) {
   if (verbose) {
     ui().logger.info(
@@ -1228,12 +1233,7 @@ async function getNxCoveragePaths(targets = ["test"], verbose) {
       );
       return await Promise.all(
         relevantNodes.map(async ({ name: name2, data }) => {
-          const targetConfig = data.targets?.[target];
-          const coveragePaths = await getCoveragePathsForTarget(
-            targetConfig,
-            data.root,
-            `${target} in ${name2}`
-          );
+          const coveragePaths = await getCoveragePathsForTarget(data, target);
           if (verbose) {
             ui().logger.info(`- ${name2}: ${target}`);
           }
@@ -1250,57 +1250,94 @@ async function getNxCoveragePaths(targets = ["test"], verbose) {
 function hasNxTarget(project, target) {
   return project.data.targets != null && target in project.data.targets;
 }
-async function getCoveragePathsForTarget(targetConfig, pathToRoot, targetContext) {
-  const { config } = targetConfig.options;
+async function getCoveragePathsForTarget(project, target) {
+  const targetConfig = project.targets?.[target];
+  if (!targetConfig) {
+    throw new Error(
+      `No configuration found for target ${target} in project ${project.name}`
+    );
+  }
   if (targetConfig.executor?.includes("@nx/vite")) {
-    return await getCoveragePathForVitest(config, pathToRoot, targetContext);
+    return getCoveragePathForVitest(
+      targetConfig.options,
+      project,
+      target
+    );
   }
   if (targetConfig.executor?.includes("@nx/jest")) {
-    return await getCoveragePathForJest(config, pathToRoot, targetContext);
+    return getCoveragePathForJest(
+      targetConfig.options,
+      project,
+      target
+    );
   }
   throw new Error(
-    `Unsupported executor ${targetConfig.executor}. @nx/vite and @nx/jest are currently supported.`
+    `Unsupported executor ${targetConfig.executor}. Only @nx/vite and @nx/jest are currently supported.`
   );
 }
-async function getCoveragePathForVitest(pathToConfig, pathToRoot, context) {
-  const vitestConfig = await importEsmModule({
-    filepath: pathToConfig,
+async function getCoveragePathForVitest(options, project, target) {
+  const {
+    default: { normalizeViteConfigFilePathWithTree }
+  } = await import("@nx/vite");
+  const config = normalizeViteConfigFilePathWithTree(
+    // HACK: only tree.exists is called, so injecting existSync from node:fs instead
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions, n/no-sync
+    { exists: (await import("node:fs")).existsSync },
+    project.root,
+    options.configFile
+  );
+  if (!config) {
+    throw new Error(
+      `Could not find Vitest config file for target ${target} in project ${project.name}`
+    );
+  }
+  const vitestConfig = await importModule({
+    filepath: config,
     format: "esm"
   });
-  const reportsDirectory = vitestConfig.test.coverage?.reportsDirectory;
+  const reportsDirectory = options.reportsDirectory ?? vitestConfig.test.coverage?.reportsDirectory;
   const reporter = vitestConfig.test.coverage?.reporter;
   if (reportsDirectory == null) {
     throw new Error(
-      `Vitest coverage configuration at ${pathToConfig} does not include coverage path for target ${context}. Add the path under coverage > reportsDirectory.`
+      `Vitest coverage configuration at ${config} does not include coverage path for target ${target} in project ${project.name}. Add the path under coverage > reportsDirectory.`
     );
   }
   if (!reporter?.includes("lcov")) {
     throw new Error(
-      `Vitest coverage configuration at ${pathToConfig} does not include LCOV report format for target ${context}. Add 'lcov' format under coverage > reporter.`
+      `Vitest coverage configuration at ${config} does not include LCOV report format for target ${target} in project ${project.name}. Add 'lcov' format under coverage > reporter.`
     );
   }
+  if (isAbsolute(reportsDirectory)) {
+    return join4(reportsDirectory, "lcov.info");
+  }
   return {
-    pathToProject: pathToRoot,
-    resultsPath: join4(pathToRoot, reportsDirectory, "lcov.info")
+    pathToProject: project.root,
+    resultsPath: join4(project.root, reportsDirectory, "lcov.info")
   };
 }
-async function getCoveragePathForJest(pathToConfig, pathToRoot, context) {
-  const testConfig = await importEsmModule({
-    filepath: pathToConfig,
-    format: "cjs"
+async function getCoveragePathForJest(options, project, target) {
+  const { jestConfig } = options;
+  const testConfig = await importModule({
+    filepath: jestConfig
   });
-  const coverageDirectory = testConfig.coverageDirectory;
+  const { coverageDirectory, coverageReporters } = {
+    ...testConfig,
+    ...options
+  };
   if (coverageDirectory == null) {
     throw new Error(
-      `Jest coverage configuration at ${pathToConfig} does not include coverage path for target ${context}. Add the path under coverageDirectory.`
+      `Jest coverage configuration at ${jestConfig} does not include coverage path for target ${target} in ${project.name}. Add the path under coverageDirectory.`
     );
   }
-  if (!testConfig.coverageReporters?.includes("lcov")) {
+  if (!coverageReporters?.includes("lcov") && !("preset" in testConfig)) {
     throw new Error(
-      `Jest coverage configuration at ${pathToConfig} does not include LCOV report format for target ${context}. Add 'lcov' format under coverageReporters.`
+      `Jest coverage configuration at ${jestConfig} does not include LCOV report format for target ${target} in ${project.name}. Add 'lcov' format under coverageReporters.`
     );
   }
-  return join4(pathToRoot, coverageDirectory, "lcov.info");
+  if (isAbsolute(coverageDirectory)) {
+    return join4(coverageDirectory, "lcov.info");
+  }
+  return join4(project.root, coverageDirectory, "lcov.info");
 }
 
 // packages/plugin-coverage/src/index.ts

package/package.json

@@ -1,19 +1,27 @@
 {
   "name": "@code-pushup/coverage-plugin",
-  "version": "0.46.0",
+  "version": "0.47.0",
   "dependencies": {
-    "@code-pushup/models": "0.46.0",
-    "@code-pushup/utils": "0.46.0",
+    "@code-pushup/models": "0.47.0",
+    "@code-pushup/utils": "0.47.0",
     "parse-lcov": "^1.0.4",
     "chalk": "^5.3.0",
     "zod": "^3.22.4"
   },
   "peerDependencies": {
-    "@nx/devkit": "^17.0.0 || ^18.0.0 || ^19.0.0"
+    "@nx/devkit": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "@nx/jest": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "@nx/vite": "^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "peerDependenciesMeta": {
     "@nx/devkit": {
       "optional": true
+    },
+    "@nx/jest": {
+      "optional": true
+    },
+    "@nx/vite": {
+      "optional": true
     }
   },
   "license": "MIT",

package/src/lib/nx/coverage-paths.d.ts

@@ -1,4 +1,6 @@
-import type { TargetConfiguration } from '@nx/devkit';
+import type { ProjectConfiguration } from '@nx/devkit';
+import type { JestExecutorOptions } from '@nx/jest/src/executors/jest/schema';
+import type { VitestExecutorOptions } from '@nx/vite/executors';
 import { CoverageResult } from '../config';
 /**
  * @param targets nx targets to be used for measuring coverage, test by default
@@ -17,9 +19,9 @@ export type JestCoverageConfig = {
     coverageDirectory?: string;
     coverageReporters?: string[];
 };
-export declare function getCoveragePathsForTarget(targetConfig: TargetConfiguration, pathToRoot: string, targetContext: string): Promise<CoverageResult>;
-export declare function getCoveragePathForVitest(pathToConfig: string, pathToRoot: string, context: string): Promise<{
+export declare function getCoveragePathsForTarget(project: ProjectConfiguration, target: string): Promise<CoverageResult>;
+export declare function getCoveragePathForVitest(options: VitestExecutorOptions, project: ProjectConfiguration, target: string): Promise<string | {
     pathToProject: string;
     resultsPath: string;
 }>;
-export declare function getCoveragePathForJest(pathToConfig: string, pathToRoot: string, context: string): Promise<string>;
+export declare function getCoveragePathForJest(options: JestExecutorOptions, project: ProjectConfiguration, target: string): Promise<string>;