phpunit/php-code-coverage

Library that provides collection, processing, and rendering functionality for PHP code coverage information.

Fund package maintenance!
sebastianbergmann

Installs: 299 699 693

Dependents: 1 117

Suggesters: 8

Security: 0

Stars: 8 002

Watchers: 57

Forks: 339

Open Issues: 28

9.2.7 2021-09-17 05:39 UTC

README

Latest Stable Version CI Status Type Coverage codecov

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:

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 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->includeDirectory('/path/to/directory');

$coverage = new CodeCoverage(
    (new Selector)->forLineCoverage($filter),
    $filter
);

$coverage->start('<name of test>');

// ...

$coverage->stop();


(new HtmlReport)->process($coverage, '/tmp/code-coverage-report');