minibase-tests
Tests for applications built on minibase or base. All Base apps passes these tests.
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 =
API
suite
Test any app based on minibase and base, just pass constructor as
App
argument. If it isbase
based passopts.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 thatresult
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 dores.tests - res.length
to find how many tests are failed, and get them by outputingres
.
Params
App
{Function}: app constructor, if not a function returns rejected promiseopts
{Object}: optional object, passisBase: true
for base appsreturns
{Promise}: promise ifApp
not a function or instance of Runner, so call.runTests()
Example
var suite = var Base = var Assemble = var Templates = var MiniBase = MiniBase // MiniBase itself passes these tests too { MiniBase}MiniBase
Related
- assemble-core: The core assemble application with no presets or defaults. All configuration is left to the implementor. | homepage
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble… more | homepage
- generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness… more | homepage
- minibase-create-plugin: Utility for minibase and base that helps you create plugins | homepage
- minibase-is-registered: Plugin for minibase and base, that adds
isRegistered
method to your application to detect if plugin… more | homepage - minibase: MiniBase is minimalist approach to Base - @node-base, the awesome framework. Foundation for building complex APIs… more | homepage
- templates: System for creating and managing template collections, and rendering templates with any node.js template engine. Can… more | homepage
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
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run commit
to commit changes instead ofgit commit
, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - 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.