Skip to content

Commit 0479d14

Browse files
Update documentation
1 parent 5b191db commit 0479d14

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,27 @@ composer require --dev phpunit/php-code-coverage
2222

2323
## Usage
2424

25+
### Collecting code coverage data and generating a report
26+
2527
```php
2628
<?php declare(strict_types=1);
27-
use SebastianBergmann\CodeCoverage\Filter;
28-
use SebastianBergmann\CodeCoverage\Driver\Selector;
2929
use SebastianBergmann\CodeCoverage\CodeCoverage;
30-
use SebastianBergmann\CodeCoverage\Report\Html\Facade as HtmlReport;
30+
use SebastianBergmann\CodeCoverage\Driver\Selector as DriverSelector;
31+
use SebastianBergmann\CodeCoverage\Filter;
32+
use SebastianBergmann\CodeCoverage\Report\Facade as ReportFacade;
3133

3234
$filter = new Filter;
3335

3436
$filter->includeFiles(
3537
[
3638
'/path/to/file.php',
3739
'/path/to/another_file.php',
38-
]
40+
],
3941
);
4042

4143
$coverage = new CodeCoverage(
42-
(new Selector)->forLineCoverage($filter),
43-
$filter
44+
(new DriverSelector)->forLineCoverage($filter),
45+
$filter,
4446
);
4547

4648
$coverage->start('<name of test>');
@@ -49,6 +51,17 @@ $coverage->start('<name of test>');
4951

5052
$coverage->stop();
5153

54+
ReportFacade::fromObject($coverage)->renderOpenClover('/tmp/openclover.xml');
55+
```
56+
57+
### Generating a report from serialized code coverage data
58+
59+
```php
60+
<?php declare(strict_types=1);
61+
use SebastianBergmann\CodeCoverage\Report\Facade as ReportFacade;
62+
use SebastianBergmann\CodeCoverage\Serialization\Unserializer;
63+
64+
$data = (new Unserializer)->unserialize('/path/to/coverage.php');
5265

53-
(new HtmlReport)->process($coverage, '/tmp/code-coverage-report');
66+
ReportFacade::fromSerializedData($data)->renderOpenClover('/tmp/openclover.xml');
5467
```

0 commit comments

Comments
 (0)