# jest progress tracker

[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![GitHub NodeJS][github-nodejs]][github-action-url]
[![Codecov][codecov-image]][codecov-url]

Track test progress for jest.

## Requirements

`jest-progress-tracker` is an ES module. It needs Node 20+ and Jest 27+
(Jest loads a reporter with `requireOrImportModule`, which imports an ES module).
`require('jest-progress-tracker')` is not supported.

## Usage

To use `jest-progress-tracker`,
add it to the `reporters` section of the Jest configuration:

```js
{
  "jest": {
    "reporters": [
      "default", // using default reporter
      "jest-progress-tracker"
    ]
  }
}
```

This works for both plain runs and watch mode. Jest builds a fresh reporter for
every run, so a run narrowed by `-t` / `--testPathPatterns` is recorded with a
`filtered` flag, including when the pattern is changed mid-watch.

Note this is a `reporters` entry, not a `watchPlugins` entry.

[codecov-image]: https://codecov.io/gh/repobuddy/jest-progress-tracker/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/repobuddy/jest-progress-tracker
[downloads-image]: https://img.shields.io/npm/dm/jest-progress-tracker.svg?style=flat
[downloads-url]: https://npmjs.org/package/jest-progress-tracker
[github-nodejs]: https://github.com/repobuddy/jest-progress-tracker/workflows/release/badge.svg
[github-action-url]: https://github.com/repobuddy/jest-progress-tracker/actions
[npm-image]: https://img.shields.io/npm/v/jest-progress-tracker.svg?style=flat
[npm-url]: https://npmjs.org/package/jest-progress-tracker