npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@phenax/coveralls-merge

v1.0.2

Published

All in one tool for managing coverage reports for Coveralls

Downloads

28

Readme

coveralls-merge

A tool that can be used to parse test coverage results, merge reports together, and POST them to coveralls.io.

The Problem

Coveralls is a great service that allows you to easily display test coverage results for a codebase. Integration is usually painless, as there are several supported languages, and a bunch of user-written modules that can simplify the process of sending your test coverage data to Coveralls.

However, most of these modules work off the assumption that your codebase only uses one language, which may not always be the case. For example, if you're working on a web application that uses JavaScript for client-sided code, and some other language (Java, Python, Ruby) for server-sided code, and you're interested in displaying coverage reports for both parts of the codebase, then this tool may be for you.

Installation

npm i @sourceallies/coveralls-merge --save-dev

Usage

API

const coveralls = require('@sourceallies/coveralls-merge');

// Create reports and options

coveralls.sendReports(reports, options);

reports is an array of Objects representing a coverage report:

| key | value | required | |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | type | String representing the type of coverage report. See Supported Report Formats | yes | | reportFile | Path to the coverage report file, relative to the project root | yes | | workingDirectory | Path representing the working directory of the coverage report, relative to the project root. This is added as a prefix to the paths specified in the coverage report, and used by Coveralls to determine the location of the source file. The default value is the project root directory. | no |

options is an optional parameter, which is an Object with the following configuration values:

| key | value | default | |-------------|-------------------------------------------------------------------------------|---------| | projectRoot | The root directory of the project, relative to the current working directory. | '.' |

Repo Token

This tool reads the Coveralls repository token from the environment variable COVERALLS_REPO_TOKEN. Failing to set this environment variable will cause the tool to throw an error.

Supported Report Formats

  • LCOV: lcov
  • JaCoCo XML: jacoco

This tool was initially written to support the languages I needed at the time, but it is implemented in a way that makes adding additional formats painless. If the format you need is not currently supported, feel free to open an issue or submit a PR to add it yourself.

License

Apache Public License v2.0