A plugin to run [Jest](https://jestjs.io/) tests. This plugin uses [jest-cli](https://www.npmjs.com/package/jest-cli) to run the tests. You can configure this plugin by specifying the path to the Jest config path.
A plugin to run Jest tests. This plugin uses jest-cli to run the tests. You can configure this plugin by specifying the path to the Jest config path.
With Tool Kit already set up, install this plugin as a dev dependency:
``sh`
npm install --save-dev @dotcom-tool-kit/jest
And add it to your repo's .toolkitrc.yml:
`yaml`
plugins:
- '@dotcom-tool-kit/jest'
Runs jest to execute tests.
#### Task options
| Property | Description | Type |
| :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
| configPath | Path to the Jest config file. Use Jest's own config resolution by default. | string |ci
| | Whether to run Jest in CI mode. | true |
_All properties are optional._
A common use case is to configure test:local and test:ci in your .toolkitrc.yml to run the Eslint task then the relevant Jest task:
`yaml``
commands:
test:local:
- Eslint
- Jest
test:ci:
- Eslint
- Jest:
ci: true