https://github.com/adrian7/candybar

🍬 Get the candies out of your phpunit tests results
https://github.com/adrian7/candybar

badges code-coverage code-coverage-html phpunit phpunit-themes stylesheets

Last synced: 15 days ago
JSON representation

🍬 Get the candies out of your phpunit tests results

• Host: GitHub
• URL: https://github.com/adrian7/candybar
• Owner: adrian7
• License: mit
• Created: 2018-03-21T14:59:53.000Z (over 6 years ago)
• Default Branch: release
• Last Pushed: 2018-10-31T21:01:40.000Z (about 6 years ago)
• Last Synced: 2024-10-10T02:28:16.326Z (27 days ago)
• Topics: badges, code-coverage, code-coverage-html, phpunit, phpunit-themes, stylesheets
• Language: PHP
• Homepage: http://adrian7.github.io/candybar/
• Size: 101 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Candybar

![release.svg](tests/logs/badges/release.svg) ![coverage.svg](tests/logs/badges/coverage.svg) ![builddate.svg](tests/logs/badges/builddate.svg) ![license.svg](tests/logs/badges/license.svg)

*Get the candies from your PHPUnit's tests results*

**(!) Warning: this project is under heavy development. 

Expect breaking changes with every new 0.x release.**

**Check [the roadmap](https://github.com/adrian7/candybar/blob/dev/ROADMAP.md) 

for upcoming features. Issues/pull requests are welcome.**

### Installation

```bash

$ composer require devlib/candybar --dev && vendor/bin/candybar init

``` 

### Running the bar

After installing (init), a folder called `candybar` will show up in your project's root directory.  

There you'll find the config.php, styles and themes folders. 

The `bar` section of the config file is used to add/remove commands supported by candybar and 

the styles folder is used to lookup styles when running the `coverage:style` command.

To get a list of all available commands run:

```bash

$ vendor/bin/candybar list

```

To get help for a specific command:

```bash

$ vendor/bin/candybar help [command]

```

### Available candies (commands)

 - `build:badge:date` generates build date badge with the current date/time

 - `coverage:style` applies a style to the html coverage presentation

 - `coverage:badge` generates badge from clover xml coverage stats

 - `license:badge` generates license badge, use arguments to set license and color 

 - `readme:add-badges` adds badges to the readme file using  placeholders

 

### Examples

 - `vendor/bin/candybar coverage:style default`

 - `vendor/bin/candybar coverage:badge badges/coverage.svg --style=plastic`

 - `vendor/bin/candybar license:badge badges/license.svg --style=plastic`

 - `vendor/bin/candybar readme:add-badges badges --template=README.tpl.md --output=README.md --backup` 

 

### Making your own commands