Skip to content
This repository has been archived by the owner on Aug 17, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@holyshared
holyshared committed Apr 26, 2015
1 parent 8dd645a commit bc4d09d
Showing 1 changed file with 1 addition and 60 deletions.
61 changes: 1 addition & 60 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1 @@
CoverallsKit====================================[![Build Status](https://travis-ci.org/cloak-php/coveralls-kit.svg?branch=master)](https://travis-ci.org/cloak-php/coveralls-kit)
[![Build Status](https://drone.io/github.com/cloak-php/coveralls-kit/status.png)](https://drone.io/github.com/cloak-php/coveralls-kit/latest)
[![Circle CI](https://circleci.com/gh/cloak-php/coveralls-kit.svg?style=svg)](https://circleci.com/gh/cloak-php/coveralls-kit)
[![Build Status](https://codeship.com/projects/af9497a0-70ab-0132-4b61-227a26fe7ed7/status?branch=master)](https://codeship.com/projects/54536)


[![Latest Stable Version](https://poser.pugx.org/cloak/coverallskit/v/stable.svg)](https://packagist.org/packages/cloak/coverallskit) [![License](https://poser.pugx.org/cloak/coverallskit/license.svg)](https://packagist.org/packages/cloak/coverallskit)
[![Stories in Ready](https://badge.waffle.io/cloak-php/coveralls-kit.png?label=ready&title=Ready)](https://waffle.io/cloak-php/coveralls-kit)[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cloak-php/coveralls-kit/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/cloak-php/coveralls-kit/?branch=master)[![Coverage Status](https://coveralls.io/repos/cloak-php/coveralls-kit/badge.png)](https://coveralls.io/r/cloak-php/coveralls-kit)[![Dependency Status](https://www.versioneye.com/user/projects/53fd5949f4df154965000002/badge.svg?style=flat)](https://www.versioneye.com/user/projects/53fd5949f4df154965000002)
**CoverallsKit** is the library for transmitting the report of code coverage to **coveralls**. This library works with **PHP5.4** or more.Requirements------------------------------------* PHP >= 5.4* Xdebug >= 2.2.2Installation
------------------------------------
Installation that uses the composer.

1. Install the [composer](https://getcomposer.org/).
2. Install the package.

composer require cloak/coverallskit --dev
Basic usage------------------------------------You can generate a json file using the **coverallskit/ReportBuilder**. You just set the code coverage of rows that have been executed. Code coverage can be obtained easily by using the **HHVM** and **xdebug**.```php$builder = new ReportBuilder();$builder->token('your repository token') ->service(new TravisCI( new Environment($_SERVER) )) ->repository(new Repository(__DIR__ . '/../'));$source = new SourceFile('path/to/file');$source->addCoverage(Coverage::executed(1)); //The first line was executed$source->addCoverage(Coverage::unused(2)); //The second line is not executed$source->addCoverage(Coverage::executed(3)); //The third line is executed$builder->addSource($source);$builder->build()->saveAs(__DIR__ . '/tmp/coverage.json');```Using a configuration file-----------------------------------If you use a configuration file, you can send the report more easily.```phpuse coverallskit\Configuration;
use coverallskit\ReportBuilder;

$configration = Configuration::loadFromFile('coveralls.toml');
$builder = ReportBuilder::fromConfiguration($configration);
$builder->build()->save()->upload();
```Configration file format-----------------------------------It is also possible to use a configuration file. The file format is **toml format**.
```toml
token = "{api-token}"
service = "travis-ci"
repositoryDirectory = "."

[reportFile]
output = "script/coveralls.json"

[reportFile.input]
type = "lcov"
file = "script/report.lcov"
```


### File format
| Name | Required | Default | Description |
|:--------------------|------------:|:---------------|:--------------------------------------------------|
| token | optional | **COVERALLS_REPO_TOKEN** | [coveralls.io](https://coveralls.io/docs/api) api token. If you do not specify, use the environment variable **COVERALLS_REPO_TOKEN**. |
| service | optional | **travis-ci** | CI(Continuous Integration) service name. You can use the **travis-ci** or **travis-pro** or **circle-ci** or **drone.io** or **codeship** |
| reportFile | optional | | Please look at the **reportFile section**. |
| repositoryDirectory | optional | . | Directory path of the **git repository**. Will specify a relative path from the directory containing the configuration file. |

#### reportFile

##### imput

| Name | Required | Default | Description |
|:--------------------|------------:|:---------------|:--------------------------------------------------|
| type | optional | | Will specify the file type in the code coverage report. You can specify the **lcov** or **clover**. |
| file | optional | coveralls.json | Will specify a file of code coverage report. |

##### output

will specify the json file name to be sent to the [coveralls.io](https://coveralls.io/docs/api).
Will specify a relative path from the directory containing the configuration file.

Task for Robo---------------------------------------------------------------------------------Support the [robo](https://github.com/Codegyre/Robo) of tasks, so you can easily send a report. Please look at the [robo-coveralls-kit](https://github.com/cloak-php/robo-coveralls-kit) for more information.Detailed documentation-----------------------------------* [Work with Travis-CI](docs/travis-ci.md)Run only unit test------------------------------------ composer testHow to run the example------------------------------------ vendor/bin/robo example:basic
CoverallsKit====================================[![Build Status](https://travis-ci.org/cloak-php/coveralls-kit.svg?branch=master)](https://travis-ci.org/cloak-php/coveralls-kit)[![Build Status](https://drone.io/github.com/cloak-php/coveralls-kit/status.png)](https://drone.io/github.com/cloak-php/coveralls-kit/latest)[![Circle CI](https://circleci.com/gh/cloak-php/coveralls-kit.svg?style=svg)](https://circleci.com/gh/cloak-php/coveralls-kit)[![Build Status](https://codeship.com/projects/af9497a0-70ab-0132-4b61-227a26fe7ed7/status?branch=master)](https://codeship.com/projects/54536)[![Stories in Ready](https://badge.waffle.io/cloak-php/coveralls-kit.png?label=ready&title=Ready)](https://waffle.io/cloak-php/coveralls-kit)[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cloak-php/coveralls-kit/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/cloak-php/coveralls-kit/?branch=master)[![Coverage Status](https://coveralls.io/repos/cloak-php/coveralls-kit/badge.png)](https://coveralls.io/r/cloak-php/coveralls-kit)[![Dependency Status](https://www.versioneye.com/user/projects/53fd5949f4df154965000002/badge.svg?style=flat)](https://www.versioneye.com/user/projects/53fd5949f4df154965000002)[![Latest Stable Version](https://poser.pugx.org/cloak/coverallskit/v/stable.svg)](https://packagist.org/packages/cloak/coverallskit) [![License](https://poser.pugx.org/cloak/coverallskit/license.svg)](https://packagist.org/packages/cloak/coverallskit)**CoverallsKit** is the library for transmitting the report of code coverage to **coveralls**. This library works with **PHP5.5** or more.Requirements------------------------------------* PHP >= 5.5* Xdebug >= 2.2.2Installation------------------------------------Installation that uses the composer.1. Install the [composer](https://getcomposer.org/).2. Install the package. composer require cloak/coverallskit --devBasic usage------------------------------------You can generate a json file using the **coverallskit/CoverallsReportBuilder**.You just set the code coverage of rows that have been executed. Code coverage can be obtained easily by using the **HHVM** and **xdebug**.```php$travis = new TravisCI( new Environment($_SERVER) );$service = new CIService($travis);$builder = new CoverallsReportBuilder();$builder->token('your repository token') ->service($service) ->repository(new Repository(__DIR__ . '/../'));$source = new SourceFile('path/to/file');$source->addCoverage(CoverageResult::executed(1)); //The first line was executed$source->addCoverage(CoverageResult::unused(2)); //The second line is not executed$source->addCoverage(CoverageResult::executed(3)); //The third line is executed$builder->addSource($source);$builder->build()->saveAs(__DIR__ . '/tmp/coverage.json');```Using a configuration file-----------------------------------If you use a configuration file, you can send the report more easily.```phpuse coverallskit\BuilderConfiguration;use coverallskit\CoverallsReportBuilder;$configuration = BuilderConfiguration::loadFromFile('coveralls.toml');$builder = CoverallsReportBuilder::fromConfiguration($configuration);$builder->build()->save()->upload();```Configuration file format-----------------------------------It is also possible to use a configuration file. The file format is **toml format**.```tomltoken = "{api-token}"service = "travis-ci"repositoryDirectory = "."[reportFile]output = "script/coveralls.json"[reportFile.input]type = "lcov"file = "script/report.lcov"```### File format| Name | Required | Default | Description ||:--------------------|------------:|:---------------|:--------------------------------------------------|| token | optional | **COVERALLS_REPO_TOKEN** | [coveralls.io](https://coveralls.io/docs/api) api token. If you do not specify, use the environment variable **COVERALLS_REPO_TOKEN**. || service | optional | **travis-ci** | CI(Continuous Integration) service name. You can use the **travis-ci** or **travis-pro** or **circle-ci** or **drone.io** or **codeship** || reportFile | optional | | Please look at the **reportFile section**. || repositoryDirectory | optional | . | Directory path of the **git repository**. Will specify a relative path from the directory containing the configuration file. |#### reportFile##### imput| Name | Required | Default | Description ||:--------------------|------------:|:---------------|:--------------------------------------------------|| type | optional | | Will specify the file type in the code coverage report. You can specify the **lcov** or **clover**. || file | optional | coveralls.json | Will specify a file of code coverage report. |##### outputwill specify the json file name to be sent to the [coveralls.io](https://coveralls.io/docs/api). Will specify a relative path from the directory containing the configuration file.Task for Robo---------------------------------------------------------------------------------Support the [robo](https://github.com/Codegyre/Robo) of tasks, so you can easily send a report. Please look at the [robo-coveralls-kit](https://github.com/cloak-php/robo-coveralls-kit) for more information.Detailed documentation-----------------------------------* [Work with Travis-CI](docs/travis-ci.md)Run only unit test------------------------------------ composer testHow to run the example------------------------------------ vendor/bin/robo example:basic
Expand Down

0 comments on commit bc4d09d

Please sign in to comment.