| 1 | ape-covering
|
| 2 | ==========
|
| 3 |
|
| 4 | [![Build Status][my_travis_badge_url]][my_travis_url]
|
| 5 | [![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
|
| 6 | [![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
|
| 7 | [![npm version][my_npm_budge_url]][my_npm_url]
|
| 8 |
|
| 9 | Coverage module for ape framework.
|
| 10 |
|
| 11 |
|
| 12 | Usage
|
| 13 | ----
|
| 14 |
|
| 15 | ### Measure coverage.
|
| 16 |
|
| 17 | ```javascript
|
| 18 | #!/usr/bin/env node
|
| 19 |
|
| 20 | /**
|
| 21 | * This is an example to measure coverage.
|
| 22 | */
|
| 23 |
|
| 24 | "use strict";
|
| 25 |
|
| 26 | var apeCovering = require('ape-covering');
|
| 27 |
|
| 28 | apeCovering.measureCoverage('ci/test.js', [
|
| 29 | 'test/*_test.js'
|
| 30 | ], {
|
| 31 | // Options
|
| 32 | dir: 'coverage' // Destination directory path
|
| 33 | }, function (err) {
|
| 34 | /*...*/
|
| 35 | }
|
| 36 | );
|
| 37 |
|
| 38 | ```
|
| 39 |
|
| 40 |
|
| 41 | Installation
|
| 42 | ----
|
| 43 |
|
| 44 | ```javascript
|
| 45 | $ npm install ape-covering --save
|
| 46 | ```
|
| 47 |
|
| 48 |
|
| 49 | License
|
| 50 | -------
|
| 51 | This software is released under the [MIT License][my_license_url].
|
| 52 |
|
| 53 |
|
| 54 | Links
|
| 55 | ------
|
| 56 |
|
| 57 | + [istanbul](https://www.npmjs.com/package/istanbul)
|
| 58 |
|
| 59 |
|
| 60 | [npm_url]: https://www.npmjs.org/
|
| 61 | [my_repo_url]: https://github.com/ape-repo/ape-covering
|
| 62 | [my_travis_url]: http://travis-ci.org/ape-repo/ape-covering
|
| 63 | [my_travis_badge_url]: http://img.shields.io/travis/ape-repo/ape-covering.svg?style=flat
|
| 64 | [my_license_url]: https://github.com/ape-repo/ape-covering/blob/master/LICENSE
|
| 65 | [my_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-covering
|
| 66 | [my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-covering.svg?style=flat
|
| 67 | [my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-covering.svg?style=flat
|
| 68 | [my_coverage_url]: http://ape-repo.github.io/ape-covering/coverage/lcov-report
|
| 69 | [my_npm_url]: http://www.npmjs.org/package/ape-covering
|
| 70 | [my_npm_budge_url]: http://img.shields.io/npm/v/ape-covering.svg?style=flat
|
| 71 |
|