cloak/markdown-reporter

markdown reporter for cloak

cloak-markdown-reporter

It has been merged into 1.3.2.4 of cloak.
It is not maintenance now., _(*1)

cloak-markdown-reporter is markdown reporter for cloak.
Output in markdown format the report of code coverage., _(*2)

, _(*3)

Installation

Composer setting

Cloak can be installed using Composer.
Please add a description to the composer.json in the configuration file., _(*4)

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

Install

Please execute composer install command., _(*5)

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., _(*6)

<?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., _(*7)

vendor/bin/phake example:basic