@wordpress/jest-preset-default

@wordpress/jest-preset-default

Default Jest preset for WordPress development.

Installation

Install the module

npm install @wordpress/jest-preset-default --save-dev

Setup

Via jest.config.json or jest field in package.json

{
  "preset": "@wordpress/jest-preset-default"
}

Usage

Brief explanations of options included

• coverageDirectory - the directory where Jest outputs its coverage files is set to coverage.
• coveragePathIgnorePatterns - coverage information will be skipped for all folders named build and build-module.
• moduleNameMapper - all css and scss files containing CSS styles will be stubbed out.
• modulePaths - the root dir of the project is used as a location to search when resolving modules.
• setupFiles - runs code before each test which sets up global variables required in the testing environment.
• setupTestFrameworkScriptFile - runs code which adds improved support for Console object and React components to the testing framework before each test.
• testMatch- includes /test/ subfolder in the glob patterns Jest uses to detect test files. It detects only test files containing .js extension.
• timers - use of fake timers for functions such as setTimeout is enabled.
• transform - adds support for PEG.js transformed necessary for WordPress blocks. It also keeps the default babel-jest transformer.
• verbose - each individual test won't be reported during the run.

Overriding setupTestFrameworkScriptFile

It is also possible to override the script that runs some code to configure or set up the testing framework before each test. To do so you will need to create setup-test-framework.js inside your project with the following content:

// You can still load the default script provided by this setup
import '@wordpress/jest-preset-default';

// Your code goes here