Jest Circus environment template

A template for creating custom Jest Circus environments.

🗒️ Gist

If you'd rather not use this template, here is a Gist with the main interface for creating a Jest environment.

🚀 Quick start

1. Clone

git clone https://github.com/ryparker/jest-circus-environment-template.git jest-circus-environment && cd jest-circus-environment

2. Install dependencies

yarn install

3. Transpile to JS

yarn build

🔧 Using the environment

You will will need to add the environment's path to the testEnvironment option in your jest.config.js.

{ 
  "testEnvironment": "<rootDir>/my-custom-environment.js",
  "testRunner": "jest-circus/runner"
}

See the official Jest docs for more details.

Lifecycle events

Updated list available here

Bold items are async test events Italic items are synchronous test events

0. error
1. constructor
2. setup Fn
3. setup
4. add_hook
5. start_describe_definition
6. add_test
7. finish_describe_definition
8. run_start / test_skip / test_todo
9. run_describe_start
10. test_start
11. hook_start
12. hook_success / hook_failure
13. test_fn_start
14. test_fn_success / test_fn_failure / error
15. test_done
16. run_describe_finish
17. run_finish
18. teardown
19. teardown Fn

Related Projects

Jest Reporter: Template Project | Gist