UNPKG

2.34 kBMarkdownView Raw
1apeman-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
9Apeman task contribution plugin to run test with nodeunit.
10
11
12Installation
13-------
14
15Install module via [npm][npm_url]
16
17```bash
18$ npm install apeman-task-contrib-nodeunit --save-dev
19```
20
21Usage
22-------
23
24Define a task and set "apeman-task-contrib-nodeunit" to '$worker' attribute.
25
26```javascript
27/**
28 * This is example Apemanfile to use "apeman-task-contrib-nodeunit".
29 */
30
31"use strict";
32
33module.exports = {
34 $package: {/*...*/},
35 $tasks: {
36 "run-my-unit-test": {
37 "$worker": "apeman-task-contrib-nodeunit",
38 "$args": [
39 "test/*_test.js"
40 ],
41 "$options": {}
42 }
43 }
44};
45```
46
47Then, run the task via [apeman CLI][apeman_cli_doc_url].
48
49```bash
50$ apeman task run-my-unit-test
51```
52
53License
54-------
55
56This software is released under the [MIT License][my_license_url].
57
58
59Links
60-------
61
62+ [apeman][apeman_url]
63+ [nodeunit](https://github.com/caolan/nodeunit)
64
65
66[npm_url]: https://www.npmjs.com/
67[apeman_url]: https://github.com/apeman-repo/apeman
68[apeman_cli_doc_url]: https://github.com/apeman-repo/apeman
69[my_repo_url]: https://github.com/apeman-repo/apeman-task-contrib-nodeunit
70[my_travis_url]: http://travis-ci.org/apeman-repo/apeman-task-contrib-nodeunit
71[my_travis_badge_url]: http://img.shields.io/travis/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
72[my_license_url]: https://github.com/apeman-repo/apeman-task-contrib-nodeunit/blob/master/LICENSE
73[my_codeclimate_url]: http://codeclimate.com/github/apeman-repo/apeman-task-contrib-nodeunit
74[my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
75[my_coveralls_url]: https://coveralls.io/github/apeman-repo/apeman-task-contrib-nodeunit
76[my_coveralls_badge_url]: http://img.shields.io/coveralls/apeman-repo/apeman-task-contrib-nodeunit.svg?style=flat
77[my_npm_url]: http://www.npmjs.org/package/apeman-task-contrib-nodeunit
78[my_npm_budge_url]: http://img.shields.io/npm/v/apeman-task-contrib-nodeunit.svg?style=flat
79[coz_url]: http://okunishinishi.github.io/node-coz/apiguide
80
81