coverex

# Coverex

Coverex is an Elixir Coverage tool used by `mix`. It provides tables with overviews of 
module and function coverage data, includings links to annotated source code files. 

[![Build Status](https://travis-ci.org/alfert/coverex.svg?branch=master)](https://travis-ci.org/alfert/coverex)
[![Coverage Status](https://coveralls.io/repos/alfert/coverex/badge.png?branch=master)](https://coveralls.io/r/alfert/coverex?branch=master)
[![hex.pm version](https://img.shields.io/hexpm/v/coverex.svg?style=flat)](https://hex.pm/packages/coverex)

## Configuration

You configure Coverex by adding this line to your `mix.exs` file: 

	test_coverage: [tool: Coverex.Task]

as part of the regular project settings. In addition to that, you need to add Coverex 
to the dependencies of your project. Coverex is available via `hex.pm`, so need only to 
add this line to the dependencies in your `mix.exs` file: 

	{:coverex, "~> 0.0.7", only: :test}

For debugging purposes, the log level can be set as addition to the `tool` option. The default
value is `:error`. To set the log level to `:debug` you use this line in your `mix.exs` file: 

	test_coverage: [tool: Coverex.Task, log: :debug]

The usual log levels of `Logger` application of Elixir are available. 

If you set the flag `coveralls: true` and you are running on `travis-ci`, the coverage information are sent to (http://coveralls.io). An example configuration would be

	test_coverage: [tool: Coverex.Task, coveralls: true]

## Running Coverex

If you have configured Coverex as described above you can run Coverex as a drop-in replacement 
for the regular coverage mechanism of mix: 

    $> mix test --cover

The coverage reports are found in the `cover` directory or what you have configured as coverage directory
as explained in the docs of the `Mix.Tasks.Test` task.

## Contributing

Please use the GitHub issue tracker for 

* bug reports and for
* submitting pull requests

## License

Coverex is provided under the Apache 2.0 License.