Have ideas to improve npm?Join in the discussion! »

    minibase-tests

    1.1.2 • Public • Published

    minibase-tests NPM version NPM downloads npm total downloads

    Tests for applications built on minibase or base. All Base apps passes these tests.

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

    Table of Contents

    (TOC generated by verb using markdown-toc)

    Install

    Install with npm

    $ npm install minibase-tests --save
    

    or install using yarn

    $ yarn add minibase-tests
    

    Usage

    For more use-cases see the tests

    const minibaseTests = require('minibase-tests')

    API

    suite

    Test any app based on minibase and base, just pass constructor as App argument. If it is base based pass opts.isBase: true option. When run .runTests it returns resolved Promise with array with length of 0 if all tests are passed. If any of the tests fails that result array will contain these tests - their title, index and the error. Resolved array also has .tests property which is the count of all tests, so easily you can do res.tests - res.length to find how many tests are failed, and get them by outputing res.

    Params

    • App {Function}: app constructor, if not a function returns rejected promise
    • opts {Object}: optional object, pass isBase: true for base apps
    • returns {Promise}: promise if App not a function or instance of Runner, so call .runTests()

    Example

    var suite = require('minibase-tests')
    var Base = require('base')
    var Assemble = require('assemble-core')
    var Templates = require('templates')
    var MiniBase = require('minibase').MiniBase
     
    suite(Base, { isBase: true })
    .runTests().then(function (res) {
      // if `res` has bigger length
      // it will contain failed tests
      console.log(res.length) // => 0
      console.log(res.tests) // => 17
    })
    suite(Assemble, { isBase: true })
    .runTests().then(function (res) {
      console.log(res.length) // => 0
      console.log(res.tests) // => 17
    })
    suite(Templates, { isBase: true })
    .runTests().then(function (res) {
      console.log(res.length) // => 0
      console.log(res.tests) // => 17
    })
     
    // MiniBase itself passes these tests too
    suite(MiniBase).runTests().then(function (res) {
      console.log(res.length) // => 0
      console.log(res.tests) // => 17
    })
     
    function MyApp () {
      MiniBase.call(this)
    }
    MiniBase.extend(MyApp)
     
    suite(MyApp).runTests().then(function (res) {
      console.log(res.length) // => 0
      console.log(res.tests) // => 17
    })

    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-tests

    DownloadsWeekly Downloads

    2

    Version

    1.1.2

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar