Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodaguti/gulp-electron-mocha
Run client-side Mocha tests in Electron
https://github.com/nodaguti/gulp-electron-mocha
electron electron-mocha gulp-plugin mocha
Last synced: about 12 hours ago
JSON representation
Run client-side Mocha tests in Electron
- Host: GitHub
- URL: https://github.com/nodaguti/gulp-electron-mocha
- Owner: nodaguti
- License: mit
- Created: 2015-12-14T15:13:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-25T20:06:44.000Z (over 7 years ago)
- Last Synced: 2024-12-17T02:56:48.184Z (24 days ago)
- Topics: electron, electron-mocha, gulp-plugin, mocha
- Language: JavaScript
- Size: 64.5 KB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-electron-mocha
> Run client-side Mocha tests in Electron
[](https://travis-ci.org/nodaguti/gulp-electron-mocha)
[](https://ci.appveyor.com/project/nodaguti/gulp-electron-mocha)
[](https://david-dm.org/nodaguti/gulp-electron-mocha)
[](https://david-dm.org/nodaguti/gulp-electron-mocha#info=devDependencies)
This is a simple wrapper for [electron-mocha](https://github.com/jprichardson/electron-mocha).
The implementations are mostly inspired by [gulp-mocha-phantomjs](https://github.com/mrhooray/gulp-mocha-phantomjs).
## Installation
```sh
npm install --save-dev gulp-electron-mocha
```
Note that you don't have to install either `electron-mocha` or `electron-prebuilt` globally (i.e. with `npm i -g`).
All dependencies are resolved automatically.
## Basic Usage
```javascript
import gulp from 'gulp';
import electronMocha from 'gulp-electron-mocha';
gulp.task('test', () =>
gulp.src('./test', { read: false })
.pipe(electronMocha())
);
```
Please be aware that you should write `gulp.src('./test')`, not `gulp.src('./test/*.js')`,
because `electron-mocha` requires a directory to test.
You can also find working tests in `test/` to learn how to make Gulp tasks and client-side Mocha tests with `gulp-electron-mocha`.
## Passing additional options to electron-mocha
The `electronMocha` property of the optional argument to `electronMocha()`
is passed to `electron-mocha`.
Please see [electron-mocha's docs](https://github.com/jprichardson/electron-mocha#run-tests)
to learn what parameters are available.
`gulp-electron-mocha` uses [object-to-spawn-args](https://github.com/75lb/object-to-spawn-args)
to convert from JavaScript object to command-line argument string.
```javascript
import gulp from 'gulp';
import electronMocha from 'gulp-electron-mocha';
gulp.task('test', () =>
gulp.src('./test', { read: false })
.pipe(electronMocha({
electronMocha: {
renderer: true,
'no-timeout': true,
},
}))
);
```
## Running ES6 tests
`gulp-electron-mocha` can pass `--compilers` option to Mocha.
So just specify `babel-core/register` to `--compilers`.
```javascript
gulp.src('./test', { read: false })
.pipe(electronMocha({
electronMocha: {
renderer: true,
compilers: 'js:babel-core/register',
'no-timeout': true,
},
}))
```
## API
### electronMocha([options])
#### options
- electronPath
| Type | Default |
|:----:|:----:|
| `string` | `undefined` |
A path to Electron in which tests are executed.
If not specified, `gulp-electron-mocha` uses Electron in `node_modules/` by default.
- silent
| Type | Default |
|:----:|:----:|
| `bool` | `false` |
Don't throw an error even if one of the tests is failed.
- suppressStdout
| Type | Default |
|:----:|:----:|
| `bool` | `false` |
Don't redirect electron-mocha's stdout to the console.
- suppressStderr
| Type | Default |
|:----:|:----:|
| `bool` | `false` |
Don't redirect electron-mocha's stderr to the console.
- electronMocha
| Type | Default |
|:----:|:----:|
| `Object` | `{}` |
Options to be passed to electron-mocha.
See [electron-mocha's docs](https://github.com/jprichardson/electron-mocha#run-tests)
for more details.
The value will be converted to command-line argument string with
[object-to-spawn-args](https://github.com/75lb/object-to-spawn-args).
For example, if you want to pass `--no-timeout --renderer -s 200 --compilers js:babel-core/register`,
specify:
```javascript
electronMocha: {
'no-timeout': true,
renderer: true,
s: 200,
compilers: 'js:babel-core/register',
}
```
## Events
This plugin emits events named `electronMochaStdoutData`, `electronMochaStdoutEnd`, `electronMochaStderrData`,
`electronMochaStderrEnd`, `electronMochaError`, and `electronMochaExit`,
which are implemented by the following code:
```
electronMocha.stdout.on('data', stream.emit.bind(stream, 'electronMochaStdoutData'));
electronMocha.stdout.on('end', stream.emit.bind(stream, 'electronMochaStdoutEnd'));
electronMocha.stderr.on('data', stream.emit.bind(stream, 'electronMochaStderrData'));
electronMocha.stderr.on('end', stream.emit.bind(stream, 'electronMochaStderrEnd'));
electronMocha.on('error', stream.emit.bind(stream, 'electronMochaError'));
electronMocha.on('exit', stream.emit.bind(stream, 'electronMochaExit'));
```
## Tests
```
npm test
```
## Contribution
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
MIT License (http://nodaguti.mit-license.org/)