| 1 | apeman-task-contrib-nodeunit
|
| 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_coveralls_badge_url]][my_coveralls_url]
|
| 7 | [![npm version][my_npm_budge_url]][my_npm_url]
|
| 8 |
|
| 9 | Apeman task contribution plugin to run test with nodeunit.
|
| 10 |
|
| 11 |
|
| 12 | Installation
|
| 13 | -------
|
| 14 |
|
| 15 | Install module via [npm][npm_url]
|
| 16 |
|
| 17 | ```bash
|
| 18 | $ npm install apeman-task-contrib-nodeunit --save-dev
|
| 19 | ```
|
| 20 |
|
| 21 | Usage
|
| 22 | -------
|
| 23 |
|
| 24 | 1. Define a task at `$tasks` property in you Apemanfile.
|
| 25 | 2. Set "apeman-task-contrib-nodeunit" to `$invoke` property.
|
| 26 |
|
| 27 | ```javascript
|
| 28 | /**
|
| 29 | * This is example Apemanfile to use "apeman-task-contrib-nodeunit".
|
| 30 | * @see https://github.com/caolan/nodeunit
|
| 31 | */
|
| 32 |
|
| 33 | "use strict";
|
| 34 |
|
| 35 | module.exports = {
|
| 36 | $pkg: {/*...*/},
|
| 37 | $tasks: {
|
| 38 | // Define your own task.
|
| 39 | "my-task-01": {
|
| 40 | "$invoke": "apeman-task-contrib-nodeunit",
|
| 41 | "$args": [
|
| 42 |
|
| 43 | ],
|
| 44 | "$options": {
|
| 45 |
|
| 46 | }
|
| 47 | }
|
| 48 | }
|
| 49 | };
|
| 50 | ```
|
| 51 |
|
| 52 | Then, run the task via [apeman task command][apeman_task_doc_url].
|
| 53 |
|
| 54 | ```bash
|
| 55 | # Run the task from CLI.
|
| 56 | $ apeman task "my-task-01"
|
| 57 | ```
|
| 58 |
|
| 59 | Options
|
| 60 | -------
|
| 61 |
|
| 62 | Values which can be passed to `$options` property.
|
| 63 |
|
| 64 | | Name | Type | Description |
|
| 65 | | ---- | ---- | ----------- |
|
| 66 | | reporter | String | Name of nodeunit reporter |
|
| 67 |
|
| 68 |
|
| 69 | License
|
| 70 | -------
|
| 71 |
|
| 72 | This software is released under the [MIT License][my_license_url].
|
| 73 |
|
| 74 |
|
| 75 | Links
|
| 76 | -------
|
| 77 |
|
| 78 | + [apeman][apeman_url]
|
| 79 | + [nodeunit](https://github.com/caolan/nodeunit)
|
| 80 |
|
| 81 |
|
| 82 | [npm_url]: https://www.npmjs.com/
|
| 83 | [apeman_url]: https://github.com/apeman-repo/apeman
|
| 84 | [apeman_task_doc_url]: https://github.com/apeman-repo/apeman#task
|
| 85 | [my_repo_url]: https://github.com/apeman-repo/apeman-task-contrib-nodeunit
|
| 86 | [my_travis_url]: http://travis-ci.org/apeman-repo/apeman-task-contrib-nodeunit
|
| 87 | [my_travis_badge_url]: http://img.shields.io/travis/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
|
| 88 | [my_license_url]: https://github.com/apeman-repo/apeman-task-contrib-nodeunit/blob/master/LICENSE
|
| 89 | [my_codeclimate_url]: http://codeclimate.com/github/apeman-repo/apeman-task-contrib-nodeunit
|
| 90 | [my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
|
| 91 | [my_coveralls_url]: https://coveralls.io/github/apeman-repo/apeman-task-contrib-nodeunit
|
| 92 | [my_coveralls_badge_url]: http://img.shields.io/coveralls/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
|
| 93 | [my_npm_url]: http://www.npmjs.org/package/apeman-task-contrib-nodeunit
|
| 94 | [my_npm_budge_url]: http://img.shields.io/npm/v/apeman-task-contrib-nodeunit.svg?style=flat
|
| 95 | [coz_url]: http://okunishinishi.github.io/node-coz/apiguide
|
| 96 |
|
| 97 |
|