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

jest-coverage-shield

v1.1.2

Published

Auto creates jest coverage shield from shield.io

Downloads

162

Readme

coverage-badger

This is a fork of coverage-badger. This is much faster but more locked down method that leverages off pre-downloaded svgs instead of downloading from shield.io every time. Also fixes some bugs.

coverage

Creates a coverage badge by reading the Clover XML coverage report using https://github.com/badges/shields.

  • The badge displays appropriate colors for the badge.
  • Green: >= 90% overall coverage
  • Yellow: 65% <= overall coverage < 90%
  • Red: < 65% overall coverage

Installation

npm install --save-dev jest-coverage-shield

NPM Script

coverage-badger can be run as a NPM script.

Example:

"scripts": {
  "test": "jest && coverage-shield"
}

CLI

You can now use the CLI to create the badge for a XML Clover report.

The CLI prints the following help:

$ ./node_modules/jest-coverage-shield/lib/cli.js

  Usage: cli [options]

  Generates a badge for a given Clover XML report

  Options:

    -h, --help                          output usage information
    -V, --version                       output the version number
    -e, --excellentThreshold <n>        The threshold for green badges, where coverage >= -e
    -g, --goodThreshold <n>             The threshold for yellow badges, where -g <= coverage < -e
    -b, --badgeFileName <badge>         The badge file name that will be saved.
    -r, --reportFile <report>           The Clover XML file path.
    -d, --destinationDir <destination>  The directory where 'coverage.svg' will be generated at.
  Examples:

    $ coverage-badger -e 90 -g 65 -r coverage/clover.xml -d coverage/
      * Green: coverage >= 90
      * Yellow: 65 <= coverage < 90
      * Red: coverage < 65
      * Created at the coverage directory from the given report.