README

This project is abandoned, and replaced by php-coverage

XDebugCoverage

A PHP framework to run XDebug Code Coverage and get reports of the result.

Table of Contents

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

Install

composer require guitarneck/xdebug-coverage --dev

Command

$ coverage/coverage tests/Something.test.php [options]

Options

   --debug

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

   --format=,--format,-F                  The file format to be generated.

   --help,-h                              This help page

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

   --no-extra-filter

   --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 coverage/sources/XDebugCoverage.json

Using .dot

Grahpviz is open source graph visualization software.

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

License

MIT © guitarneck