README

PHPCoverageBadge is a library for creating an SVG coverage badge from a PHPUnit Clover XML file.

Installation

Composer!

composer require --dev bushlanov-dev/php-coverage-badger

Usage

1. Generate XML Code Coverage using PHPUnit
2. Run vendor/bin/php-coverage-badger clover.xml badge.svg <optional text:default "coverage"> <optional --square>
   • e.g. vendor/bin/php-coverage-badger build/clover.xml report/square.svg --square
   • e.g. vendor/bin/php-coverage-badger build/clover.xml report/coverage.svg
   • e.g. vendor/bin/php-coverage-badger build/clover.xml report/phpunit.svg PHPUnit
   • e.g. vendor/bin/php-coverage-badger build/clover.xml report/your-text.svg "Aprx9chr"

Acknowledgements

This library is forked from Michael Moussa's php-coverage-checker, derived from Marco Pivetta's post on CI test coverage checks

Inspiration for generating an SVG badge from coverage results is taken from the coverage-badge Python library, derived from the Shields.io project.

License

This repository's source code is available under the MIT License.