cloak/markdown-reporter

This package is abandoned and no longer maintained. No replacement package was suggested.

markdown reporter for cloak

1.0.2 2014-09-23 09:08 UTC

Requires

• php: >=5.4.0
• cloak/cloak: 1.3.*

Requires (Dev)

• cloak/coverallskit: 1.3.*
• danielstjules/pho: 1.0.*
• jaz303/phake: 0.6.*
• mockery/mockery: 0.9.*

MIT

• holyshared

• markdown
• code coverage
• reporter
• cloak

README

It has been merged into 1.3.2.4 of cloak.
It is not maintenance now.

cloak-markdown-reporter is markdown reporter for cloak.
Output in markdown format the report of code coverage.

Installation

Composer setting

Cloak can be installed using Composer.
Please add a description to the composer.json in the configuration file.

{
	"require-dev": {
		"cloak/markdown-reporter": "1.0.2"
	}
}

Install

Please execute composer install command.

composer install

How to use

Setup for the report of code coverage

Setup is required to take a code coverage.
Run the configure method to be set up.

<?php

$analyzer = Analyzer::factory(function(ConfigurationBuilder $builder) {

	$builder->reporter(new MarkdownReporter(__DIR__ . '/report.lcov'));

	$builder->includeFile(function(File $file) {
    	return $file->matchPath('/src');
    })->excludeFile(function(File $file) {
	    return $file->matchPath('/spec') || $file->matchPath('/vendor');
    });

});

Example

You can try with the following command.

vendor/bin/phake example:basic