/grunt-coffeescript-concat

Grunt plugin for coffeescript-concat utility

Primary LanguageJavaScriptMIT LicenseMIT

grunt-coffeescript-concat Build Status

Grunt plugin for coffeescript-concat by fairfieldt

Getting Started

This plugin requires Grunt ~0.4.4

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-coffeescript-concat --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-coffeescript-concat');

The "coffeescript_concat" task

Overview

In your project's Gruntfile, add a section named coffeescript_concat to the data object passed into grunt.initConfig().

grunt.initConfig({
  coffeescript_concat: {
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

includeFolders

Type: Array.<string>

Will be passed as -I [files] option to coffeescript-concat.

Usage Examples

grunt.initConfig({
  coffeescript_concat: {
    compile: {
      options: {
        includeFolders: [
          'coffee/myotherfiles'
        ]
      },
      files: {
        'build/concatenated.coffee': [
          'coffee/a.coffee',
          'coffee/b.coffee',
          'coffee/c.coffee'
        ]
      }
    }
  },
});

Contributing

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.

Release History

  • 0.2.0 Added support for includeFolders

  • 0.1.0 Initial release