@lite-js/torch

torch
=====

[![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/@lite-js/torch.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@lite-js/torch
[travis-image]: https://img.shields.io/travis/@lite-js/torch.svg?style=flat-square
[travis-url]: https://travis-ci.org/@lite-js/torch
[download-image]: https://img.shields.io/npm/dm/@lite-js/torch.svg?style=flat-square
[download-url]: https://npmjs.org/package/@lite-js/torch

---

Test framework to light up the world.

install

`` bash
$ npm install @lite-js/torch [-g]
`

use

$3

` bash
$ torch test/main
`

$3

` bash
$ torch --renderer test/renderer
`

$3

` bash
$ torch --interative test/renderer
`

> watching source files

` bash
$ torch --interactive --watch test/renderer
`

$3

` bash
$ torch --coverage test/main && torch-coverage
`

$3

` bash
$ torch --coverage test/main && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
`

$3

> interactive mode

` bash
$ torch --interactive --watch --source-pattern src/*/.js test/renderer
`

> code coverage

` bash
$ torch --coverage --source-pattern src/*/.js test/main && torch-coverage
`

options

` bash
$ torch --help

Usage: torch [options]

Options:

-h, --help output usage information
-V, --version output the version number
-C, --no-colors force disabling of colors
-O, --reporter-options reporter-specific options
-R, --reporter specify the reporter to use
-S, --sort sort test files
-b, --bail bail after first test failure
-g, --grep only run tests matching
-f, --fgrep only run tests containing
-i, --invert inverts --grep and --fgrep matches
-r, --require require the given module
-s, --slow "slow" test threshold in milliseconds [75]
-t, --timeout set test-case timeout in milliseconds [2000]
-u, --ui specify user-interface (bdd|tdd|exports)
--check-leaks check for global variable leaks
--compile compile with babel
--compile-opts path of compile options
--compilers :,... use the given module(s) to compile files
--coverage report coverage
--debug enable Electron debugger on port [5858]; for --renderer tests show window and dev-tools
--debug-brk like --debug but pauses the script on the first line
--globals allow the given comma-delimited global [names]
--inline-diffs display actual/expected differences inline within each string
--interactive run tests in renderer process in a visible window that can be reloaded to re-run tests
--interfaces display available interfaces
--no-timeouts disables timeouts
--notify-on-fail notify on failures
--opts specify opts path
--preload preload the given script in renderer process
--recursive include sub directories
--renderer run tests in renderer process
--require-main load the given script in main process before executing tests
--source-pattern glob pattern of source files
--watch watching source file changes
--watch-aggregate-timeout delay time for re-run test cases after files changed
`

$3

> experimental

specify a js file providing compile options. default path is ${process.cwd()}/.torch.compile.opts.js

`javascript
module.exports = {
babelrc: { // babelrc
presets: [
'es2015',
'stage-0'
],
sourceMaps: 'inline'
},
extensions: ['.es6', '.es', '.jsx', '.js'],
include: [ // glob expressions to detect files to include
'index.js',
'lib/*/.js',
'src/*/.js'
],
exclude: [ // glob expressions to detect files to exclude
'bower_components/**',
'node_modules/**'
]
}
`

trouble shooting

$3

Your .travis.yml will need two extra lines of configuration to run this headless on Travis:

` yaml
before_script:
- export DISPLAY=:99.0; sh -e /etc/init.d/xvfb start
`

thanks to

The original idea and most of the code are stolen from electron-mocha, actually you can say that torch is created by adding features onto electron-mocha`.