https://github.com/alfert/coverex

Coverage Reports for Elixir
https://github.com/alfert/coverex

coverage-report elixir

Last synced: about 1 month ago
JSON representation

Coverage Reports for Elixir

• Host: GitHub
• URL: https://github.com/alfert/coverex
• Owner: alfert
• License: other
• Created: 2014-05-10T13:32:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-04-25T20:21:19.000Z (over 3 years ago)
• Last Synced: 2024-10-20T08:52:44.876Z (about 2 months ago)
• Topics: coverage-report, elixir
• Language: JavaScript
• Size: 176 KB
• Stars: 101
• Watchers: 5
• Forks: 26
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - JavaScript - Coverage Reports for Elixir. (Code Analysis)
• fucking-awesome-elixir - coverex - Coverage Reports for Elixir. (Code Analysis)
• awesome-elixir - coverex - Coverage Reports for Elixir. (Code Analysis)

README

        
# 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

Coverex is completely configured via `mix.exs` of your project. To enable `Coverex`,

you add 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 you need only to

add this line to the dependencies in your `mix.exs` file:

	{:coverex, "~> 1.4.10", 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 the `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]

Since `coverex 1.4.7`, a summary on the module level is printed on the console. You can switch this off by setting the option `console_log` to `false`.

	test_coverage: [tool: Coverex.Task, console_log: false]

If you want to ignore some of the modules to appear in the coverage reports, e.g

because they are generated automatically and therefore often needs no test coverage,

you can do this since `coverex 1.4.8`. Use the option `ignore_modules` and assign

to it a list of module names to ignore.

	test_coverage: [tool: Coverex.Task, ignore_modules: [Database, Database.User]]

Since `coverex 1.4.10` the from the Elixir compiler automatically generated

functions `__info__` and `__struct__` are removed from the list of covered

functions. It simply makes no sense to include them into the list (see also #24).

## 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.