Track your project's test coverage.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
lib
src
test
.babelrc
.editorconfig
.eslintrc
.gitattributes
.gitignore
.vile.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
LICENSE
README.md
appveyor.yml
coffeelint.json
package-lock.json
package.json

README.md

vile-coverage Circle CI Build status score-badge coverage-badge dependency-badge

A Vile plugin for tracking your project's test coverage.

Requirements

Supported Formats

  • lcov

Note: Currently only total file coverage is generated. Ideally per method and per line coverage stats will be supported by Vile in future versions.

Installation

This plugin is already packaged with vile's core lib, but you can also install it manually:

npm i -D vile vile-coverage

Usage

vile a -p coverage

Config

The plugin will automatically detect any lcov data in coverage/ if it exists.

You can also specify custom paths/files:

coverage:
  config:
    paths:
      - special/cov/dir
      - another/file.lcov

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

Architecture

  • src is es6+ syntax compiled with Babel
  • lib generated js library
  • test is any test code, written in CoffeeScript
  • .test where coffeescript is generated to

Developing

cd vile-coverage
npm install
npm test

To run compile task with file watch in the background:

npm run dev

To run tests with coverage:

npm run test-cov

See package.json for other available scripts.