56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
|
# phpunit/php-code-coverage
|
||
|
|
|
||
|
|
[](https://packagist.org/packages/phpunit/php-code-coverage)
|
||
|
|
[](https://github.com/sebastianbergmann/php-code-coverage/actions)
|
||
|
|
[](https://shepherd.dev/github/sebastianbergmann/php-code-coverage)
|
||
|
|
[](https://codecov.io/gh/sebastianbergmann/php-code-coverage)
|
||
|
|
|
||
|
|
Provides collection, processing, and rendering functionality for PHP code coverage information.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
|
||
|
|
|
||
|
|
```
|
||
|
|
composer require phpunit/php-code-coverage
|
||
|
|
```
|
||
|
|
|
||
|
|
If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
|
||
|
|
|
||
|
|
```
|
||
|
|
composer require --dev phpunit/php-code-coverage
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php declare(strict_types=1);
|
||
|
|
use SebastianBergmann\CodeCoverage\Filter;
|
||
|
|
use SebastianBergmann\CodeCoverage\Driver\Selector;
|
||
|
|
use SebastianBergmann\CodeCoverage\CodeCoverage;
|
||
|
|
use SebastianBergmann\CodeCoverage\Report\Html\Facade as HtmlReport;
|
||
|
|
|
||
|
|
$filter = new Filter;
|
||
|
|
|
||
|
|
$filter->includeFiles(
|
||
|
|
[
|
||
|
|
'/path/to/file.php',
|
||
|
|
'/path/to/another_file.php',
|
||
|
|
]
|
||
|
|
);
|
||
|
|
|
||
|
|
$coverage = new CodeCoverage(
|
||
|
|
(new Selector)->forLineCoverage($filter),
|
||
|
|
$filter
|
||
|
|
);
|
||
|
|
|
||
|
|
$coverage->start('<name of test>');
|
||
|
|
|
||
|
|
// ...
|
||
|
|
|
||
|
|
$coverage->stop();
|
||
|
|
|
||
|
|
|
||
|
|
(new HtmlReport)->process($coverage, '/tmp/code-coverage-report');
|
||
|
|
```
|