coffee-coverage

Istanbul and JSCoverage-style instrumentation for CoffeeScript files.

Benbria CoffeeCoverage

Instruments CoffeeScript files for code coverage. Compiles .coffee files to .js files, and adds JSCoverage or Istanbul style instrumentation for the original coffee script source.

Features

• Native coffee-script instrumentation - not based on source maps
• Conditional instrumentation with pragmas
• Support for Istanbul style instrumentation
• Support for JSCoverage style instrumentation
• Support for Streamline compiler style instrumentation
• Dynamic instrumentation - instrument your code at run time
• Precompiled instrumentation

Quick Start

Assuming you have a folder named "test" full of mocha tests, which directly loads your .coffee files, then from your project's folder, run:

npm install --save-dev coffee-coverage
npm install --save-dev istanbul
mocha --recursive \
      --compilers coffee:coffee-script/register \
      --require coffee-coverage/register-istanbul \
      test
./node_modules/.bin/istanbul report

You should now have an Istanbul coverage report in ./coverage/lcov-report/index.html.

If this doesn't quite do what you're after, check out our tutorials below:

Tutorials:

• Mocha and Istanbul Guide
• Mocha and JSCoverage Guide
• Codeship and Coveralls
• Travis-CI and Coveralls
• Ignoring code with Pragmas

Have coffee-coverage working in a setup not described above? Raise an issue and let us know how you're using coffee-coverage, so we can document it here.

What it Does

Benbria CoffeeCoverage is a tool for determining the coverage of your unit tests. It does this by instrumenting .coffee files to see how often each line, branch, or function is executed. CoffeeCoverage is capable of producing both Istanbul and JSCoverage style instrumentation.