# @nightwatch/html-reporter-template

> Nightwatch HTML reporter template

Latest version **0.3.0** (published 2024-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nightwatch/html-reporter-template
pnpm add @nightwatch/html-reporter-template
yarn add @nightwatch/html-reporter-template
bun add @nightwatch/html-reporter-template
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2024-01-24 |
| First published | 2022-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Vaibhav Singh |
| Maintainers | garg3133, harshit-bs, swrdfish, gravityvi, beatfactor, vaibhavsingh97, automatedtester |
| Keywords | nightwatch, html-reporter, react, e2e |

## Links

- npm: https://www.npmjs.com/package/@nightwatch/html-reporter-template
- Repository: https://github.com/nightwatchjs/html-reporter
- Homepage: https://github.com/nightwatchjs/html-reporter#readme
- Issues: https://github.com/nightwatchjs/html-reporter/issues
- npm.io page: https://npm.io/package/@nightwatch/html-reporter-template

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2024-01-24
- 0.2.1 — 2023-04-07
- 0.2.0 — 2023-04-04
- 0.1.5 — 2023-04-03
- 0.1.4 — 2023-01-10
- 0.1.3 — 2022-12-23
- 0.1.3-dev.1 — 2022-12-23
- 0.1.3-dev — 2022-12-23
- 0.1.2 — 2022-12-23
- 0.1.2-dev — 2022-12-23
- 0.1.1 — 2022-12-23
- 0.1.0 — 2022-12-22
- 0.0.2 — 2022-12-22
- 0.0.1 — 2022-12-20

## README

# Nightwatch HTML Reporter template

[![npm][npm-badge]][npm]
[![Discord][discord-badge]][discord]

> 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

```sh
npm install @nightwatch/html-reporter-template
```

## 🚀 Usage

```javascript
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](docs/README.md)

## 🐛 Issues

Issues with this Reporter Template can filed [here](https://github.com/nightwatchjs/html-reporter/issues)

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](https://docs.npmjs.com/downloading-and-installing-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

```bash
npm install
```

🏃 **Run** the tool

```bash
# To run HTML Reporter
npm run dev:html

# To run VRT Reporter
npm run dev:vrt
```

👷‍♂️ **Build** both reporters

```bash
npm run build:html
npm run build:vrt
```

### ♻️ Clean build files

```bash
npm run clean
```

[npm-badge]: https://img.shields.io/npm/v/@nightwatch/html-reporter-template.svg
[npm]: https://www.npmjs.com/package/@nightwatch/html-reporter-template
[discord-badge]: https://img.shields.io/discord/618399631038218240.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square
[discord]: https://discord.gg/SN8Da2X

---
_Source: https://npm.io/package/@nightwatch/html-reporter-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._