Need private packages and team management tools?Check out npm Teams »

minibase-results

1.0.3 • Public • Published

minibase-results NPM version NPM downloads npm total downloads

Plugin for minibase that adds useful initial properties for test results

code climate standard code style linux build status windows build status coverage status dependency status

You might also be interested in mukla.

Table of Contents

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install minibase-results --save

or install using yarn

$ yarn add minibase-results

Usage

For more use-cases see the tests

const minibaseResults = require('minibase-results')

API

minibaseResults

Initializes defaults for test runners

Params

  • opts {Object}: optional options, merged with app.options
  • returns {Function}: plugin function for minibase's .use method

Example

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

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines 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, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "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.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

License

Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.


This file was generated by verb-generate-readme, v0.2.0, on November 17, 2016.

Install

npm i minibase-results

DownloadsWeekly Downloads

1

Version

1.0.3

License

MIT

Last publish

Collaborators

  • avatar
  • avatar