# minibase-results [](https://www.npmjs.com/package/minibase-results) [](https://npmjs.org/package/minibase-results) [![npm total downloads][downloads-img]][downloads-url] > Plugin for [minibase][] that adds useful initial properties for test results [![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![linux build status][travis-img]][travis-url] [![windows build status][appveyor-img]][appveyor-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] You might also be interested in [mukla](https://github.com/tunnckocore/mukla#readme). ## Table of Contents - [Install](#install) - [Usage](#usage) - [API](#api) * [minibaseResults](#minibaseresults) - [Related](#related) - [Contributing](#contributing) - [Building docs](#building-docs) - [Running tests](#running-tests) - [Author](#author) - [License](#license) _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ ## Install Install with [npm](https://www.npmjs.com/) ``` $ npm install minibase-results --save ``` or install using [yarn](https://yarnpkg.com) ``` $ yarn add minibase-results ``` ## Usage > For more use-cases see the [tests](test.js) ```js const minibaseResults = require('minibase-results') ``` ## API ### [minibaseResults](index.js#L46) > Initializes defaults for test runners **Params** * `opts` **{Object}**: optional options, merged with `app.options` * `returns` **{Function}**: plugin function for [minibase][]'s `.use` method **Example** ```js var app = require('minibase') var results = require('minibase-results') console.log(app.options.settle) // => true console.log(app.tests) // => undefined console.log(app.stats) // => undefined app.use(results({ settle: false })) console.log(app.options.settle) // => false console.log(app.tests) // => [] console.log(app._stream) // => through2 object mode stream console.log(app.stats.count) // => 0 console.log(app.stats.pass) // => 0 console.log(app.stats.fail) // => 0 console.log(app.stats.skip) // => 0 console.log(app.stats.todo) // => 0 console.log(app.stats.runned) // => 0 console.log(app.stats.anonymous) // => 0 ``` ## Related - [base-task-alias](https://www.npmjs.com/package/base-task-alias): Plugin that adds `.taskAlias` method to your @node-base application. Creating alias task for some task. | [homepage](https://github.com/tunnckocore/base-task-alias#readme "Plugin that adds `.taskAlias` method to your @node-base application. Creating alias task for some task.") - [minibase-create-plugin](https://www.npmjs.com/package/minibase-create-plugin): Utility for [minibase][] and [base][] that helps you create plugins | [homepage](https://github.com/node-minibase/minibase-create-plugin#readme "Utility for [minibase][] and [base][] that helps you create plugins") - [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 returns true or false if… [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.") - [minibase-tests](https://www.npmjs.com/package/minibase-tests): Tests for applications built on [minibase][] or [base][]. All Base apps passes these tests. | [homepage](https://github.com/node-minibase/minibase-tests#readme "Tests for applications built on [minibase][] or [base][]. All Base apps passes these tests.") - [minibase-visit](https://www.npmjs.com/package/minibase-visit): Plugin for [minibase][] and [base][], that adds `.visit` method to your application to visit a method over the items in an object, or map visit… [more](https://github.com/node-minibase/minibase-visit#readme) | [homepage](https://github.com/node-minibase/minibase-visit#readme "Plugin for [minibase][] and [base][], that adds `.visit` method to your application to visit a method over the items in an object, or map visit over the objects in an array. Using using [collection-visit][] package.") - [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 [base][] plugins. | [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.") ## Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/node-minibase/minibase-results/issues/new). Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards. **In short:** If you want to contribute to that project, please follow these things 1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section. 2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section. 3. 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. 4. 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](.verb.md)._ ## Running tests Clone repository and run the following in that cloned directory ``` $ npm install && npm test ``` ## Author **Charlike Mike Reagent** + [github/tunnckoCore](https://github.com/tunnckoCore) + [twitter/tunnckoCore](http://twitter.com/tunnckoCore) ## License Copyright © 2016, [Charlike Mike Reagent](http://www.tunnckocore.tk). Released under the [MIT license](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on November 17, 2016._ [base]: https://github.com/node-base/base [collection-visit]: https://github.com/jonschlinkert/collection-visit [commitizen]: https://github.com/commitizen/cz-cli [minibase]: https://github.com/node-minibase/minibase [standard-version]: https://github.com/conventional-changelog/standard-version [verb-generate-readme]: https://github.com/verbose/verb-generate-readme [verb]: https://github.com/verbose/verb [downloads-url]: https://www.npmjs.com/package/minibase-results [downloads-img]: https://img.shields.io/npm/dt/minibase-results.svg [codeclimate-url]: https://codeclimate.com/github/node-minibase/minibase-results [codeclimate-img]: https://img.shields.io/codeclimate/github/node-minibase/minibase-results.svg [travis-url]: https://travis-ci.org/node-minibase/minibase-results [travis-img]: https://img.shields.io/travis/node-minibase/minibase-results/master.svg?label=linux [appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/minibase-results [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/minibase-results/master.svg?label=windows [coveralls-url]: https://coveralls.io/r/node-minibase/minibase-results [coveralls-img]: https://img.shields.io/coveralls/node-minibase/minibase-results.svg [david-url]: https://david-dm.org/node-minibase/minibase-results [david-img]: https://img.shields.io/david/node-minibase/minibase-results.svg [standard-url]: https://github.com/feross/standard [standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg