Skip to content

Commit

Permalink
Updated README with config info
Browse files Browse the repository at this point in the history
  • Loading branch information
Hargne committed Feb 11, 2025
1 parent df2b8c1 commit 6d1d416
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,24 @@ To run the reporter as a test results processor (after Jest is complete instead
}
```

***Note:** When running as a testResultsProcessor, the configuration needs be placed within a new file named `jesthtmlreporter.config.json` residing in the root folder.*
**Note:** When running as a testResultsProcessor, the configuration needs either to be placed within a new file named `jesthtmlreporter.config.json` residing in the root folder

```JSON
{
"pageTitle": "Test Report",
}
```

or via adding a key to `package.json` named "jest-html-reporter":

```JSON
{
...
"jest-html-reporter": {
"pageTitle": "Test Report",
}
}
```

## 📌 Configuration Options (All Optional)

Expand Down Expand Up @@ -93,7 +110,7 @@ All the configuration options provided in the table above are available via envi

**Example:** `customScriptPath` -> `JEST_HTML_REPORTER_CUSTOM_SCRIPT_PATH`

***NOTE:** Environment variables will take precedence over configurations set in jesthtmlreporter.config.json and package.json*
**\*NOTE:** Environment variables will take precedence over configurations set in jesthtmlreporter.config.json and package.json\*

### CI Example

Expand Down

0 comments on commit 6d1d416

Please sign in to comment.