https://github.com/jest-community/jest-watch-typeahead

Jest watch plugin for filtering test by file name or test name
https://github.com/jest-community/jest-watch-typeahead

Last synced: 3 months ago
JSON representation

Jest watch plugin for filtering test by file name or test name

• Host: GitHub
• URL: https://github.com/jest-community/jest-watch-typeahead
• Owner: jest-community
• License: mit
• Created: 2018-03-24T03:14:53.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T05:24:54.000Z (7 months ago)
• Last Synced: 2024-04-08T06:30:18.843Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 9.36 MB
• Stars: 408
• Watchers: 4
• Forks: 19
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jest - jest-watch-typeahead

README

        
[![Build Status](https://github.com/jest-community/jest-watch-typeahead/actions/workflows/nodejs.yml/badge.svg?branch=main)](https://github.com/jest-community/jest-watch-typeahead/actions/workflows/nodejs.yml) [![npm version](https://badge.fury.io/js/jest-watch-typeahead.svg)](https://badge.fury.io/js/jest-watch-typeahead)



  

    

  

  
jest-watch-typeahead

  
Filter your tests by file name or test name



![watch](https://user-images.githubusercontent.com/574806/40672937-25dab91a-6325-11e8-965d-4e55ef23e135.gif)

## Usage

### Install

Install `jest`_(it needs Jest 27+)_ and `jest-watch-typeahead`

```bash

yarn add --dev jest jest-watch-typeahead

# or with NPM

npm install --save-dev jest jest-watch-typeahead

```

### Add it to your Jest config

In your `package.json`

```json

{

  "jest": {

    "watchPlugins": [

      "jest-watch-typeahead/filename",

      "jest-watch-typeahead/testname"

    ]

  }

}

```

Or in `jest.config.js`

```js

module.exports = {

  watchPlugins: [

    'jest-watch-typeahead/filename',

    'jest-watch-typeahead/testname',

  ],

};

```

### Configuring your key and prompt name

```js

module.exports = {

  watchPlugins: [

    [

      'jest-watch-typeahead/filename',

      {

        key: 'k',

        prompt: 'do something with my custom prompt',

      },

    ],

  ],

};

```

### Run Jest in watch mode

```bash

yarn jest --watch

```