Skip to content
This repository has been archived by the owner on Feb 19, 2021. It is now read-only.

Commit

Permalink
docs: Mention that Stryker doesn't work after ejecting a CRA project. (
Browse files Browse the repository at this point in the history
…#46)

Thanks
  • Loading branch information
mthmulders authored and Sander Koenders committed Apr 20, 2018
1 parent 94b22ab commit 4560d5e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ The stryker-jest-runner also provides a couple of configurable options using the

| option | description | default value |
|----|----|----|
| project (optional) | The project you are working on. Currently "react" and "default" are supported. When "react" is configured, "react-scripts" is used (for create-react-app projects). When "default" is configured, your "config" option is used. | default |
| project (optional) | The type of project you are working on. Currently "react" and "default" are supported. When "react" is configured, "react-scripts" is used (for create-react-app projects). When "default" is configured, your "config" option is used. | default |
| config (optional) | A custom jest configuration (you can also use `require` to load your config here) | undefined |

**Note:** When neither of the options are specified it will use the jest configuration in your "package.json". \
**Note:** the `project` option is ignored when the `config` option is specified.
**Note:** the `project` option is ignored when the `config` option is specified. \
**Note:** Stryker currently only works for CRA-projects that have not been _ejected_.

The following is an example stryker.conf.js file:

Expand Down

0 comments on commit 4560d5e

Please sign in to comment.