Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

jest-circus

Package Overview
Dependencies
19
Maintainers
6
Versions
233
Issues
File Explorer

Advanced tools

jest-circus

[type-definitions]: https://github.com/facebook/jest/blob/main/packages/jest-types/src/Circus.ts

    29.4.1latest
    Github

Version published
Maintainers
6
Weekly downloads
16,036,695
increased by8.47%

Weekly downloads

Changelog

Source

29.4.1

Features

  • [expect, jest-circus, @jest/types] Implement numPassingAsserts of testResults to track the number of passing asserts in a test (#13795)
  • [jest-core] Add newlines to JSON output (#13817)
  • [@jest/reporters] Automatic log folding in GitHub Actions Reporter (#13626)

Fixes

  • [@jest/expect-utils] toMatchObject diffs should include Symbol properties (#13810)
  • [jest-runtime] Handle missing replaceProperty (#13823)
  • [@jest/types] Add partial support for done callbacks in typings of each (#13756)

Readme

Source

jest-circus

The next-gen test runner for Jest

Overview

Circus is a flux-based test runner for Jest that is fast, maintainable, and simple to extend.

Circus allows you to bind to events via an optional event handler on any custom environment. See the type definitions for more information on the events and state data currently available.

import {Event, State} from 'jest-circus'; import {TestEnvironment as NodeEnvironment} from 'jest-environment-node'; class MyCustomEnvironment extends NodeEnvironment { //... async handleTestEvent(event: Event, state: State) { if (event.name === 'test_start') { // ... } } }

Mutating event or state data is currently unsupported and may cause unexpected behavior or break in a future release without warning. New events, event data, and/or state data will not be considered a breaking change and may be added in any minor release.

Note, that jest-circus test runner would pause until a promise returned from handleTestEvent gets fulfilled. However, there are a few events that do not conform to this rule, namely: start_describe_definition, finish_describe_definition, add_hook, add_test or error (for the up-to-date list you can look at SyncEvent type in the types definitions). That is caused by backward compatibility reasons and process.on('unhandledRejection', callback) signature, but that usually should not be a problem for most of the use cases.

Installation

Note: As of Jest 27, jest-circus is the default test runner, so you do not have to install it to use it.

Install jest-circus using yarn:

yarn add --dev jest-circus

Or via npm:

npm install --save-dev jest-circus

Configure

Configure Jest to use jest-circus via the testRunner option:

{ "testRunner": "jest-circus/runner" }

Or via CLI:

jest --testRunner='jest-circus/runner'

FAQs

What is jest-circus?

[type-definitions]: https://github.com/facebook/jest/blob/main/packages/jest-types/src/Circus.ts

Is jest-circus popular?

The npm package jest-circus receives a total of 15,394,993 weekly downloads. As such, jest-circus popularity was classified as popular.

Is jest-circus well maintained?

We found that jest-circus demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 6 open source maintainers collaborating on the project.

Last updated on 26 Jan 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc