Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeybaker/smokestack-watch
Re-run tests on file change with watchify and smokestack
https://github.com/joeybaker/smokestack-watch
Last synced: 6 days ago
JSON representation
Re-run tests on file change with watchify and smokestack
- Host: GitHub
- URL: https://github.com/joeybaker/smokestack-watch
- Owner: joeybaker
- License: other
- Created: 2015-04-17T23:53:40.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-04-30T16:39:38.000Z (over 9 years ago)
- Last Synced: 2024-04-26T01:21:10.429Z (9 months ago)
- Language: JavaScript
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# smokestack-watch [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image]
Use watchify to run tape tests with smokestack
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Install](#install)
- [Usage](#usage)
- [CLI flags](#cli-flags)
- [`d` or `debug`](#d-or-debug)
- [`delay=0`](#delay0)
- [`ignore-watch=true`](#ignore-watchtrue)
- [`browser="chrome"`](#browserchrome)
- [`t` or `transform`](#t-or-transform)
- [`p` or `plugin`](#p-or-plugin)
- [`timeout`](#timeout)
- [`r ` or `reporter=`](#r-reporter-module-or-reporterreporter-module)
- [Tests](#tests)
- [Developing](#developing)
- [Requirements](#requirements)
- [License](#license)
## Install
```sh
npm i -g smokestack-watch
```
## Usage
```sh
smokestack-watch test/suite1/*.js test/suite2/*.js
```
```js
var smokestackWatch = require('smokestack-watch')
smokestackWatch({
// the defaults
debug: true
, delay: 0
, ignoreWatch: true
, browser: 'chrome'
, transforms: []
, plugins: []
, patterns: []
, timeout: 300000 // 5 minutes
})
```
## CLI flags
### `d` or `debug`
Enable sourcemaps. Defaults to `true`.
### `delay=0`
How long should watchify wait before compiling? Defaults to `0`
### `ignore-watch=true`
Sets the `ignoreWatch` watchify option. Defaults to `true` which disables watching `node_modules`.
### `browser="chrome"`
Which browser should smokestack launch? Defaults to `chrome`.
### `t` or `transform`
Pass transform options to browserify.
### `p` or `plugin`
Pass plugin options to browserify.
### `timeout`
Timeout time for smokestack. Defaults to 5 minutes.
### `r ` or `reporter=`
Pass your tests through a reporter. e.g. `-r tap-spec`. This reporter must be installed in the working directory.
## Tests
Tests are in [tape](https://github.com/substack/tape) and code coverage is run though [covert](https://github.com/substack/covert). But are not at all complete.
* `npm test` will run both server and browser tests
* `npm run tdd` will run the server tests on every file change.
## Developing
To publish, run `npm run release -- [{patch,minor,major}]`
_NOTE: you might need to `sudo ln -s /usr/local/bin/node /usr/bin/node` to ensure node is in your path for the git hooks to work_
### Requirements
* **npm > 2.0.0** So that passing args to a npm script will work. `npm i -g npm`
* **git > 1.8.3** So that `git push --follow-tags` will work. `brew install git`
## License
Artistic 2.0 © [Joey Baker](https://byjoeybaker.com)
[npm-url]: https://npmjs.org/package/smokestack-watch
[npm-image]: https://badge.fury.io/js/smokestack-watch.svg
[travis-url]: https://travis-ci.org/joeybaker/smokestack-watch
[travis-image]: https://travis-ci.org/joeybaker/smokestack-watch.svg?branch=master
[daviddm-url]: https://david-dm.org/joeybaker/smokestack-watch.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/joeybaker/smokestack-watch