Skip to content

Commit

Permalink
Merge pull request #18 from yangshun/patch-1
Browse files Browse the repository at this point in the history
Clean up README
  • Loading branch information
palmerj3 authored Jul 12, 2017
2 parents 38e72d4 + 57a7696 commit f7de5d8
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,23 @@ jest

## Configuration

jest-junit offers five configurations based on environment variables. All are **string** values.
`jest-junit` offers five configurations based on environment variables. All are **string** values

```JEST_SUITE_NAME```: Default "jest tests"

```JEST_JUNIT_OUTPUT```: Default "./junit.xml"

```JEST_JUNIT_CLASSNAME```: Default "{classname}-{title}"

```JEST_JUNIT_TITLE```: Default "{classname}-{title}"

```JEST_USE_PATH_FOR_SUITE_NAME```: Default "false"
| Variable Name | Default |
|--|--|
| `JEST_SUITE_NAME` | `"jest tests"` |
| `JEST_JUNIT_OUTPUT` | `"./junit.xml"` |
| `JEST_JUNIT_CLASSNAME` | `"{classname} {title}"` |
| `JEST_JUNIT_TITLE` | `"{classname} {title}"` |
| `JEST_USE_PATH_FOR_SUITE_NAME` | `"false"` |

Example:

```shell
JEST_SUITE_NAME="Jest JUnit Unit Tests" JEST_JUNIT_OUTPUT="./artifacts/junit.xml" jest
```

You can also define a `jest-junit` key in your package.json. All are **string** values.
You can also define a `jest-junit` key in your `package.json`. All are **string** values.

```
{
Expand Down

0 comments on commit f7de5d8

Please sign in to comment.