# @klenty/gunner

> Zero magic, fast test-runner and assertion framework. No magic globals.

Latest version **0.11.11** (published 2018-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @klenty/gunner
pnpm add @klenty/gunner
yarn add @klenty/gunner
bun add @klenty/gunner
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.11.11 |
| Published | 2018-09-26 |
| First published | 2018-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 276.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Muthu Kumar |
| Maintainers | mkrhere |
| Keywords | klenty, gunner, test, tdd, unit testing |

## Links

- npm: https://www.npmjs.com/package/@klenty/gunner
- Repository: https://github.com/klenty/gunner
- Homepage: https://github.com/klenty/gunner#readme
- Issues: https://github.com/klenty/gunner/issues
- npm.io page: https://npm.io/package/@klenty/gunner

## Dependencies (4)

- [jsontoxml](https://npm.io/package/jsontoxml.md) ^1.0.0
- [@codefeathers/iseq](https://npm.io/package/@codefeathers/iseq.md) ^1.2.1
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) ^5.0.1
- [@codefeathers/promise.object](https://npm.io/package/@codefeathers/promise.object.md) ^0.9.5

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.11.11 (latest) — 2018-09-26
- 0.11.10 — 2018-09-26
- 0.11.9 — 2018-09-26
- 0.11.8 — 2018-09-25
- 0.11.7 — 2018-09-25
- 0.11.6 — 2018-09-25
- 0.11.5 — 2018-09-25
- 0.11.4 — 2018-09-25
- 0.11.3 — 2018-09-25
- 0.11.2 — 2018-09-24
- 0.11.1 — 2018-09-24
- 0.10.7 — 2018-09-18
- 0.10.6 — 2018-09-18
- 0.10.5 — 2018-09-18
- 0.10.4 — 2018-09-17
- … 9 more at https://npm.io/package/@klenty/gunner/versions

## README

# Gunner

<img alt="Django Unchained" src="https://raw.githubusercontent.com/klenty/Gunner/master/assets/gun.jpeg" height="350" />

#### _Tiny, but fully loaded._

> Gunner is a zero magic, fast test-runner and assertion framework. There are no magic globals or CLI specific interface.

## Requirements & Usage

`Gunner` uses very modern JavaScript, and hence requires **node 10+** ❗️⚠️ currently.

Create a new `Gunner` instance and simply write your tests. The assertion methods are passed in as the callback as an `expect` object to the test function.

```JavaScript
const { Gunner, expect } = require('@klenty/gunner');
// Create new instance
const gunner = new Gunner();

// Define tests
gunner.test('arrays are equal', () => {
	return expect([1, 2,]).deepEqual([1 ,2]);
});

// Starts the runner
gunner.run();
```

## Documentation

- ### `Class`:
	- #### [`Gunner.constructor`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#new-gunner-options)

- ### `Methods`:
	- #### [`Gunner#test`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#gunnertest-title-implementation)
	- #### [`Gunner#before`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#gunnerbefore-title-implementation)
	- #### [`Gunner#after`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#gunnerafter-title-implementation)
	- #### [`Gunner#run`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#gunnerrun-options)

- ### `Constants`:
	- #### `[Gunner.Start]`
	- #### `[Gunner.End]`

- ### [`State and Advanced Usage`](https://github.com/klenty/Gunner/blob/master/DOCUMENTATION.md#state)

## Credits

`Gunner` was built by Muthu Kumar [(@MKRhere)](https://github.com/MKRhere) at [Klenty](https://klenty.com), a sales automation startup.

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