Giter Club home page Giter Club logo

candybar's Introduction

Candybar

release.svg coverage.svg builddate.svg 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 for upcoming features. Issues/pull requests are welcome.

Installation

$ 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:

$ vendor/bin/candybar list

To get help for a specific command:

$ 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

candybar's People

Contributors

adrian7 avatar

Stargazers

 avatar

Watchers

 avatar

candybar's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.