bushlanov-dev/php-coverage-badger

Create a code coverage badge from a PHPUnit Clover XML file.

Maintainers

Details

github.com/BushlanovDev/php-coverage-badger

Homepage

Source

Installs: 303

Dependents: 3

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 8

pkg:composer/bushlanov-dev/php-coverage-badger

2.1.0 2025-08-24 17:24 UTC

Requires

  • php: >=7.0
  • ext-simplexml: *

MIT b891877c94696f338f3226ea394b8017270fca7c

This package is auto-updated.

Last update: 2025-10-07 20:25:15 UTC

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 coverage
    • e.g. vendor/bin/php-coverage-badger build/clover.xml report/coverage.svg coverage
    • e.g. vendor/bin/php-coverage-badger build/clover.xml report/phpunit.svg PHPUnit PHPUnit
    • e.g. vendor/bin/php-coverage-badger build/clover.xml report/your-text.svg "Aprx9chr" your-text

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.