Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jest-community/jest-watch-toggle-config
Jest watch plugin for toggling boolean settings (e.g. verbosity, test coverage)
https://github.com/jest-community/jest-watch-toggle-config
Last synced: 30 days ago
JSON representation
Jest watch plugin for toggling boolean settings (e.g. verbosity, test coverage)
- Host: GitHub
- URL: https://github.com/jest-community/jest-watch-toggle-config
- Owner: jest-community
- License: mit
- Created: 2018-07-10T10:54:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T01:39:34.000Z (about 1 year ago)
- Last Synced: 2024-05-19T14:30:39.332Z (7 months ago)
- Language: JavaScript
- Size: 397 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jest - jest-watch-toggle-config
README
# Jest Watch Toggle Config Plugin
[](https://travis-ci.org/jest-community/jest-watch-toggle-config) [](https://badge.fury.io/js/jest-watch-toggle-config)
jest-watch-toggle-config
Toggle your Jest boolean config settings at will
## Usage
### Install
Install `jest`_(it needs Jest 23.4.1+)_ and `jest-watch-toggle-config`
```bash
yarn add --dev jest jest-watch-toggle-config
# or with NPM
npm install --save-dev jest jest-watch-toggle-config
```
### Add it to your Jest config
Since Jest 23.3, you can provide per-instance watch plugin configuration. Jest 23.4.1 opens up the list of global configuration settings that can be altered by watch plugins. Together, these evolutions let us use this same plugin in multiple ways, as along as the targeted configuration setting is boolean.
There are three mandatory configuration items you need to provide:
1. `setting` is the boolean Jest configuration setting you want to toggle. Boolean settings available for configuration through watch plugins, as of Jest 23.4.1, include [`bail`](https://jestjs.io/docs/en/configuration#bail-boolean), [`collectCoverage`](https://jestjs.io/docs/en/configuration#collectcoverage-boolean), `noSCM`, [`notify`](https://jestjs.io/docs/en/configuration#notify-boolean), `onlyFailures`, [`passWithNoTests`](https://jestjs.io/docs/en/cli#passwithnotests) and [`verbose`](https://jestjs.io/docs/en/configuration#verbose-boolean).
2. `key` is the keyboard key that will be bound to this plugin instance, toggling the setting you’re interested in. We actually provide a default key for each option, trying our best not to step on Jest’s built-in keys, but they might conflict with another plugin's key. So you can tweak it.
3. `prompt` is the plugin prompt displayed in the watch menu. In this text, you can use the `%ONOFF%` placeholder, that will be dynamically replaced by either `on` or `off`, depending on the resulting setting value. We also provide good defaults for the options listed above, but feel free to tweak them.
Here’s an example for toggling both test verbosity (details of passed/failed tests) and code coverage collection with this plugin.
In your `package.json`:
```json
{
"jest": {
"watchPlugins": [
["jest-watch-toggle-config", { "setting": "verbose" }],
["jest-watch-toggle-config", { "setting": "collectCoverage" }]
]
}
}
```
Or in `jest.config.js`
```js
module.exports = {
// …
watchPlugins: [
['jest-watch-toggle-config', { setting: 'verbose' }],
['jest-watch-toggle-config', { setting: 'collectCoverage' }],
],
}
```
### Run Jest in watch mode
```bash
yarn jest --watch
# or with NPM
npx jest --watch
```
### List of options that have default keys and prompts
As of Jest 23.4.1, the following boolean options have sane defaults you can leverage to lighten your configuration:
| Option | Key | Prompt |
| ------------------------------------------------------------------------------------ | ----- | ------------------------------------- |
| [`bail`](https://jestjs.io/docs/en/configuration#bail-boolean) | `b` | turn %ONOFF% bailing at first error |
| [`collectCoverage`](https://jestjs.io/docs/en/configuration#collectcoverage-boolean) | `e`\* | turn %ONOFF% code coverage collection |
| [`notify`](https://jestjs.io/docs/en/configuration#notify-boolean) | `n` | turn %ONOFF% desktop notifications |
| [`verbose`](https://jestjs.io/docs/en/configuration#verbose-boolean) | `v` | turn %ONOFF% test verbosity |
_\* Jest already reserves `c`, `o` and `v`…_