Skip to content

Commit 09f1e6d

Browse files
committed
README: update example config
1 parent 33f11a6 commit 09f1e6d

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,22 +96,27 @@ default:
9696
processUncoveredFilesFromWhitelist: false
9797
include:
9898
directories:
99-
'src':
100-
prefix: 'src'
99+
'src': ~
101100
'tests':
102-
prefix: 'src'
103-
blacklist:
104-
include:
105-
directories:
106-
'vendor':
107-
prefix: 'vendor'
101+
suffix: '.php'
102+
# files:
103+
# - script1.php
104+
# - script2.php
105+
# exclude:
106+
# directories:
107+
# 'vendor': ~
108+
# 'path/to/dir':
109+
# 'suffix': '.php'
110+
# 'prefix': 'Test'
111+
# files:
112+
# - tests/bootstrap.php
108113
# report configuration
109114
report:
110115
# report format (html, clover, php, text)
111116
format: html
112117
# report options
113118
options:
114-
target:: build/behat-coverage/html
119+
target: build/behat-coverage/html
115120
```
116121

117122
### Configuration Options
@@ -139,13 +144,15 @@ default:
139144
- `processUncoveredFilesFromWhitelist` - (default: `false`)
140145
- `include` - a list of files or directories to include in whitelist:
141146
- `directories` - key containing whitelisted directories to include.
142-
- `suffix` - suffix for files to be included (default: `.php`)
143-
- `prefix` - prefix of files to be included (optional)
147+
- `suffix` - suffix for files to be included (default: `'.php'`)
148+
- `prefix` - prefix of files to be included (default: `''`)
149+
(optional)
144150
- `files` - a list containing whitelisted files to include.
145151
- `exclude` - a list of files or directories to exclude from whitelist:
146152
- `directories` - key containing whitelisted directories to exclude.
147-
- `suffix` - suffix for files to be included (default: `.php`)
148-
- `prefix` - prefix of files to be included (optional)
153+
- `suffix` - suffix for files to be included (default: `'.php'`)
154+
- `prefix` - prefix of files to be included (default: `''`)
155+
(optional)
149156
- `files` - key containing whitelisted files to exclude.
150157
- `report` - reporter options:
151158
- `format` - specify report format (`html`, `clover`, `php`, `text`)

0 commit comments

Comments
 (0)