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

nightwatch-coverage

v1.0.4

Published

Coverage collection utility for [nightwatch.js](https://nightwatchjs.org/)

Downloads

287

Readme

nightwatch-coverage

Coverage collection utility for nightwatch.js

Inspired by munkyjunky's gist

Setup

Before using this module, you must be running tests on instrumented code. This module does not do that for you.

There are a few ways for you to do that:

Once you have successfully instrumented your code, you should have a window.__coverage__ object available in the global scope of your website. This is the object that contains all coverage information for your website, and it is what this module will use to measure coverage.

Installation

npm i nightwatch-coverage --save-dev
# OR
yarn add nightwatch-coverage -D

Usage

1. Register nightwatch-coverage custom commands

// nightwatch.config.js
module.exports = {
    custom_commands_path: [
        'your/custom/commands',
        'node_modules/nightwatch-coverage/commands',
    ]
}

2. Configure and add the coverageReporter to your globals file

// globals.js
const { createCoverageReporter } = require('nightwatch-coverage');

const coverageReporter = createCoverageReporter({/* options */});

module.exports = {
    coverageReporter, // this needs to be added to your globals so that the custom command can access it
    after(done) {
        coverageReporter.save(); // call this function in your global after hook 
        done();
    },
}

See more about configuring the coverage reporter in the options section.

3. Collect coverage

Call collectCoverage whenever you want to collect coverage.

You can do this in an afterEach hook:

// globals.js
module.exports = {
    afterEach(browser, done) {
        // this will not work if you call `client.end` in your test
        browser.collectCoverage(function () {
            client.end(done);
        });
    },
}

Or you can do this directly in your test:

module.exports = {
    'My test'(browser) {
        browser
            .waitForElementVisible('button')
            .click('button')
            .collectCoverage();
    }
}

Options

The createCoverageReporter function accepts an object with the following options. For information on the defaults you can check options.js

| name | type | description | | - | - | - | | coverageDirectory | string | Directory in which to save the coverage report | | coverageReporters | array | A list of desired reporter formats | | coverageVariable | string | The variable containing the coverage data that should be extracted from the website | | parseCoverageData | function | A function to parse/clean/filter the coverage data extracted from the website |

Known limitations

Does not work with tests running in parallel

Because of the way we store coverage data in globals between test runs, there is no way to access that data in the global after hook when running tests in parallel. I could not find a way to workaround this limitation.

Issues with page change/refresh

If you only use the custom command inside the global afterEach hook, and there is a page refresh/change inside the test case, then the coverage from anything before that refresh/change is not collected.

This can be mitigated by collecting coverage also within the test cases themselves, before triggering the page refresh/change.