README.md

Nightwatch HTML Reporter template

This package is used internally by the Nightwatch HTML reporter and it's not designed to be used directly.

This Repo contains template for HTML and VRT Reporter.

🏗 Installation

npm install @nightwatch/html-reporter-template

🚀 Usage

const { writeNightwatchHTMLReport } = require('@nightwatch/html-reporter-template');;

/**
 * This function will insert the result object within the HTML **reporter**
 * and add it to the destination folder.
 * The result object will be available in the "window.nightwatchReport" variable.
 *
 */
writeNightwatchHTMLReport(<destFolder>, <destFileName>, <result object>);

Note You can find about more about function here

🐛 Issues

Issues with this Reporter Template can filed here

If you want to contribute (or have contributed in the past), feel free to add yourself to the list of contributors in the package.json before you open a PR!

👨‍💻 Development

Getting started

🛠️ Node.js and npm are required for the scripts. Make sure it's installed on your machine.

⬇️ Install the dependencies for the nightwatch reporter template

npm install

🏃 Run the tool

# To run HTML Reporter
npm run dev:html

# To run VRT Reporter
npm run dev:vrt

👷‍♂️ Build both reporters

npm run build:html
npm run build:vrt

♻️ Clean build files

npm run clean