{%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

{%= description %}

[![code climate][codeclimate-img]][codeclimate-url] [![linux build][travis-img]][travis-url] [![windows build][appveyor-img]][appveyor-url] [![code coverage][coverage-img]][coverage-url] [![dependency status][david-img]][david-url]

Hightlights

Extremely lightweight and fast
Small to download and install
No implicit globals,
No CLI, use plain node test.js
Powered by [always-done][]
And so supports async/await, promises, observables streams and callbacks
Enforces writing atomic tests
Simple test syntax - just a single test() function
Works seamlessly with [istanbul][] for code coverage
Stops after first failing test (also known as "fail fast" or "bail")
Built-in [core-assert][] assertion library
Targets and works at node.js v0.10 and above
No need for build/transpilation/compilation step
Backward-compatible with [assertit][] and so [testit][]
Easy to porting of [mocha][]-style tests
Clean stack traces by default, using [stacktrace-metadata][]
Custom reporters, one built-in

Install

Install with npm

$ npm install {%= name %} --save

or install using yarn

$ yarn add {%= name %}

Usage

For more use-cases see the tests

Write tests in ES2015

import fs from 'fs'
import test from 'mukla'

test(done => {
  test.deepEqual([1, 2], [1, 2]) // passing
  done()
})

// or without `done`, returning Promise
// stream, observerable and so on
test(() => {
  return fs.createReadStream('not exist') // failing test
})

The old way

var fs = require('fs')
var test = require('{%= name %}')

test(function (done) {
  test.deepEqual([1, 2], [1, 2]) // passing
  done()
})

// or without `done`, returning Promise
// stream, observerable and so on
test(function () {
  return fs.createReadStream('not exists') // failing
})

API

{%= apidocs('index.js') %}

Supports

Handles completion and errors of async/await, synchronous and asynchronous (callback) functions, also tests that returns streams, promises, child process and observables.

Async/await function support

var test = require('mukla')

test('passing modern test', async function () {
  return await Promise.resolve('foobar')
})

back to top

Promise support

Returning a resolved Promise

var test = require('mukla')

test('passing promise test', function () {
  return Promise.resolve(12345)
})

Returning a rejected Promise

var test = require('mukla')

test('failing test with promise', function () {
  return Promise.reject(new Error('foo bar'))
})

back to top

Observable support

Using .subscribe method of the observable

Empty observable

var test = require('mukla')
var Observable = require('rx').Observable

test('passing test with empty observable', function () {
  return Observable.empty()
})

Successful test wtih observable

var test = require('mukla')
var Observable = require('rx').Observable

alwaysDone(function () {
  return Observable.return([1, 2, 3])
})

Failing observable

var test = require('mukla')
var Observable = require('rx').Observable

test(function () {
  return Observable.throw(new Error('observable error'))
})

back to top

Regular callbacks support

var test = require('mukla')
var fs = require('fs')

test('some callback test', function (done) {
  fs.readFile('./package.json', 'utf8', function (err, res) {
    test.strictEqual(err, null)
    test.strictEqual(typeof res, 'string')
    test.strictEqual(res.length > 0, true)
    done()
  })
})

back to top

Synchronous functions support

Passing sync test

var fs = require('fs')
var test = require('mukla')

test(function () {
  var res = fs.readFileSync('./package.json')
  test.strictEqual(typeof res, 'string')
})

Failing test with title

var test = require('mukla')

test('some failing test', function () {
  JSON.parse('{Sjkfsf:"dfgfg')
})

back to top

Support functions that returns streams

Handles completion of tests using [on-stream-end][] and [stream-exhaust][], behind the scenes, using [always-done][]

Passing test with unpiped streams

var fs = require('fs')
var test = require('mukla')

test(function () {
  return fs.createReadStream('./package.json')
})

Failing test unpiped streams

var fs = require('fs')
var test = require('mukla')

test('failing stream test', function () {
  return fs.createReadStream('foo bar')
})

Failing test with piped streams

var fs = require('fs')
var test = require('mukla')
var through2 = require('through2')

test(function () {
  var read = fs.createReadStream('foo bar')
  return read.pipe(through2())
})

back to top

Support functions that returns Child Process

Basically, they are streams, so completion is handled using [on-stream-end][] which is drop-in replacement for [end-of-stream][]

Successful exec

var test = require('mukla')
var cp = require('child_process')
var isChildProcess = require('is-child-process')

test('returning child processes', function () {
  var proc = cp.exec('echo hello world')
  test.strictEqual(isChildProcess(proc), true)
  return proc
})

Failing exec

var test = require('mukla')
var cp = require('child_process')

test('should be failing exec test', function () {
  return cp.exec('foo-bar-baz sasa')
})

Failing spawn

var test = require('mukla')
var cp = require('child_process')

test('failing child process spawn test', function () {
  return cp.spawn('foo-bar-baz', ['hello world'])
})

back to top

Handles any errors

uncaught exceptions

var test = require('mukla')

test('should be failing test with ReferenceError', function () {
  foo // ReferenceError
  return 55
})

if test throws

var test = require('mukla')

test('failing test with SyntaxError', function () {
  JSON.parse('{"foo":')
})

back to top

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

{%= includeEither('authors', 'author') %}

codementor/tunnckoCore

License

{%= include('footer') %}
Project scaffolded using [charlike][] cli.

{%= reflinks(verb.reflinks) %}

[license-url]: https://www.npmjs.com/package/{%= name %} [license-img]: https://img.shields.io/npm/l/{%= name %}.svg

[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %} [travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coverage-url]: https://codecov.io/gh/{%= repository %} [coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg

[david-url]: https://david-dm.org/{%= repository %} [david-img]: https://img.shields.io/david/{%= repository %}.svg

Files

.verb.md

Latest commit

History

.verb.md

File metadata and controls

{%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

Hightlights

Table of Contents

Install

Usage

Write tests in ES2015

The old way

API

Supports

Async/await function support

Promise support

Returning a resolved Promise

Returning a rejected Promise

Observable support

Empty observable

Successful test wtih observable

Failing observable

Regular callbacks support

Synchronous functions support

Passing sync test

Failing test with title

Support functions that returns streams

Passing test with unpiped streams

Failing test unpiped streams

Failing test with piped streams

Support functions that returns Child Process

Successful exec

Failing exec

Failing spawn

Handles any errors

uncaught exceptions

if test throws

Related

Contributing

Building docs

Running tests

Author

License