guitarneck/php-coverage

php coverage reporting tool and framework

1.0.0 2022-11-28 22:05 UTC

Requires

• php: >=5.6.0
• composer-runtime-api: ^2.0.0

Requires (Dev)

• ext-uopz: ^6.1.2
• guitarneck/taphp: ^1.0

Suggests

• ext-pcov: *
• ext-xdebug: *

MIT

• Laurent S.

• php
• Xdebug
• dot
• coverage
• coveralls
• lcov
• clover
• pcov
• phpdebg

README

PHP Coverage

A PHP framework to retrieve code coverage and get reports of the result in various format.

Can be used with this coverage handlers :

• XDebug
• PHPDBG
• PCOV

And exports this formats :

• clover
• coverage
• coveralls
• dot (xdebug only)
• dump (xdebug only)
• export (PHP exported)
• json (PHP stringified)
• lcov
• raw
• serialize (PHP serialized)

Table of Contents

• Install
• Command
  • Options
  • Configuration
• Using .dot
• License

Install

composer require guitarneck/php-coverage --dev

Command

• Using php :

$ php bin/coverage <file> [args...]

• Using phpdbg :

$ phpdbg -qrr bin/coverage <file> [args...]

Options

   --debug                                Show debug informations.

   --excludes=,--excludes,-x              The paths to exclude. Separated by ','.
                                          Ex: vendor/,tests/,inc/lib/

   --format=,--format,-f                  The file format to be generated.
                                          [clover|coverage|coveralls|dot|dump|export|json|lcov|raw|serialize]
                                          dft: coverage

   --handler=,--handler                   The handler to use for coverage.
                                          [xdebug|phpdbg|pcov]
                                          dft: xdebug

   --help,-h                              This help page

   --includes=,--includes,-i              The paths to include. Separated by ','.
                                          Ex: src/,inc/

   --no-extra-filter                      Do not apply extra filtering (includes & excludes).

   --output-path=,--output-path,-p        The paths to output. Separated by ','.
                                          Ex: {DIR},..,reports
                                          - {DIR}: __DIR__ ('coverage/sources')
                                          - ..   : parent path

Configuration

Default configuration can be sets in sources/Coverage.json

Using .dot

Grahpviz is open source graph visualization software.

$ dot -Tsvg reports\\Hello.dot > Hello.svg

License

MIT © guitarneck