top
(README.md)
# Macchiato

[![Documentation][godoc-img]][godoc-url] ![License][license-img]

A mocha inspired reporter for [Ginkgo](https://onsi.github.io/ginkgo/)

[![Macchiato][macchiato-img]][macchiato-url]

## Example

![Example][example-img]

## Usage

In your Ginkgo Suite, you can import *Macchiato* and use it as follows:

```go
package books_test

import (
	"testing"

	"github.com/crowley-io/macchiato"
	"github.com/onsi/ginkgo"
	"github.com/onsi/gomega"
)

func TestBooks(t *testing.T) {
	gomega.RegisterFailHandler(ginkgo.Fail)
	macchiato.RunSpecs(t, "Books Suite")
}
```

## Under the hood

`macchiato.RunSpecs` will run **Ginkgo** with `RunSpecsWithCustomReporters` and the default Ginkgo's `Reporter`. However, the underlying `Stenographer` is replaced with a Macchiato implementation, which handle the rendering on the console output.

## License

This is Free Software, released under the [`MIT License`](LICENSE).

[macchiato-url]: https://github.com/crowley-io/macchiato
[macchiato-img]: https://raw.githubusercontent.com/crowley-io/macchiato/master/macchiato.jpg
[godoc-url]: https://godoc.org/github.com/crowley-io/macchiato
[godoc-img]: https://godoc.org/github.com/crowley-io/macchiato?status.svg
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[example-img]: https://raw.githubusercontent.com/crowley-io/macchiato/master/example.jpg

Imported only in test by 4 package(s)

  1. github.com/crowley-io/pack/compose
  2. github.com/crowley-io/pack/configuration
  3. github.com/crowley-io/pack/install
  4. github.com/crowley-io/pack/publish

Imports 5 package(s)

  1. github.com/onsi/ginkgo/types
  2. github.com/onsi/ginkgo
  3. github.com/onsi/ginkgo/reporters
  4. github.com/fatih/color
  5. github.com/onsi/ginkgo/config