grunt-coffeecov

Grunt task to compile CoffeeScript to Javascript Coverage

npm install grunt-coffeecov
25 downloads in the last week
77 downloads in the last month

Grunt CoffeeCov

Dependency Status Build Status Code Climate Built with Grunt

NPM

Grunt CoffeeCov is a Grunt task wrapper for CoffeeCoverage. CoffeeCoverage compile .coffee files to .js files and adds JSCoverage style instrumentation for the original CoffeeScript.

For more information, I recommend to consult the readme of Benbria CoffeeScript;

Installation

npm install grunt-coffeecov --save-dev
# Gruntfile.coffee
grunt.loadNpmTasks('grunt-coffeecov')

Usage

Create a 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.

If you use Mocha for your tests, I recommend to use grunt-phantom-coverage-reporter. It's fully compatible with this tasks and coveralls.

Options

Data

src

type: String

Path to source folder

desc

type: String

Path to destination folder

Options

coverageVar

type: String - default: _$jscoverage

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

initfile

type: String

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.

exclude

type: Array - default: ['node_modules', '.git']

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']

path

type: String - default: none

Path can be given one of three different parameters:

  • none is 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.
  • abbr will use abbreviated path names; a file from "src/models/user.coffee" will be instrumented as "s/m/user.coffee".
  • relative will use the full relative pathname; "src/models/user.coffee".

Paths are always relative to the src directory provided on grunt task.

Thanks

Thanks to Benbria to CoffeeCoverage

npm loves you