{"id":15365766,"url":"https://github.com/tunnckocore/gruu-api","last_synced_at":"2026-01-19T07:33:13.045Z","repository":{"id":48000552,"uuid":"85117703","full_name":"tunnckoCore/gruu-api","owner":"tunnckoCore","description":"Core API for Gruu and Mukla - Minimal, modern and extensible test runners","archived":false,"fork":false,"pushed_at":"2023-01-12T06:13:37.000Z","size":477,"stargazers_count":2,"open_issues_count":13,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T18:55:24.862Z","etag":null,"topics":["async-await","async-functions","callbacks","concurrency","core-api","es2015","es2017","parallel","test-runner","testing"],"latest_commit_sha":null,"homepage":null,"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":"2017-03-15T20:27:38.000Z","updated_at":"2023-03-04T04:44:46.000Z","dependencies_parsed_at":"2023-02-09T10:30:56.925Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCore/gruu-api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fgruu-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fgruu-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fgruu-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fgruu-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCore","download_url":"https://codeload.github.com/tunnckoCore/gruu-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247493782,"owners_count":20947774,"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","core-api","es2015","es2017","parallel","test-runner","testing"],"created_at":"2024-10-01T13:15:58.271Z","updated_at":"2026-01-19T07:33:13.037Z","avatar_url":"https://github.com/tunnckoCore.png","language":"JavaScript","funding_links":["https://www.paypal.me/tunnckoCore"],"categories":[],"sub_categories":[],"readme":"# gruu-api [![NPM version](https://img.shields.io/npm/v/gruu-api.svg?style=flat)](https://www.npmjs.com/package/gruu-api) [![mit license][license-img]][license-url] [![NPM monthly downloads](https://img.shields.io/npm/dm/gruu-api.svg?style=flat)](https://npmjs.org/package/gruu-api) [![npm total downloads][downloads-img]][downloads-url]\n\n\u003e Core API for Gruu and Mukla - Minimal, modern and extensible test runners\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\nYou might also be interested in [always-done](https://github.com/hybridables/always-done#readme).\n\n## Table of Contents\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n  * [Gruu](#gruu)\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 gruu-api --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add gruu-api\n```\n\n## Usage\n\u003e For more use-cases see the [tests](test.js)\n\n```js\nconst gruuApi = require('gruu-api')\n```\n\n## API\n\n### [Gruu](src/index.js#L111)\n\u003e Initialize `Gruu` constructor with optional `options` object. Basically it is just [dush][] which is simple event emitter system and has `.on`, `.off`, `.once`, `.emit` and `.use` methods. In addition the runner adds `.define`, `.delegate`, `.add` and `.run` methods. Use `.add` to define new test and `.run` to start the suite. One more cool thing is that it emit life-cycle events - `start`, `beforeEach`, `pass`, `fail`, `afterEach` and `finish`. So for example if test fail it will emit `fail`, `beforeEach` and `afterEach` events which you can listen with `.on('fail', fn)`. By default `gruu-api` _does not_ comes with included reporter, so you can give listener to each event manually or pass `options.reporter` which is the same thing as plugin - a function that is called immediatelly with `(app)` signature.\n\n_All `options` are also passed to [redolent][] and [each-promise][].\nTests by default are ran concurrently in `opts.settle:true` mode (means that it **won't** stop\nafter the first found error), so `.run().then()` will be called always._\n\n**Params**\n\n* `options` **{Object}**: see more in [Options Section](#options) _(soon)_    \n* `returns` **{Object}**: an object that is returned from `dush`  \n\n**Example**\n\n```js\nconst delay = require('delay')\nconst Gruu = require('gruu-api')\n\nconst app = Gruu()\n\n// DEFINE TEST SUITE\napp.add('my awesome test', (t) =\u003e {\n  t.strictEqual(111, 111, 'should be 111 === 111')\n})\n\n// note: use node \u003e= 7.6\napp.add('failing async test', async (t) =\u003e {\n  await delay(500)\n  t.ok(false)\n})\n\napp.add('some failing test', (t) =\u003e {\n  t.strictEqual('foo', 123)\n})\n\n// CUSTOM TAP REPORTER, built as plugin\napp.use((app) =\u003e {\n  // makes error object enhanced\n  const metadata = require('stacktrace-metadata')\n\n  app.once('start', (app) =\u003e {\n    console.log('TAP version 13')\n  })\n  app.on('pass', (app, test) =\u003e {\n    console.log('# :)', test.title)\n    console.log('ok', test.index, '-', test.title)\n  })\n  app.on('fail', (app, { title, index, reason }) =\u003e {\n    console.log('# :(', title)\n    console.log('not ok', index, '-', title)\n\n    const err = metadata(reason, app.options)\n    delete err.generatedMessage\n\n    // TAP-ish YAML-ish output\n    let json = JSON.stringify(err, null, 2)\n    json = json.replace(/^\\{/, '  ---')\n    json = json.replace(/\\}$/, '  ...')\n    console.log(json)\n\n    // or the whole stack\n    // console.log(err.stack)\n  })\n  app.once('finish', ({ stats }) =\u003e {\n    console.log('')\n    console.log(`1..${stats.count}`)\n    console.log('# tests', stats.count)\n    console.log('# pass ', stats.pass)\n\n    if (stats.fail) {\n      console.log('# fail ', stats.fail)\n      console.log('')\n      process.exit(1)\n    } else {\n      console.log('')\n      console.log('# ok')\n      process.exit(0)\n    }\n  })\n})\n\n// START DEFINED TEST SUITE\napp.run().then(\n  () =\u003e console.log('done')\n)\n```\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- [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/gruu-api/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 © 2016-2017, [Charlike Mike Reagent](https://i.am.charlike.online). 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 16, 2017._  \n_Project scaffolded using [charlike][] cli._\n\n[always-done]: https://github.com/hybridables/always-done\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[commitizen]: https://github.com/commitizen/cz-cli\n[dezalgo]: https://github.com/npm/dezalgo\n[dush]: https://github.com/tunnckocore/dush\n[each-promise]: https://github.com/tunnckocore/each-promise\n[once]: https://github.com/isaacs/once\n[redolent]: https://github.com/hybridables/redolent\n[standard-version]: https://github.com/conventional-changelog/standard-version\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/gruu-api\n[license-img]: https://img.shields.io/npm/l/gruu-api.svg\n\n[downloads-url]: https://www.npmjs.com/package/gruu-api\n[downloads-img]: https://img.shields.io/npm/dt/gruu-api.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/gruu-api\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/gruu-api.svg\n\n[travis-url]: https://travis-ci.org/tunnckoCore/gruu-api\n[travis-img]: https://img.shields.io/travis/tunnckoCore/gruu-api/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/gruu-api\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/gruu-api/master.svg?label=windows\n\n[coverage-url]: https://codecov.io/gh/tunnckoCore/gruu-api\n[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/gruu-api/master.svg\n\n[david-url]: https://david-dm.org/tunnckoCore/gruu-api\n[david-img]: https://img.shields.io/david/tunnckoCore/gruu-api.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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fgruu-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunnckocore%2Fgruu-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fgruu-api/lists"}