JSCoverage-style instrumentation for CoffeeScript files.
Compiles .coffee files to .js files, and adds JSCoverage style instrumnetation for the original coffee script source.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-coffee-coverage --save-dev
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of CoffeeScript:
In your project's Gruntfile, add a section named
coffeeCoverage to the data
object passed into
gruntinitConfigcoffeeCoverage:options: # Task-specific options go here.your_target: # Target-specific file lists and/or options go here.
Set the name to use in the instrumented code for the coverage variable.
Any file or directory which is in this list will be ignored. Note that this field is case sensitive.
Write all global initialization out to this file.
Specify how to show the path for each filename in the instrumented output. If
relative, then the relative path will be written to each file. If
abbr, then we replace each directory in the path with its first
letter. The default is
none which will write only the filename with no path.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.