phpunit/php-code-coverage

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

11.0.7 2024-10-09 06:21 UTC

Requires

• php: >=8.2
• ext-dom: *
• ext-libxml: *
• ext-xmlwriter: *
• nikic/php-parser: ^5.3.1
• phpunit/php-file-iterator: ^5.1.0
• phpunit/php-text-template: ^4.0.1
• sebastian/code-unit-reverse-lookup: ^4.0.1
• sebastian/complexity: ^4.0.1
• sebastian/environment: ^7.2.0
• sebastian/lines-of-code: ^3.0.1
• sebastian/version: ^5.0.2
• theseer/tokenizer: ^1.2.3

Requires (Dev)

• phpunit/phpunit: ^11.4.1

Suggests

• ext-pcov: PHP extension that provides line coverage
• ext-xdebug: PHP extension that provides line coverage as well as branch and path coverage

BSD-3-Clause

• Sebastian Bergmann

• testing
• coverage
• xunit

README

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->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');