# jest-watch-typeahead

> Jest plugin for filtering by filename or test name

Latest version **3.0.1** (published 2025-06-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install jest-watch-typeahead
pnpm add jest-watch-typeahead
yarn add jest-watch-typeahead
bun add jest-watch-typeahead
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2025-06-19 |
| First published | 2018-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 7 |
| Unpacked size | 18.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 412 |
| Author | Rogelio Guzman |
| Maintainers | simenb, rickhanlonii, thymikee, jsonp, orta, rogeliog, mattphillips, jeysal |

## Links

- npm: https://www.npmjs.com/package/jest-watch-typeahead
- Repository: https://github.com/jest-community/jest-watch-typeahead
- Issues: https://github.com/jest-community/jest-watch-typeahead/issues
- npm.io page: https://npm.io/package/jest-watch-typeahead

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [slash](https://npm.io/package/slash.md) ^5.0.0
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^7.0.1
- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^7.0.0
- [jest-watcher](https://npm.io/package/jest-watcher.md) ^30.0.0
- [string-length](https://npm.io/package/string-length.md) ^6.0.0
- [jest-regex-util](https://npm.io/package/jest-regex-util.md) ^30.0.0

## Recent versions

- 3.0.1 (latest) — 2025-06-19
- 0.2.2-1 (next) — 2019-03-21
- 3.0.0 — 2025-06-19
- 2.2.2 — 2023-01-24
- 2.2.1 — 2022-11-16
- 2.2.0 — 2022-09-10
- 2.1.1 — 2022-08-25
- 2.1.0 — 2022-08-25
- 2.0.0 — 2022-07-09
- 1.1.0 — 2022-04-25
- 1.0.0 — 2021-09-29
- 0.6.5 — 2021-09-28
- 0.6.4 — 2021-05-27
- 0.6.3 — 2021-04-23
- 0.6.2 — 2021-04-02
- … 17 more at https://npm.io/package/jest-watch-typeahead/versions

## 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)

<div align="center">
  <a href="https://jestjs.io/">
    <img width="150" height="150" vspace="" hspace="25" src="https://jestjs.io/img/jest.png">
  </a>
  <h1>jest-watch-typeahead</h1>
  <p>Filter your tests by file name or test name</p>
</div>

![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
```

---
_Source: https://npm.io/package/jest-watch-typeahead · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._