fix(plugin-coverage): convert new lines on Windows for parse-lcov, update docs

Author: Tlacenka

packages/plugin-coverage/README.md

@@ -33,7 +33,7 @@ Measured coverage types are mapped to Code PushUp audits in the following way
      plugins: [
        // ...
        await coveragePlugin({
-         reports: [{ resultsPath: 'coverage/cli/lcov.info', pathToProject: 'packages/cli' }],
+         reports: [{ resultsPath: 'coverage/lcov.info' }],
          coverageToolCommand: {
            command: 'npx',
            args: ['jest', '--coverage', '--coverageReporters=lcov'],

packages/plugin-coverage/src/lib/runner/lcov/runner.ts

@@ -1,7 +1,7 @@
 import { join } from 'node:path';
 import type { LCOVRecord } from 'parse-lcov';
 import { AuditOutputs } from '@code-pushup/models';
-import { exists, readTextFile } from '@code-pushup/utils';
+import { exists, readTextFile, toUnixNewlines } from '@code-pushup/utils';
 import { CoverageReport, CoverageType } from '../../config';
 import { parseLcov } from './parse-lcov';
 import {
@@ -26,7 +26,7 @@ export async function lcovResultsToAuditOutputs(
   const parsedReports = await Promise.all(
     reports.map(async report => {
       const reportContent = await readTextFile(report.resultsPath);
-      const parsedRecords = parseLcov(reportContent);
+      const parsedRecords = parseLcov(toUnixNewlines(reportContent));
       return parsedRecords.map<LCOVRecord>(record => ({
         ...record,
         file:
@@ -36,7 +36,6 @@ export async function lcovResultsToAuditOutputs(
       }));
     }),
   );
-
   if (parsedReports.length !== reports.length) {
     throw new Error('Some provided LCOV reports were not valid.');
   }

packages/utils/src/index.ts

@@ -65,6 +65,7 @@ export {
   toArray,
   toNumberPrecision,
   toOrdinal,
+  toUnixNewlines,
   toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

packages/utils/src/lib/transform.ts

@@ -1,3 +1,5 @@
+import { platform } from 'node:os';
+
 export function toArray<T>(val: T | T[]): T[] {
   return Array.isArray(val) ? val : [val];
 }
@@ -116,6 +118,10 @@ export function toUnixPath(
   return unixPath;
 }
 
+export function toUnixNewlines(text: string): string {
+  return platform() === 'win32' ? text.replace(/\r\n/g, '\n') : text;
+}
+
 export function capitalize<T extends string>(text: T): Capitalize<T> {
   return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
     1,