Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unional/jest-watch-exec
Execute scripts during the watch cycle
https://github.com/unional/jest-watch-exec
jest jest-watch-plugin
Last synced: about 2 months ago
JSON representation
Execute scripts during the watch cycle
- Host: GitHub
- URL: https://github.com/unional/jest-watch-exec
- Owner: unional
- License: mit
- Created: 2018-10-26T01:10:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:44:24.000Z (12 months ago)
- Last Synced: 2024-05-20T13:33:55.264Z (7 months ago)
- Topics: jest, jest-watch-plugin
- Language: TypeScript
- Homepage:
- Size: 1.08 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jest - jest-watch-exec
README
# jest-watch-exec
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![Circle CI][circleci-image]][circleci-url]
[![Travis CI][travis-image]][travis-url]
[![Codecov][codecov-image]][codecov-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Greenkeeper][greenkeeper-image]][greenkeeper-url]
[![Semantic Release][semantic-release-image]][semantic-release-url]
[![Visual Studio Code][vscode-image]][vscode-url]
[![Wallaby.js][wallaby-image]][wallaby-url]
Execute commands on start or when the all tests pass.
Requires `jest@23+`.
## Usage
To use `jest-watch-exec`,
add it to the `watchPlugins` section of the Jest configuration:
```js
{
"jest": {
"watchPlugins": [
["jest-watch-exec", { "on-start": "npm run build" }],
["jest-watch-exec", { "on-start-script": "somescript.js" }],
// Will run the `run(): boolean | Promise` method exposed by the module
["jest-watch-exec", { "on-start-module": "modulescript.js" }],
// Will run test even if on-start | on-start-script | on-start-module fails.
["jest-watch-exec", { "on-start-ignore-error": true, ... }],
// execute script when there are passing tests.
// will not execute if the tests are filtered.
["jest-watch-exec", { "on-pass": "npm run build" }],
// execute 'on-pass' even the tests are filtered.
["jest-watch-exec", { "on-pass": "npm run build", "exec-while-filtered": true }]
]
}
}
```
- `on-start-ignore-error`: The script is considered failed if it:
- returns a falsy value,
- throws an error,
- returns a promise resolves to false, or
- returns a rejected promise.
## Contribute
```sh
# after fork and clone
npm install
# begin making changes
git checkout -b
npm run watch
# after making change(s)
git commit -m ""
git push
# create PR
```
[circleci-image]: https://circleci.com/gh/unional/jest-watch-exec/tree/master.svg?style=shield
[circleci-url]: https://circleci.com/gh/unional/jest-watch-exec/tree/master
[codecov-image]: https://codecov.io/gh/unional/jest-watch-exec/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/unional/jest-watch-exec
[coveralls-image]: https://coveralls.io/repos/github/unional/jest-watch-exec/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/unional/jest-watch-exec?branch=master
[downloads-image]: https://img.shields.io/npm/dm/jest-watch-exec.svg?style=flat
[downloads-url]: https://npmjs.org/package/jest-watch-exec
[greenkeeper-image]: https://badges.greenkeeper.io/unional/jest-watch-exec.svg
[greenkeeper-url]: https://greenkeeper.io/
[npm-image]: https://img.shields.io/npm/v/jest-watch-exec.svg?style=flat
[npm-url]: https://npmjs.org/package/jest-watch-exec
[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[travis-image]: https://img.shields.io/travis/unional/jest-watch-exec/master.svg?style=flat
[travis-url]: https://travis-ci.org/unional/jest-watch-exec?branch=master
[vscode-image]: https://img.shields.io/badge/vscode-ready-green.svg
[vscode-url]: https://code.visualstudio.com/
[wallaby-image]: https://img.shields.io/badge/wallaby.js-configured-green.svg
[wallaby-url]: https://wallabyjs.com