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

wdio-mocha-emailable-reporter

v1.2.7

Published

A WebdriverIO plugin. Generates emailable report

Downloads

531

Readme

WDIO Mocha Emailable Reporter

Generates test results in the a single page emailable HTML. Inspired by wdio-mochawesome-reporter, this is pretty much a clone with the exception of generating a single page HTML report instead of merged json file.

Bug on WDIO v7

Webdriverio v7, Multiremote feature has a bug triggering onRunnerEnd if an error occurs when it is closing a session.

This is bypass by using onSuiteEnd, instead, to write the output file. Please be mindful of this and only have 1 suite. This is only for v1.2.0.

Installation

  • NPM
npm install wdio-mocha-emailable-reporter --save-dev

Configuration

Import

import WdioMochaEmailableReporter from 'wdio-mocha-emailable-reporter';

Results to File

reporters: [
  ['WdioMochaEmailableReporter',{
      outputDir: './Results'
  }]
],

Results to File with custom file name

reporters: [
  ['WdioMochaEmailableReporter',{
    outputDir: './Results',
    outputFileFormat: function(opts) {
        return `results-${opts.cid}.${opts.capabilities}.json`
    }
  }]
],

Result Files

Command line

As part of a wdio hook

The onComplete is a great place to call the renderHtml script. Usage this way requires passing in the results directory and the file pattern as arguments to the script.

// Located in your wdio.conf.js file
onComplete: function (exitCode, config, capabilities, results) {
  const renderHtml = require('wdio-mocha-emailable-reporter/renderHtml');
  renderHtml('./mocha-results', 'wdio-*');
}

Upon completion, the result script will output a single html file named result.html in the provided <RESULTS_DIR>

Custom variable

Custom variable can be included in the result html by creating mocha-emailable.properties file in the project root. Additionally, environment variable can also be used in real time.

// Set environment variable
export BASE_URL=http://www.test.com

// Properties file
NAME=Test
BASE_URL=${BASE_URL}

Custom comments

Comments can be added to the report by using the addComment event.

import WdioMochaEmailableReporter from 'wdio-mocha-emailable-reporter';

WdioMochaEmailableReporter.addComment('test')