Skip to content

README.md

Latest commit

 

History

History
102 lines (71 loc) · 2.17 KB

README.md

File metadata and controls

102 lines (71 loc) · 2.17 KB

Coverage Converter

Converts PHPUnit's Clover XML coverage report into compact JSON for LLM analysis.

Basic Usage

Generate a Clover report, then convert it:

vendor/bin/phpunit --coverage-clover=coverage/clover.xml --coverage-filter src
php scripts/clover-to-json.php coverage/clover.xml > coverage/coverage-summary.json

Output

JSON with three sections:

  • generated – Unix timestamp
  • totals – Project-wide coverage
  • files – Per-file breakdown with uncovered line numbers

Example:

{
  "generated": "1763041588",
  "totals": {
    "statements": 45,
    "covered_statements": 27,
    "coverage_percent": 60
  },
  "files": [
    {
      "file": "/path/to/src/functions.php",
      "statements": 45,
      "covered_statements": 27,
      "coverage_percent": 60,
      "uncovered_lines": [38, 46, 65, 66, 67]
    }
  ]
}

Filter Results

Show files below 80% coverage:

php scripts/clover-to-json.php coverage/clover.xml --min-percent 80

Show the 5 lowest-coverage files:

php scripts/clover-to-json.php coverage/clover.xml --top 5

Combine filters:

php scripts/clover-to-json.php coverage/clover.xml --top 10 --min-percent 90

Using With LLMs

Paste the JSON into your LLM conversation to get targeted suggestions:

"Here's my code coverage report. Which untested lines pose the highest risk?"

Or ask specific questions:

"Lines 65-76 in functions.php are untested. What test cases should I add?"

The compact format keeps token usage low while giving the LLM everything it needs.

How It Works

The script:

  1. Parses the Clover XML file
  2. Extracts project totals from <project><metrics>
  3. Collects per-file metrics from <file><metrics>
  4. Finds uncovered lines via XPath query for <line type="stmt" count="0">
  5. Sorts files by coverage (lowest first)
  6. Applies optional filters
  7. Outputs JSON to stdout

Requirements

  • PHP 8.0+
  • SimpleXML extension (bundled with PHP)
  • A Clover XML report from PHPUnit

Error Handling

The script exits with specific codes:

  • 0 - Success
  • 2 - File not readable
  • 3 - XML parsing failed

Errors go to stderr, so you can safely redirect stdout to a file.