Table of Contents

• Prerequisite
• Installation
• Usage
• License

Prerequisite

For this Plugin a kind of test framework with coverage (lcov) reporter is needed.

Installation

npm i -D @dash4/plugin-code-coverage

Usage

dash4.config.js

const { PluginCodeCoverage } = require('@dash4/plugin-code-coverage');

async function getConfig() {
  return {
    tabs: [
      {
        title: 'Root',
        rows: [
          [
            new PluginCodeCoverage(),
          ],
        ],
      },
    ],
  };
}

module.exports = getConfig;

options:

// custom title (default=Code coverage)
title?: string;
// current working directory of the child process.
cwd?: string;
// directory of coverage json file (default=coverage/lcov-report/index.html)
lcovHtmlPath?: string;
// define threshold level for [error, warning]
// default:
// branches: [60, 80];
// functions: [60, 80];
// lines: [60, 80];
// statements: [60, 80];
threshold?: {
  branches?: [number, number];
  functions?: [number, number];
  lines?: [number, number];
  statements?: [number, number];
};
// grid with per breakpoint
// [12,6,3] means 100% width on small viewports, 50% on medium viewports and 33.3% on large viewports
width?: number[];
// enable / disable dark mode
dark?: boolean;

License

The @dash4/plugin-code-coverage is MIT licensed