mmapes/php-code-coverage-optional-whitelist

Fork with optional whitelist of Library that provides collection, processing, and rendering functionality for PHP code coverage information.

6.1.4 2018-10-31 16:06 UTC

Requires

• php: ^7.1
• ext-dom: *
• ext-xmlwriter: *
• phpunit/php-file-iterator: ^2.0
• phpunit/php-text-template: ^1.2.1
• phpunit/php-token-stream: ^3.0
• sebastian/code-unit-reverse-lookup: ^1.0.1
• sebastian/environment: ^3.1 || ^4.0
• sebastian/version: ^2.0.1
• theseer/tokenizer: ^1.1

Requires (Dev)

• phpunit/phpunit: ^7.0

Suggests

• ext-xdebug: ^2.6.0

BSD-3-Clause

• Sebastian Bergmann

• testing
• coverage
• xunit

README

PHP_CodeCoverage

PHP_CodeCoverage is a library that provides collection, processing, and rendering functionality for PHP code coverage information.

Requirements

PHP 5.6 is required but using the latest version of PHP is highly recommended.

PHP 5

Xdebug is the only source of raw code coverage data supported for PHP 5. Version 2.2.1 of Xdebug is required but using the latest version is highly recommended.

PHP 7

Version 2.4.0 (or later) of Xdebug as well as phpdbg are supported sources of raw code coverage data for PHP 7.

HHVM

A version of HHVM that implements the Xdebug API for code coverage (xdebug_*_code_coverage()) is required.

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

Using the PHP_CodeCoverage API

<?php
$coverage = new \SebastianBergmann\CodeCoverage\CodeCoverage;
$coverage->start('<name of test>');

// ...

$coverage->stop();

$writer = new \SebastianBergmann\CodeCoverage\Report\Clover;
$writer->process($coverage, '/tmp/clover.xml');

$writer = new \SebastianBergmann\CodeCoverage\Report\Html\Facade;
$writer->process($coverage, '/tmp/code-coverage-report');