parse-lcov

Parse LCOV.

Full specification: http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php

Installation

yarn add parse-lcov

npm install parse-lcov

API

Usage

import parseLCOV from "parse-lcov";
 
const lcov = `
TN:
SF:source/file.ts
FN:5,functionA
FN:8,functionB
...
`;
 
parseLCOV(lcov);
 
/* Sample Output:
[{
    title: "",
    file: "source/file.ts",
    functions: {
      found: 2,
      hit: 2,
      details: [{
        line: 5,
        hit: 2,
        name: "functionA"
      }, {
        hit: 16,
        line: 8,
        name: "functionB"
      }]
    },
    branches: {
      found: 3,
      hit: 3,
      details: [{
        block: 0,
        branch: 0,
        line: 5,
        taken: 1
      }, {
        block: 1,
        branch: 0,
        line: 9,
        taken: 0
      }]
    },
    lines: {
      found: 13,
      hit: 13,
      details: [{
        hit: 1,
        line: 1
      }]
    }
  }]);
*/

Types

import parseLCOV, { LCOVRecord, FunctionsDetails, BranchesDetails, LinesDetails } from "parse-lcov";
 
function parseLCOV(string?: string): LCOVRecord[];
 
type LCOVRecord = {
  title: string;
  file: string;
  functions: LCOVStats & {
    details: FunctionsDetails[];
  };
  branches: LCOVStats & {
    details: BranchesDetails[];
  };
  lines: LCOVStats & {
    details: LinesDetails[];
  };
}
 
type LCOVStats = {
  found: number;
  hit: number;
}
 
type FunctionsDetails = {
  name: string;
  line: number;
  hit?: number;
}
 
type BranchesDetails = {
  line: number;
  block: number;
  branch: number;
  taken: number;
};
 
type LinesDetails = {
  line: number;
  hit: number;
}

Dev Dependencies

• @bconnorwhite/bob: Bob is a toolkit for TypeScript projects

License

MIT

Related Packages

• parse-json-object: Parse a typed JSON object
• read-lcov-safe: Read and parse an lcov file without try catch