readme.md

@dotcom-tool-kit/jest

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:

npm install --save-dev @dotcom-tool-kit/jest

And add it to your repo's .toolkitrc.yml:

plugins:
    - '@dotcom-tool-kit/jest'

Key	Description	Default value
`configPath`	Path to the Jest config file	use Jest's own config resolution

Task	Description	Preconfigured hook
`JestLocal`	runs `jest` to execute tests	`test:local`
`JestCI`	runs `jest` to execute tests in the CI with the `--ci` option	`test:ci`

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:

hooks:
  test:local:
    - Eslint
    - JestLocal
  test:ci:
    - Eslint
    - JestCI