Skip to content

Commit 5b0b725

Browse files
committed
Sync docs with implementation
1 parent dd332c9 commit 5b0b725

1 file changed

Lines changed: 44 additions & 25 deletions

File tree

docs/configuration.rst

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ By default uncovered files are **included** but not **processed**.
126126
return (new Config())
127127
->withProfile((new Profile('default'))
128128
->withExtension(new Extension(CodeCoverageExtension::class, [
129-
'includeUncoveredFiles' => true // defaults to true
129+
'filter' => [
130+
'includeUncoveredFiles' => true // defaults to true
131+
]
130132
])));
131133
132134
.. code:: yaml
@@ -190,6 +192,7 @@ run. It is configured by setting the ``text`` key. The default values are outlin
190192
showUncoveredFiles: false
191193
lowUpperBound: 50
192194
highLowerBound: 90
195+
target: ~ # defaults to null, i.e. only output to screen
193196
194197
* If ``showColors`` is ``true``, the results will be output in a colour-coded format, red for low coverage, amber/yellow
195198
for a medium amount of coverage and green for high coverage. If desired, the thresholds for each colour can be
@@ -225,11 +228,24 @@ basis. It is configured by setting the ``html`` key. The default values are outl
225228
'lowUpperBound' => 50,
226229
'highLowerBound' => 90,
227230
'colors' => [
228-
'successLow => '#dff0d8',
229-
'successMedium => '#c3e3b5',
230-
'successHigh => '#99cb84',
231-
'warning => '#fcf8e3',
232-
'danger => '#f2dede',
231+
'successLow' => '#d6e6f2',
232+
'successLowDark' => '#1e3550',
233+
'successMedium' => '#b3d1e8',
234+
'successMediumDark' => '#2d4f6e',
235+
'successHigh' => '#8cb4d5',
236+
'successHighDark' => '#2a4a6b',
237+
'successBar' => '#1a73b4',
238+
'successBarDark' => '#1560a0',
239+
'warning' => '#fdf0d5',
240+
'warningDark' => '#3d3010',
241+
'warningBar' => '#e5a100',
242+
'warningBarDark' => '#b88a00',
243+
'danger' => '#fad4c0',
244+
'dangerDark' => '#4a2a10',
245+
'dangerBar' => '#d45500',
246+
'dangerBarDark' => '#b54400',
247+
'breadcrumbs' => 'var(--bs-gray-200)',
248+
'breadcrumbsDark' => 'var(--bs-gray-800)',
233249
],
234250
'customCSSFile' => null, // defaults to null, i.e. no custom CSS file
235251
],
@@ -247,24 +263,24 @@ basis. It is configured by setting the ``html`` key. The default values are outl
247263
lowUpperBound: 50
248264
highLowerBound: 90
249265
colors:
250-
successLow: #d6e6f2'
251-
successLowDark: #1e3550'
252-
successMedium: #b3d1e8'
253-
successMediumDark: #2d4f6e'
254-
successHigh: #8cb4d5'
255-
successHighDark: #2a4a6b'
256-
successBar: #1a73b4'
257-
successBarDark: #1560a0'
258-
warning: #fdf0d5'
259-
warningDark: #3d3010'
260-
warningBar: #e5a100'
261-
warningBarDark: #b88a00'
262-
danger: #fad4c0'
263-
dangerDark: #4a2a10'
264-
dangerBar: #d45500'
265-
dangerBarDark: #b54400'
266-
breadcrumbs: var(--bs-gray-200)'
267-
breadcrumbsDark: var(--bs-gray-800)'
266+
successLow: '#d6e6f2'
267+
successLowDark: '#1e3550'
268+
successMedium: '#b3d1e8'
269+
successMediumDark: '#2d4f6e'
270+
successHigh: '#8cb4d5'
271+
successHighDark: '#2a4a6b'
272+
successBar: '#1a73b4'
273+
successBarDark: '#1560a0'
274+
warning: '#fdf0d5'
275+
warningDark: '#3d3010'
276+
warningBar: '#e5a100'
277+
warningBarDark: '#b88a00'
278+
danger: '#fad4c0'
279+
dangerDark: '#4a2a10'
280+
dangerBar: '#d45500'
281+
dangerBarDark: '#b54400'
282+
breadcrumbs: 'var(--bs-gray-200)'
283+
breadcrumbsDark: 'var(--bs-gray-800)'
268284
customCSSFile: ~ # defaults to null, i.e. no custom CSS file
269285
270286
* The mandatory ``target`` key specifies the target directory to place the report files.
@@ -395,6 +411,7 @@ key. The default values are outlined below:
395411
crap4j:
396412
target: <file> # no default value, you must specify
397413
name: ''
414+
threshold: 30
398415
399416
* The mandatory ``target`` key specifies the destination filename to use for the report. The reports are in XML format,
400417
an ``.xml`` file extension is suggested.
@@ -420,6 +437,7 @@ You can generate ".cov" reports by setting the ``serialized`` key.
420437
'reports' => [
421438
'serialized' => [
422439
'target' => '<file>', // no default value, you must specify
440+
'includeGitInformation' => false,
423441
],
424442
],
425443
])));
@@ -430,8 +448,9 @@ You can generate ".cov" reports by setting the ``serialized`` key.
430448
extensions:
431449
DVDoug\Behat\CodeCoverage\Extension:
432450
reports:
433-
php:
451+
serialized:
434452
target: <file> # no default value, you must specify
453+
includeGitInformation: false
435454
436455
* The mandatory ``target`` key specifies the destination filename to use for the report. The reports are actually PHP,
437456
but a ``.cov`` file extension is customary.

0 commit comments

Comments
 (0)