aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcainus <[email protected]>2013-07-25 13:45:40 -0700
committercainus <[email protected]>2013-07-25 13:45:40 -0700
commit89212de6fe2cec08961617ae00d9f648faeccc14 (patch)
tree97bda81cd028f8b196f5c126afdc56e5581ba682
parenta5d04183f3a299b5c6263cb705fe671cf234bb74 (diff)
parentca07f96b3e9c19a30e11d87e6d13c88e5f29d7a7 (diff)
downloadnode-coveralls-89212de6fe2cec08961617ae00d9f648faeccc14.tar.xz
node-coveralls-89212de6fe2cec08961617ae00d9f648faeccc14.zip
merge README changes
-rw-r--r--README.md35
1 files changed, 31 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3ccd94a..3d8ea79 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ There are optional environment variables for other build systems as well:
* COVERALLS_RUN_AT (a date string for the time that the job ran. RFC 3339 dates work. This defaults to your
build system's date/time if you don't set it.)
-###[Blanket.js](https://github.com/alex-seville/blanket)
+### [Mocha](http://visionmedia.github.io/mocha/) + [Blanket.js](https://github.com/alex-seville/blanket)
- Install [blanket.js](http://blanketjs.org/)
- Configure blanket according to [docs](https://github.com/alex-seville/blanket/blob/master/docs/getting_started_node.md).
- Run your tests with a command like this:
@@ -41,19 +41,46 @@ NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
--require blanket \
--reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
```
-###[JSCoverage](https://github.com/fishbar/jscoverage)
+### [Mocha](http://visionmedia.github.io/mocha/) + [JSCoverage](https://github.com/fishbar/jscoverage)
Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://www.seejohncode.com/2012/03/13/setting-up-mocha-jscoverage/) or [here](http://tjholowaychuk.com/post/18175682663/mocha-test-coverage)), but that's also a necessary step.
In mocha, if you've got your code instrumented for coverage, the command for a travis build would look something like this:
-```console
+```sh
YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha test -R mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
```
Check out an example [Makefile](https://github.com/cainus/urlgrey/blob/master/Makefile) from one of my projects for an example, especially the test-coveralls build target. Note: Travis runs `npm test`, so whatever target you create in your Makefile must be the target that `npm test` runs (This is set in package.json's 'scripts' property).
-##[Istanbul](https://github.com/gotwarlost/istanbul)
+### [Istanbul](https://github.com/gotwarlost/istanbul)
TODO
+### [Nodeunit](https://github.com/caolan/nodeunit) + [JSCoverage](https://github.com/fishbar/jscoverage)
+
+Depend on nodeunit, jscoverage and coveralls:
+
+```sh
+npm install nodeunit jscoverage coveralls --save-dev
+```
+
+Add a coveralls script to "scripts" in your `package.json`:
+
+```javascript
+"scripts": {
+ "test": "nodeunit test",
+ "coveralls": "jscoverage lib && YOURPACKAGE_COVERAGE=1 nodeunit --reporter=lcov test | coveralls"
+}
+```
+
+Ensure your app requires instrumented code when `process.env.YOURPACKAGE_COVERAGE` variable is defined.
+
+Run your tests with a command like this:
+
+```sh
+npm run coveralls
+```
+
+For detailed instructions on requiring instrumented code, running on Travis and submitting to coveralls [see this guide](https://github.com/alanshaw/nodeunit-lcov-coveralls-example).
+
## Running locally
If you're running locally, you must have a `.coveralls.yml` file, as documented in [their documentation](https://coveralls.io/docs/ruby), with your `repo_token` in it; or, you must provide a `COVERALLS_REPO_TOKEN` environment-variable on the command-line.