{"id":15365736,"url":"https://github.com/tunnckocore/mukla","last_synced_at":"2025-04-15T09:53:11.166Z","repository":{"id":26708857,"uuid":"30166056","full_name":"tunnckoCore/mukla","owner":"tunnckoCore","description":"🦍 (WIP v0.5 and v1) Delightful \u0026 pluggable test runner, ES2017 ready! Working on and targeting Node.js v0.10. Try `asia@next`","archived":false,"fork":false,"pushed_at":"2023-01-12T06:13:30.000Z","size":499,"stargazers_count":10,"open_issues_count":12,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T12:43:40.705Z","etag":null,"topics":["async-await","async-functions","callbacks","concurrency","fast","parallel","promises","test-framework","testing"],"latest_commit_sha":null,"homepage":"https://ghub.now.sh/asia","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tunnckoCore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-02T01:21:42.000Z","updated_at":"2023-03-04T04:44:46.000Z","dependencies_parsed_at":"2023-01-14T05:11:38.156Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCore/mukla","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fmukla","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fmukla/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fmukla/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fmukla/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCore","download_url":"https://codeload.github.com/tunnckoCore/mukla/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048713,"owners_count":21204306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async-await","async-functions","callbacks","concurrency","fast","parallel","promises","test-framework","testing"],"created_at":"2024-10-01T13:15:50.147Z","updated_at":"2025-04-15T09:53:11.149Z","avatar_url":"https://github.com/tunnckoCore.png","language":"JavaScript","funding_links":["https://www.paypal.me/tunnckoCore"],"categories":[],"sub_categories":[],"readme":"# mukla [![NPM version](https://img.shields.io/npm/v/mukla.svg?style=flat)](https://www.npmjs.com/package/mukla) [![mit license][license-img]][license-url] [![NPM monthly downloads](https://img.shields.io/npm/dm/mukla.svg?style=flat)](https://npmjs.org/package/mukla) [![npm total downloads][downloads-img]][downloads-url]\n\n\u003e Small, parallel and fast test framework with suppport for async/await, promises, callbacks, streams and observables. Targets and works at node.js v0.10 and above.\n\n[![code climate][codeclimate-img]][codeclimate-url] \n[![code style][standard-img]][standard-url] \n[![linux build][travis-img]][travis-url] \n[![windows build][appveyor-img]][appveyor-url] \n[![code coverage][coverage-img]][coverage-url] \n[![dependency status][david-img]][david-url]\n[![paypal donate][paypalme-img]][paypalme-url] \n\n## Hightlights\n- Extremely lightweight and fast\n- Small to download and install\n- No implicit globals,\n- No CLI, use plain `node test.js`\n- Powered by [always-done][]\n- And so supports async/await, promises, observables streams and callbacks\n- Enforces writing atomic tests\n- Simple test syntax - just a single `test()` function\n- Works seamlessly with [istanbul][] for code coverage\n- Stops after first failing test (also known as _\"fail fast\"_ or _\"bail\"_)\n- Built-in [core-assert][] assertion library\n- Targets and works at node.js v0.10 and above\n- No need for build/transpilation/compilation step\n- Backward-compatible with [assertit][] and so [testit][]\n- Easy to porting of [mocha][]-style tests\n- Clean stack traces by default, using [stacktrace-metadata][]\n- Custom reporters, one built-in\n\n## Table of Contents\n- [Install](#install)\n- [Usage](#usage)\n  * [Write tests in ES2015](#write-tests-in-es2015)\n  * [The old way](#the-old-way)\n- [API](#api)\n  * [mukla](#mukla)\n- [Supports](#supports)\n  * [Async/await function support](#asyncawait-function-support)\n  * [Promise support](#promise-support)\n  * [Observable support](#observable-support)\n  * [Regular callbacks support](#regular-callbacks-support)\n  * [Synchronous functions support](#synchronous-functions-support)\n  * [Support functions that returns streams](#support-functions-that-returns-streams)\n  * [Support functions that returns Child Process](#support-functions-that-returns-child-process)\n  * [Handles any errors](#handles-any-errors)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Building docs](#building-docs)\n- [Running tests](#running-tests)\n- [Author](#author)\n- [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\nInstall with [npm](https://www.npmjs.com/)\n\n```\n$ npm install mukla --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add mukla\n```\n\n## Usage\n\u003e For more use-cases see the [tests](./test.js)\n\n### Write tests in ES2015\n\n```js\nimport fs from 'fs'\nimport test from 'mukla'\n\ntest(done =\u003e {\n  test.deepEqual([1, 2], [1, 2]) // passing\n  done()\n})\n\n// or without `done`, returning Promise\n// stream, observerable and so on\ntest(() =\u003e {\n  return fs.createReadStream('not exist') // failing test\n})\n```\n\n### The old way\n\n```js\nvar fs = require('fs')\nvar test = require('mukla')\n\ntest(function (done) {\n  test.deepEqual([1, 2], [1, 2]) // passing\n  done()\n})\n\n// or without `done`, returning Promise\n// stream, observerable and so on\ntest(function () {\n  return fs.createReadStream('not exists') // failing\n})\n```\n\n## API\n\n### [mukla](index.js#L43)\n\u003e Runs `fn` test and outputs the `name` of the test. If only function is given and it is anonymous, the name of the test is `anonymous`, otherwise the name of the `fn` function.\n\n**Params**\n\n* `name` **{String|Function}**: the title of the test or `fn`    \n* `[fn]` **{Function}**: test function, wrapped in [always-done][]    \n* `showStack` **{Boolean}**: if boolean `true`, will print stack when has error    \n\n**Example**\n\n```js\nvar test = require('mukla')\n\n// failing regular callbacks test\ntest('title of test', function (done) {\n  test.strictEqual(1, 2)\n  done()\n})\n\n// passing test with anonymous title\ntest(function (done) {\n  test.strictEqual(222, 222)\n  done()\n})\n```\n\n## Supports\n\u003e Handles completion and errors of async/await, synchronous and asynchronous (callback) functions, also tests that returns streams, promises, child process and observables.\n\n### Async/await function support\n\n```js\nvar test = require('mukla')\n\ntest('passing modern test', async function () {\n  return await Promise.resolve('foobar')\n})\n```\n\n**[back to top](#readme)**\n\n### Promise support\n\n#### Returning a resolved Promise\n\n```js\nvar test = require('mukla')\n\ntest('passing promise test', function () {\n  return Promise.resolve(12345)\n})\n```\n\n#### Returning a rejected Promise\n\n```js\nvar test = require('mukla')\n\ntest('failing test with promise', function () {\n  return Promise.reject(new Error('foo bar'))\n})\n```\n\n**[back to top](#readme)**\n\n### Observable support\n\u003e Using `.subscribe` method of the observable\n\n#### Empty observable\n```js\nvar test = require('mukla')\nvar Observable = require('rx').Observable\n\ntest('passing test with empty observable', function () {\n  return Observable.empty()\n})\n```\n\n#### Successful test wtih observable\n\n```js\nvar test = require('mukla')\nvar Observable = require('rx').Observable\n\nalwaysDone(function () {\n  return Observable.return([1, 2, 3])\n})\n```\n\n#### Failing observable\n\n```js\nvar test = require('mukla')\nvar Observable = require('rx').Observable\n\ntest(function () {\n  return Observable.throw(new Error('observable error'))\n})\n```\n\n**[back to top](#readme)**\n\n### Regular callbacks support\n\n```js\nvar test = require('mukla')\nvar fs = require('fs')\n\ntest('some callback test', function (done) {\n  fs.readFile('./package.json', 'utf8', function (err, res) {\n    test.strictEqual(err, null)\n    test.strictEqual(typeof res, 'string')\n    test.strictEqual(res.length \u003e 0, true)\n    done()\n  })\n})\n```\n\n**[back to top](#readme)**\n\n### Synchronous functions support\n\n#### Passing sync test\n\n```js\nvar fs = require('fs')\nvar test = require('mukla')\n\ntest(function () {\n  var res = fs.readFileSync('./package.json')\n  test.strictEqual(typeof res, 'string')\n})\n```\n\n#### Failing test with title\n\n```js\nvar test = require('mukla')\n\ntest('some failing test', function () {\n  JSON.parse('{Sjkfsf:\"dfgfg')\n})\n```\n\n**[back to top](#readme)**\n\n### Support functions that returns streams\n\u003e Handles completion of tests using [on-stream-end][] and [stream-exhaust][], behind the scenes, using [always-done][]\n\n#### Passing test with unpiped streams\n\n```js\nvar fs = require('fs')\nvar test = require('mukla')\n\ntest(function () {\n  return fs.createReadStream('./package.json')\n})\n```\n\n#### Failing test unpiped streams\n\n```js\nvar fs = require('fs')\nvar test = require('mukla')\n\ntest('failing stream test', function () {\n  return fs.createReadStream('foo bar')\n})\n```\n\n#### Failing test with piped streams\n\n```js\nvar fs = require('fs')\nvar test = require('mukla')\nvar through2 = require('through2')\n\ntest(function () {\n  var read = fs.createReadStream('foo bar')\n  return read.pipe(through2())\n})\n```\n\n**[back to top](#readme)**\n\n### Support functions that returns Child Process\n\u003e Basically, they are streams, so completion is handled using [on-stream-end][] which is drop-in replacement for [end-of-stream][]\n\n#### Successful exec\n\n```js\nvar test = require('mukla')\nvar cp = require('child_process')\nvar isChildProcess = require('is-child-process')\n\ntest('returning child processes', function () {\n  var proc = cp.exec('echo hello world')\n  test.strictEqual(isChildProcess(proc), true)\n  return proc\n})\n```\n\n#### Failing exec\n\n```js\nvar test = require('mukla')\nvar cp = require('child_process')\n\ntest('should be failing exec test', function () {\n  return cp.exec('foo-bar-baz sasa')\n})\n```\n\n#### Failing spawn\n\n```js\nvar test = require('mukla')\nvar cp = require('child_process')\n\ntest('failing child process spawn test', function () {\n  return cp.spawn('foo-bar-baz', ['hello world'])\n})\n```\n\n**[back to top](#readme)**\n\n### Handles any errors\n\n#### uncaught exceptions\n\n```js\nvar test = require('mukla')\n\ntest('should be failing test with ReferenceError', function () {\n  foo // ReferenceError\n  return 55\n})\n```\n\n#### if test throws\n\n```js\nvar test = require('mukla')\n\ntest('failing test with SyntaxError', function () {\n  JSON.parse('{\"foo\":')\n})\n```\n\n**[back to top](#readme)**\n\n## Related\n- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme \"Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more\")\n- [core-assert](https://www.npmjs.com/package/core-assert): Node.js `assert` as a standalone module | [homepage](https://github.com/sindresorhus/core-assert#readme \"Node.js `assert` as a standalone module\")\n- [each-promise](https://www.npmjs.com/package/each-promise): Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start… [more](https://github.com/tunnckocore/each-promise#readme) | [homepage](https://github.com/tunnckocore/each-promise#readme \"Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start, beforeEach, afterEach, finish)\")\n- [gruu](https://www.npmjs.com/package/gruu): Modern, small and powerful testing with TAP output and support for async/await, promises, callbacks, streams and observables, built on [always-done][]. | [homepage](https://github.com/tunnckocore/gruu#readme \"Modern, small and powerful testing with TAP output and support for async/await, promises, callbacks, streams and observables, built on [always-done][].\")\n- [minibase-is-registered](https://www.npmjs.com/package/minibase-is-registered): Plugin for [minibase][] and [base][], that adds `isRegistered` method to your application to detect if plugin is already registered and… [more](https://github.com/node-minibase/minibase-is-registered#readme) | [homepage](https://github.com/node-minibase/minibase-is-registered#readme \"Plugin for [minibase][] and [base][], that adds `isRegistered` method to your application to detect if plugin is already registered and returns true or false if named plugin is already registered on the instance.\")\n- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme \"Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.\")\n- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme \"Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.\")\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/mukla/issues/new).  \nPlease read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  \nIf you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github\u0026utm_medium=button\u0026utm_term=tunnckocore\u0026utm_campaign=github) too.\n\n**In short:** If you want to contribute to that project, please follow these things\n\n1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See [\"Building docs\"](#building-docs) section.\n2. Ensure anything is okey by installing the dependencies and run the tests. See [\"Running tests\"](#running-tests) section.\n3. 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.\n4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.\n\nThanks a lot! :)\n\n## Building docs\nDocumentation 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\n\n```\n$ npm install verbose/verb#dev verb-generate-readme --global \u0026\u0026 verb\n```\n\n_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._\n\n## Running tests\nClone repository and run the following in that cloned directory\n\n```\n$ npm install \u0026\u0026 npm test\n```\n\n## Author\n**Charlike Mike Reagent**\n\n+ [github/tunnckoCore](https://github.com/tunnckoCore)\n+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)\n+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)\n\n## License\nCopyright © 2015, 2017, [Charlike Mike Reagent](http://www.tunnckocore.tk). Released under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 17, 2017._  \n_Project scaffolded using [charlike][] cli._\n\n[always-done]: https://github.com/hybridables/always-done\n[assertit]: https://github.com/tunnckoCore/assertit\n[async-done]: https://github.com/gulpjs/async-done\n[base]: https://github.com/node-base/base\n[charlike]: https://github.com/tunnckocore/charlike\n[clean-stacktrace]: https://github.com/tunnckocore/clean-stacktrace\n[commitizen]: https://github.com/commitizen/cz-cli\n[core-assert]: https://github.com/sindresorhus/core-assert\n[dezalgo]: https://github.com/npm/dezalgo\n[end-of-stream]: https://github.com/mafintosh/end-of-stream\n[istanbul]: https://github.com/gotwarlost/istanbul\n[minibase]: https://github.com/node-minibase/minibase\n[mocha]: https://mochajs.org\n[on-stream-end]: https://github.com/tunnckocore/on-stream-end\n[once]: https://github.com/isaacs/once\n[standard-version]: https://github.com/conventional-changelog/standard-version\n[stream-exhaust]: https://github.com/chrisdickinson/stream-exhaust.git\n[testit]: https://github.com/ForbesLindesay/testit\n[verb-generate-readme]: https://github.com/verbose/verb-generate-readme\n[verb]: https://github.com/verbose/verb\n\n[license-url]: https://www.npmjs.com/package/mukla\n[license-img]: https://img.shields.io/npm/l/mukla.svg\n\n[downloads-url]: https://www.npmjs.com/package/mukla\n[downloads-img]: https://img.shields.io/npm/dt/mukla.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/mukla\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/mukla.svg\n\n[travis-url]: https://travis-ci.org/tunnckoCore/mukla\n[travis-img]: https://img.shields.io/travis/tunnckoCore/mukla/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/mukla\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/mukla/master.svg?label=windows\n\n[coverage-url]: https://codecov.io/gh/tunnckoCore/mukla\n[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/mukla/master.svg\n\n[david-url]: https://david-dm.org/tunnckoCore/mukla\n[david-img]: https://img.shields.io/david/tunnckoCore/mukla.svg\n\n[standard-url]: https://github.com/feross/standard\n[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n\n[paypalme-url]: https://www.paypal.me/tunnckoCore\n[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg\n\n[stacktrace-metadata]: https://github.com/tunnckocore/stacktrace-metadata","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fmukla","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunnckocore%2Fmukla","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fmukla/lists"}