@@ -80,11 +80,16 @@ https://jgiven.org/jgiven-report/html5/[HTML report of JGiven itself]
80
80
81
81
=== AsciiDoc Report
82
82
83
+ [CAUTION]
84
+ ====
85
+ The generator for AsciiDoc reports is currently still in an experimental phase.
86
+ Not all functions of the HTML report are supported.
87
+ ====
88
+
83
89
To generate an AsciiDoc report you have to run the JGiven report generator with the `asciidoc` format option.
84
90
The report generator can be executed on the command line as follows
85
91
(assuming that the `jgiven-core` JAR and all required dependencies are on the Java CLASSPATH)
86
92
87
-
88
93
[source,console]
89
94
----
90
95
$ java com.tngtech.jgiven.report.ReportGenerator \
@@ -126,32 +131,38 @@ For Maven there exists a plugin that can be used as follows:
126
131
You can add the following configuration options (like the _format_ configuration above) to customize the report.
127
132
All of them are optional.
128
133
129
- [cols="1,3" ]
134
+ [%autowidth ]
130
135
.Configuration Options for Reports
131
136
|===
132
- |Option |Description
137
+ |Option |Default value | Description
133
138
134
139
|format
135
- |The format of the generated report. Can be _html_, _text_ or _asciidoc_. Default: _html_
140
+ |`html`
141
+ |The format of the generated report. Can be _html_, _text_ or _asciidoc_.
136
142
137
143
|title
138
- |The title of the generated report. Default: _JGiven Report_
144
+ |`JGiven Report`
145
+ |The title of the generated report.
139
146
140
147
|customCssFile
141
- |Custom CSS file to customize the HTML report. Default: _src/test/resources/jgiven/custom.css_
148
+ |`src/test/resources/jgiven/custom.css`
149
+ |Custom CSS file to customize the HTML report.
142
150
143
151
|customJsFile
144
- |Custom JS file to customize the HTML report. Default: _src/test/resources/jgiven/custom.js_
152
+ |`src/test/resources/jgiven/custom.js`
153
+ |Custom JS file to customize the HTML report.
145
154
146
155
|excludeEmptyScenarios
147
- |Whether or not to exclude empty scenarios, i.e. scenarios without any steps, from the report. Default: _false_
156
+ |`false`
157
+ |Whether or not to exclude empty scenarios, i.e. scenarios without any steps, from the report.
148
158
149
159
|outputDirectory
150
- |Directory where the reports are generated to. Default: _${project.build.directory}/jgiven-reports/html_
160
+ |`${project.build.directory}/jgiven-reports/html`
161
+ |Directory where the reports are generated to.
151
162
152
163
|sourceDirectory
153
- |Directory to read the JSON report files from. Default: _ ${project.build.directory}/jgiven-reports/json_
154
-
164
+ |` ${project.build.directory}/jgiven-reports/json`
165
+ |Directory to read the JSON report files from.
155
166
|===
156
167
157
168
Now run:
0 commit comments