This package has been deprecated

Author message:

WARNING: This module has been renamed to reCInk (recink). Please install it instead. Visit https://github.com/MitocGroup/reCInk for more information.

run-jst

run-jst (aka jst) is a highly customizable and extremely optimized tests runner suitable for running tests on big / hybrid / complex projects by adding a simple .jst.yml config.

Motivation

Finding an highly configurable test runner that suits for more than a basic js app is as hard as writing high quality tests :bowtie:. The main reason is getting test running as fast as possible with a minimal headache possible and extending the runner via components using a simple and documented api.

Also CI integration and caching out of the box 😉

The project have been started to cover the needs of Deep Ecosystem

Features

• Easy to install/configure/use
• Multimodule support with consolidated coverage
• Travis support
• Coverage support
• NPM support with packages global/local overwrites (including custom scripts execution)
• AWS S3 storage driver support
• Caching support
• Easily extendable
• Easily debuggable
• Well documented
• To be continued...

Mocha is used as test framework for unit testing

TestCafe is used as test framework for e2e testing

Prerequisites

• Ensure Node.js >=v6.x is installed (We recommend using nvm https://github.com/creationix/nvm#installation)
• Profit?!

We'd recommend installing Node.js v8.x to speedup things.

Installation

npm install -g run-jst

Getting Started

Check out the User Guide

Usage

jst --help Show help

jst configure jst Configure run-jst

jst run unit Run unit tests

jst run e2e Run end-to-end tests

Debugging

In order start debugging TestCafe read this.

In case you are using the Nighmare browser please refer to this link.

Note that Nighmare browser is used as default browser when none specified.

CI Platforms supported

• Travis
• Travis Pro

Documentation

• Quick Start Guide
• Crafting Components
• Api Docs
• Module Diagram
• FAQ

Components (inhouse + 3'rd party)

• 🏠 CodeClimate
• 🏠 Snyk.io

Navigate here to see all inhouse components

Projects using run-jst

• Deep Framework

To add you project to this list please open a PR ;)

Roadmap

• Implement smart cache invalidation
• Add support for external components
• Add support for fully automated Travis configuration
• Add support for End-to-End tests
• Add support for different CI platforms
• Add component development guide
• Add unit tests for critical functionality
• Craft a cool logo for the project 👽

Sponsors

This repository is being sponsored by:

• Mitoc Group
• AdTechMedia

License

run-jst is released under the MIT license.

Copyright (c) 2017 Mitoc Group Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.