# mickrigtest

> a minimal testing system for JavaScript

Latest version **0.1.0** (published 2017-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install mickrigtest
pnpm add mickrigtest
yarn add mickrigtest
bun add mickrigtest
```

## 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.1.0 |
| Published | 2017-02-24 |
| First published | 2017-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mathias Karstädt |
| Maintainers | webmatze |
| Keywords | test, framework |

## Links

- npm: https://www.npmjs.com/package/mickrigtest
- Repository: https://github.com/webmatze/mickrigtest-js
- Homepage: https://github.com/webmatze/mickrigtest-js#readme
- Issues: https://github.com/webmatze/mickrigtest-js/issues
- npm.io page: https://npm.io/package/mickrigtest

## Dependencies (1)

- [coffeescript](https://npm.io/package/coffeescript.md) 2.0.0-alpha1

## 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
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2017-02-24

## README

mickrigtest-js
==============

**MickrigTest.js** is a minimal test system for JavaScript written in CoffeeScript

Installing via npm
------------------

    npm install -g mickrigtest


Compiling the CoffeeScript
--------------------------

Using coffee cli:

    coffee -cb mickrigtest.coffee

Or using a npm task:

    npm run compile


Running Tests
-------------

    npm run test


Usage of mickrigtest.js
-----------------------

require mickrigtest:

    var expect = require('mickrigtest').expect

Then you can test something to be true:

    expect(true).to().beTrue()

Or alternatively:

    expect(true).to().be(true)

You can also test something to be false:

    expect(false).to().beFalse()

Or alternatively:

    expect(false).to().be(false)

You can test something NOT to be something:

    expect(false).notTo().beTrue()

And you can also add a description to your test:

    expect(1 > 2, '1 > 2').to().beFalse()
    
You can test for exceptions. But you have to wrap your code into an anonymous function:

    expect(function() {
        throw "an exception"
    }).to().throwException()
    
Usage of MickrigTestCase
------------------------

You can also build test cases by using the **MickrigTestCase** class.
To use it you have to require *mickrigtestcase.js*, too.

    var MickrigTestCase = require('mickrigtest').MickrigTestCase

Then you can write your first test case:

    testcase = new MickrigTestCase("My first test");
    testcase.test("true should be true", function() {
        expect(true).to().beTrue();
    });
    testcase.test("true should not be false", function() {
        expect(true).notTo().be(false);
    });
    messages = testcase.run();

The *run()* function of **MickrigTestCase** returns an Array of all messages generated by the test case.
You can use this Array to display the messages on your page or displaying them using *console.log()*.
    
    messages.forEach(function(m){console.log(m)})

Copyright
---------

Copyright 2013-2017 by Mathias Karstädt

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