@code-pushup/coverage-plugin 0.17.0 → 0.18.0

package/README.md

@@ -36,7 +36,7 @@ Measured coverage types are mapped to Code PushUp audits in the following way
      plugins: [
        // ...
        await coveragePlugin({
-         reports: [{ resultsPath: 'coverage/lcov.info' }],
+         reports: ['coverage/lcov.info'],
          coverageToolCommand: {
            command: 'npx',
            args: ['jest', '--coverage', '--coverageReporters=lcov'],
@@ -119,8 +119,9 @@ It recognises the following entities:
 The plugin accepts the following parameters:
 
 - `coverageTypes`: An array of types of coverage that you wish to track. Supported values: `function`, `branch`, `line`. Defaults to all available types.
-- `reports`: Array of information about files with code coverage results - paths to results, path to project root the results belong to. LCOV format is supported for now.
-  - If you have an Nx monorepo, you can adjust our helper function `getNxCoveragePaths` to get the path information automatically.
+- `reports`: Array of information about files with code coverage results. LCOV format is supported for now.
+  - For a single project, providing paths to results as strings is enough.
+  - If you have a monorepo, both path to results (`resultsPath`) and path from the root to project the results belong to (`pathToProject`) need to be provided for the LCOV format. For Nx monorepos, you can use our helper function `getNxCoveragePaths` to get the path information automatically.
 - (optional) `coverageToolCommand`: If you wish to run your coverage tool to generate the results first, you may define it here.
 - (optional) `perfectScoreThreshold`: If your coverage goal is not 100%, you may define it here in range 0-1. Any score above the defined threshold will be given the perfect score. The value will stay unaffected.
 

package/bin.js

@@ -803,11 +803,12 @@ async function lcovResultsToAuditOutputs(results, coverageTypes) {
 async function parseLcovFiles(results) {
   const parsedResults = await Promise.all(
     results.map(async (result) => {
-      const lcovFileContent = await readTextFile(result.resultsPath);
+      const resultsPath = typeof result === "string" ? result : result.resultsPath;
+      const lcovFileContent = await readTextFile(resultsPath);
       const parsedRecords = parseLcov(toUnixNewlines(lcovFileContent));
       return parsedRecords.map((record) => ({
         ...record,
-        file: result.pathToProject == null ? record.file : join3(result.pathToProject, record.file)
+        file: typeof result === "string" || result.pathToProject == null ? record.file : join3(result.pathToProject, record.file)
       }));
     })
   );

package/index.js

@@ -592,17 +592,24 @@ import chalk4 from "chalk";
 
 // packages/plugin-coverage/package.json
 var name = "@code-pushup/coverage-plugin";
-var version = "0.17.0";
+var version = "0.18.0";
 
 // packages/plugin-coverage/src/lib/config.ts
 import { z as z13 } from "zod";
 var coverageTypeSchema = z13.enum(["function", "branch", "line"]);
-var coverageResultSchema = z13.object({
-  resultsPath: z13.string().includes("lcov"),
-  pathToProject: z13.string({
-    description: "Path from workspace root to project root. Necessary for LCOV reports."
-  }).optional()
-});
+var coverageResultSchema = z13.union([
+  z13.object({
+    resultsPath: z13.string({
+      description: "Path to coverage results for Nx setup."
+    }).includes("lcov"),
+    pathToProject: z13.string({
+      description: "Path from workspace root to project root. Necessary for LCOV reports which provide a relative path."
+    }).optional()
+  }),
+  z13.string({
+    description: "Path to coverage results for a single project setup."
+  }).includes("lcov")
+]);
 var coveragePluginConfigSchema = z13.object({
   coverageToolCommand: z13.object({
     command: z13.string({ description: "Command to run coverage tool." }).min(1),

package/package.json

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

package/src/lib/config.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 export declare const coverageTypeSchema: z.ZodEnum<["function", "branch", "line"]>;
 export type CoverageType = z.infer<typeof coverageTypeSchema>;
-export declare const coverageResultSchema: z.ZodObject<{
+export declare const coverageResultSchema: z.ZodUnion<[z.ZodObject<{
     resultsPath: z.ZodString;
     pathToProject: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -10,7 +10,7 @@ export declare const coverageResultSchema: z.ZodObject<{
 }, {
     resultsPath: string;
     pathToProject?: string | undefined;
-}>;
+}>, z.ZodString]>;
 export type CoverageResult = z.infer<typeof coverageResultSchema>;
 export declare const coveragePluginConfigSchema: z.ZodObject<{
     coverageToolCommand: z.ZodOptional<z.ZodObject<{
@@ -24,7 +24,7 @@ export declare const coveragePluginConfigSchema: z.ZodObject<{
         args?: string[] | undefined;
     }>>;
     coverageTypes: z.ZodDefault<z.ZodArray<z.ZodEnum<["function", "branch", "line"]>, "many">>;
-    reports: z.ZodArray<z.ZodObject<{
+    reports: z.ZodArray<z.ZodUnion<[z.ZodObject<{
         resultsPath: z.ZodString;
         pathToProject: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
@@ -33,24 +33,24 @@ export declare const coveragePluginConfigSchema: z.ZodObject<{
     }, {
         resultsPath: string;
         pathToProject?: string | undefined;
-    }>, "many">;
+    }>, z.ZodString]>, "many">;
     perfectScoreThreshold: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     coverageTypes: ("function" | "branch" | "line")[];
-    reports: {
+    reports: (string | {
         resultsPath: string;
         pathToProject?: string | undefined;
-    }[];
+    })[];
     coverageToolCommand?: {
         command: string;
         args?: string[] | undefined;
     } | undefined;
     perfectScoreThreshold?: number | undefined;
 }, {
-    reports: {
+    reports: (string | {
         resultsPath: string;
         pathToProject?: string | undefined;
-    }[];
+    })[];
     coverageToolCommand?: {
         command: string;
         args?: string[] | undefined;