Skip to content

Commit 791f56f

Browse files
committed
Document and explain messages reports
1 parent cac92b0 commit 791f56f

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

docs/messages-report.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Messages reports
2+
3+
"Messages" refers to [Cucumber Messages](https://github.com/cucumber/common/tree/main/messages) and is a low-level report / protocol for representing results and other information from Cucumber. JSON reports and HTML reports are derived from this report. Hence, messages report will implicitly be enabled if either of the mentioned reports are.
4+
5+
Messages reports can be enabled using the `messages.enabled` property. The preprocessor uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig), which means you can place configuration options in EG. `.cypress-cucumber-preprocessorrc.json` or `package.json`. An example configuration is shown below.
6+
7+
```json
8+
{
9+
"messages": {
10+
"enabled": true
11+
}
12+
}
13+
```

docs/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
* [State management](state-management.md)
77
* [Step definitions](step-definitions.md)
88
* [Tags](tags.md)
9-
* [JSON report](json-report.md)
10-
* [HTML report](html-report.md)
9+
* Reports
10+
* [Messages report](messages-report.md)
11+
* [JSON report](json-report.md)
12+
* [HTML report](html-report.md)
1113
* [Localisation](localisation.md)
1214
* [Configuration](configuration.md)
1315
* [Test configuration](test-configuration.md)

0 commit comments

Comments
 (0)