codebtech/coveragebadge

Creates code coverage badge from Clover XML files.

v0.3.7 2024-11-01 14:59 UTC

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.11
• phpstan/phpstan-deprecation-rules: ^1.2
• phpstan/phpstan-strict-rules: ^1.6
• phpunit/phpunit: ^11.1
• slevomat/coding-standard: ^8.15
• squizlabs/php_codesniffer: ^3.10

MIT

• Mohan Raj

README

CoverageBadge is a PHP library for creating SVG coverage badges from Clover XML files.

Installation

composer require codebtech/coveragebadge --dev

Features

• Produces a code coverage badge utilizing a Clover coverage XML file
• Creates a code coverage badge from several Clover XML files, automatically incorporating the coverage percentages
• Accepts a coverage name as an input to include in the generated badge

Usage

• Execute the command to generate badge for single Clover XML input

vendor/bin/coverage-badge /path/to/clover.xml /path/to/badge/destination.svg test-name

• To blend multiple Clover files, enumerate the XML inputs separated by commas and use the command

vendor/bin/coverage-badge /path/to/clover.xml,/path/to/clover2.xml /path/to/badge/destination.svg test-name

Acknowledgements

This library is inspired by JASchilz/PHPCoverageBadge