For more information, I recommend to consult the readme of Benbria CoffeeScript;
npm install grunt-coffeecov --save-dev
# Gruntfile.coffee grunt.loadNpmTasks('grunt-coffeecov')
coffeecov section in your Gruntfile
# Gruntfile.coffee grunt.initConfig coffeecov: cov: src: 'src/coffee' desc: 'lib-cov'
Example with some options
# Gruntfile.coffee grunt.initConfig coffeecov: options: path: 'relative' cov: options: initfile: 'lib-cov/coverage.js' src: 'src/coffee' desc: 'lib-cov'
You can find a real example in Footguard, it's a Yeoman generator for create a single page application with CoffeeScript, Sass, Backbone and Require. Test-footguard is out of box project generated with Footguard, you can read the
Gruntfile and try the project.
Path to source folder
Path to destination folder
String - default:
By default, coffeecoverage will instrument source files with the global variable "_$jscoverage". This is done to mimic JSCoverage. You can rename this variable by using this option
Specifies an "initfile" which all global initalization is written to. This is handy for testing with mocha. If you require the initfile, then mocha reports will show coverage of all files in your project, even files which were never required anywhere.
Array - default:
Gives a comma delimited list of files and directories to exclude from processing. This defaults to
['node_modules', '.git'], since neither of these are directories you probably want to be instrumenting. If you want to also exclude your "test" directory, you might run coffeeCoverage with:
['node_modules', '.git', 'test']
String - default:
Path can be given one of three different parameters:
noneis the default - if coffeeCoverage reads a file from "src/models/user.coffee", then the instrumented code will use the filename "user.coffee". This works well provided you don't reuse filenames elsewhere in your code. Note that if there is a name collision between two files in different subdirectories, coffeecoverage will append a something to the end of one to make it unique, otherwise coverage data from one file would interfere with data from another.
abbrwill use abbreviated path names; a file from "src/models/user.coffee" will be instrumented as "s/m/user.coffee".
relativewill use the full relative pathname; "src/models/user.coffee".
Paths are always relative to the
src directory provided on grunt task.