create-merged-coverage-reports 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2023-12-01)
+
+
+### Features
+
+* initial commit 842d16c

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aliaksandr Haurusiou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# create-merged-coverage-reports
+
+Combine multiple coverage reports into a single merged one
+
+## Installation
+
+```bash
+npm i -D create-merged-coverage-reports
+```
+
+## Usage
+
+First, configure your testing framework to output either [`json`](https://istanbul.js.org/docs/advanced/alternative-reporters/#json), or, if you are running tests on multiple machines, [`relative-paths-istanbul-json-report`](https://github.com/alexgavrusev/relative-paths-istanbul-json-report#readme), coverage reports
+
+Then, merge your coverage reports using either the CLI, or the API
+
+### CLI
+
+```
+$ npx create-merged-coverage-reports@latest --help
+
+Usage: create-merged-coverage-reports [options]
+
+Create merged coverage reports
+
+Options:
+  -v, --version                   output the version number
+  -c, --coverageFileGlob <glob>   Glob to get all json coverage files
+  -o, --outputDirectory <dir>     Directory where all merged coverage reports
+  -r, --reporters <reporters...>  Which reporters (either built-in, or custom) to use to generate the merged coverage
+                                  reports
+  -h, --help                      display help for command
+```
+
+### API
+
+```ts
+import { createMergedCoverageReports } from 'create-merged-coverage-reports';
+
+async function main() {
+  await createMergedCoverageReports();
+}
+
+main();
+```
+
+## Building
+
+Run `nx build create-merged-coverage-reports` to build the library.
+
+## Running unit tests
+
+Run `nx test create-merged-coverage-reports` to execute the unit tests.
+
+## License
+
+MIT © Aliaksandr Haurusiou.

package/bin.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/bin";

package/bin.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./bin.cjs.js').default;

package/bin.cjs.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+'use strict';
+
+var cliProgram = require('./lib/cli-program.cjs.js');
+
+const main = async ()=>{
+    const program = await cliProgram.createProgram();
+    program.parse();
+};
+main().catch((e)=>{
+    console.error(e);
+    process.exit(1);
+});

package/bin.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './bin.cjs.js';
+export { _default as default } from './bin.cjs.default.js';

package/bin.esm.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { createProgram } from './lib/cli-program.esm.js';
+
+const main = async ()=>{
+    const program = await createProgram();
+    program.parse();
+};
+main().catch((e)=>{
+    console.error(e);
+    process.exit(1);
+});

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var createMergedCoverageReports = require('./lib/create-merged-coverage-reports.cjs.js');
+
+
+
+exports.createMergedCoverageReports = createMergedCoverageReports.createMergedCoverageReports;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.esm.js

@@ -0,0 +1 @@
+export { createMergedCoverageReports } from './lib/create-merged-coverage-reports.esm.js';

package/lib/cli-program.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var commander = require('commander');
+var tsimportlib = require('tsimportlib');
+var createMergedCoverageReports = require('./create-merged-coverage-reports.cjs.js');
+
+const createProgram = async ({ exitOverride = false } = {})=>{
+    const program = new commander.Command();
+    if (exitOverride) {
+        program.exitOverride();
+    }
+    const { readPackageUp } = await tsimportlib.dynamicImport(require.resolve('read-package-up'), module);
+    const { packageJson: { name, version, description } } = await readPackageUp({
+        cwd: __dirname
+    });
+    program.name(name).description(description).version(version, '-v, --version').option('-c, --coverageFileGlob <glob>', 'Glob to get all json coverage files').option('-o, --outputDirectory <dir>', 'Directory where all merged coverage reports').option('-r, --reporters <reporters...>', 'Which reporters (either built-in, or custom) to use to generate the merged coverage reports').action((options)=>{
+        return createMergedCoverageReports.createMergedCoverageReports(options);
+    });
+    return program;
+};
+
+exports.createProgram = createProgram;

package/lib/cli-program.esm.js

@@ -0,0 +1,20 @@
+import { Command } from 'commander';
+import { dynamicImport } from 'tsimportlib';
+import { createMergedCoverageReports } from './create-merged-coverage-reports.esm.js';
+
+const createProgram = async ({ exitOverride = false } = {})=>{
+    const program = new Command();
+    if (exitOverride) {
+        program.exitOverride();
+    }
+    const { readPackageUp } = await dynamicImport(require.resolve('read-package-up'), module);
+    const { packageJson: { name, version, description } } = await readPackageUp({
+        cwd: __dirname
+    });
+    program.name(name).description(description).version(version, '-v, --version').option('-c, --coverageFileGlob <glob>', 'Glob to get all json coverage files').option('-o, --outputDirectory <dir>', 'Directory where all merged coverage reports').option('-r, --reporters <reporters...>', 'Which reporters (either built-in, or custom) to use to generate the merged coverage reports').action((options)=>{
+        return createMergedCoverageReports(options);
+    });
+    return program;
+};
+
+export { createProgram };

package/lib/create-merged-coverage-reports.cjs.js

@@ -0,0 +1,72 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var path = require('path');
+var istanbulLibCoverage = require('istanbul-lib-coverage');
+var istanbulLibReport = require('istanbul-lib-report');
+var istanbulReports = require('istanbul-reports');
+var fsExtra = require('fs-extra');
+var tsimportlib = require('tsimportlib');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var path__namespace = /*#__PURE__*/_interopNamespace(path);
+
+const getGlobby = ()=>tsimportlib.dynamicImport(require.resolve('globby'), module);
+const normalizeOptions = (options)=>{
+    const { coverageFileGlob = 'coverage/**/coverage-final.json', outputDirectory = path__namespace.join('coverage', 'merged'), reporters = [
+        'json'
+    ] } = options;
+    return {
+        coverageFileGlob,
+        outputDirectory,
+        reporters
+    };
+};
+const createMergedCoverageReports = async (options = {})=>{
+    const { coverageFileGlob, outputDirectory, reporters } = normalizeOptions(options);
+    const { globby } = await getGlobby();
+    const jsonFilePaths = await globby([
+        coverageFileGlob,
+        `!${outputDirectory}/**/*`
+    ]);
+    if (jsonFilePaths.length === 0) {
+        throw new Error(`No coverage reports found with the ${coverageFileGlob} glob`);
+    }
+    const mergedMap = istanbulLibCoverage.createCoverageMap();
+    for (const jsonFilePath of jsonFilePaths){
+        const coverageJson = await fsExtra.readJson(// ensure absolute path, otherwise ENOENT error happens
+        path__namespace.resolve(jsonFilePath));
+        mergedMap.merge(coverageJson);
+    }
+    const reportGenerationContext = istanbulLibReport.createContext({
+        dir: outputDirectory,
+        defaultSummarizer: 'nested',
+        coverageMap: mergedMap
+    });
+    reporters.forEach((reporter)=>{
+        const report = istanbulReports.create(// HACK: may be a custom reporter
+        reporter);
+        report.execute(reportGenerationContext);
+    });
+    console.log(`Generated ${reporters.join(', ')} reports to ${outputDirectory}`);
+};
+
+exports.createMergedCoverageReports = createMergedCoverageReports;

package/lib/create-merged-coverage-reports.esm.js

@@ -0,0 +1,48 @@
+import * as path from 'path';
+import { createCoverageMap } from 'istanbul-lib-coverage';
+import { createContext } from 'istanbul-lib-report';
+import { create } from 'istanbul-reports';
+import { readJson } from 'fs-extra';
+import { dynamicImport } from 'tsimportlib';
+
+const getGlobby = ()=>dynamicImport(require.resolve('globby'), module);
+const normalizeOptions = (options)=>{
+    const { coverageFileGlob = 'coverage/**/coverage-final.json', outputDirectory = path.join('coverage', 'merged'), reporters = [
+        'json'
+    ] } = options;
+    return {
+        coverageFileGlob,
+        outputDirectory,
+        reporters
+    };
+};
+const createMergedCoverageReports = async (options = {})=>{
+    const { coverageFileGlob, outputDirectory, reporters } = normalizeOptions(options);
+    const { globby } = await getGlobby();
+    const jsonFilePaths = await globby([
+        coverageFileGlob,
+        `!${outputDirectory}/**/*`
+    ]);
+    if (jsonFilePaths.length === 0) {
+        throw new Error(`No coverage reports found with the ${coverageFileGlob} glob`);
+    }
+    const mergedMap = createCoverageMap();
+    for (const jsonFilePath of jsonFilePaths){
+        const coverageJson = await readJson(// ensure absolute path, otherwise ENOENT error happens
+        path.resolve(jsonFilePath));
+        mergedMap.merge(coverageJson);
+    }
+    const reportGenerationContext = createContext({
+        dir: outputDirectory,
+        defaultSummarizer: 'nested',
+        coverageMap: mergedMap
+    });
+    reporters.forEach((reporter)=>{
+        const report = create(// HACK: may be a custom reporter
+        reporter);
+        report.execute(reportGenerationContext);
+    });
+    console.log(`Generated ${reporters.join(', ')} reports to ${outputDirectory}`);
+};
+
+export { createMergedCoverageReports };

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "create-merged-coverage-reports",
+  "version": "0.1.0",
+  "description": "Create merged coverage reports",
+  "license": "MIT",
+  "private": false,
+  "author": "Alex Gavrusev <alex@gavrusev.dev>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alexgavrusev/create-merged-coverage-reports.git"
+  },
+  "homepage": "https://github.com/alexgavrusev/create-merged-coverage-reports#readme",
+  "bugs": {
+    "url": "https://github.com/alexgavrusev/create-merged-coverage-reports/issues"
+  },
+  "bin": "./bin.cjs.js",
+  "scripts": {
+    "prepare": "node -e \"if(require('fs').existsSync('.git')){/* proceed only if .git is found */ process.exit(1)}\" || is-ci || husky install"
+  },
+  "dependencies": {
+    "@swc/helpers": "~0.5.2",
+    "commander": "^11.1.0",
+    "fs-extra": "^11.2.0",
+    "globby": "^14.0.0",
+    "istanbul-lib-coverage": "^3.2.2",
+    "istanbul-lib-report": "^3.0.1",
+    "istanbul-reports": "^3.1.6",
+    "read-package-up": "^11.0.0",
+    "tsimportlib": "^0.0.5"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.0.0",
+    "@commitlint/config-conventional": "^17.0.0",
+    "@gvrs-nx/ts-package": "0.3.0",
+    "@jscutlery/semver": "^4.1.0",
+    "@nx/eslint": "17.1.3",
+    "@nx/eslint-plugin": "17.1.3",
+    "@nx/js": "17.1.3",
+    "@nx/rollup": "17.1.3",
+    "@nx/vite": "17.1.3",
+    "@nx/workspace": "17.1.3",
+    "@swc-node/register": "~1.6.7",
+    "@swc/cli": "~0.1.62",
+    "@swc/core": "~1.3.85",
+    "@types/fs-extra": "^11.0.4",
+    "@types/istanbul-lib-coverage": "^2.0.6",
+    "@types/istanbul-lib-report": "^3.0.3",
+    "@types/istanbul-reports": "^3.0.4",
+    "@types/node": "18.7.1",
+    "@types/tmp": "^0.2.6",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "@vitest/coverage-v8": "~0.34.6",
+    "@vitest/ui": "~0.34.6",
+    "eslint": "~8.46.0",
+    "eslint-config-prettier": "^9.0.0",
+    "husky": "^8.0.0",
+    "is-ci": "^3.0.0",
+    "nx": "17.1.3",
+    "prettier": "^2.6.2",
+    "rollup-plugin-preserve-shebang": "1.0.1",
+    "tmp": "^0.2.1",
+    "tslib": "^2.3.0",
+    "typescript": "~5.2.2",
+    "verdaccio": "^5.0.4",
+    "vite": "~4.3.9",
+    "vitest": "~0.34.6"
+  },
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    },
+    "./bin": {
+      "module": "./bin.esm.js",
+      "import": "./bin.cjs.mjs",
+      "default": "./bin.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
+}

package/src/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/create-merged-coverage-reports';

package/src/lib/cli-program.d.ts

@@ -0,0 +1,4 @@
+import { Command } from 'commander';
+export declare const createProgram: ({ exitOverride }?: {
+    exitOverride?: boolean;
+}) => Promise<Command>;

package/src/lib/create-merged-coverage-reports.d.ts

@@ -0,0 +1,26 @@
+type CreateMergedCoverageReportsOptions = {
+    /**
+     * Glob to get all json coverage files
+     *
+     * @default 'coverage/** /coverage-final.json'
+     */
+    coverageFileGlob?: string;
+    /**
+     * Directory where all merged coverage reports
+     *
+     * Note that this directory will be excluded from the coverage files lookup
+     *
+     * @default 'coverage/merged'
+     */
+    outputDirectory?: string;
+    /**
+     * Which reporters (either built-in, or custom) to use to generate the merged coverage reports
+     *
+     * @see https://istanbul.js.org/docs/advanced/alternative-reporters
+     *
+     * @default ['json']
+     */
+    reporters?: string[];
+};
+export declare const createMergedCoverageReports: (options?: CreateMergedCoverageReportsOptions) => Promise<void>;
+export {};