phpbcc/phpbcc

A tool that provides visibility on the authors of uncovered code.


Keywords
php, git, code, quality, coverage, blame
License
BSD-1-Clause

Documentation

PhpBCC

Build Status Coverage Status Latest Stable Version License

Php Blame Code Coverage

Overview

This tool takes in a code coverage report and uses the version control history to provide information on authors and their code coverage.

Reports supported:

  • Clover

Version Control:

  • Git

Installation

Global installation:

composer global require phpbcc/phpbcc

Local/project installation:

composer require phpbcc/phpbcc

or manually add it to the require-dev section of your composer file.

{ "require-dev" : { "phpbcc/phpbcc": "*" } }

Usage

> gitbcc --output-format=author reports/clover.xml

Sample Output

phpbcc version 1.0.0 by Chris Halbert

PHP BLAME CODE COVERAGE                                                UNCOVERED OBJECTS (#/total) %

Chris Halbert                                                                             (8/8) 100%
  FileNotFoundException.php:15, 16, 17, 18                                                 (4/8) 50%
  AbstractInput.php:39, 76, 78                                                           (3/8) 37.5%
  AuthorOutput.php:157                                                                   (1/8) 12.5%