grunt-chicago

A Grunt plugin to handle JavaScript file imports. Add an // @import statement in your project's JavaScript files to inject the content from one file into another.

Getting Started

This plugin requires Grunt ~0.4.5

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-chicago --save-dev

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

grunt.loadNpmTasks('grunt-chicago');

The "chicago" task

Overview

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

grunt.initConfig({
  chicago: {
    options : {
    	// Options for all targets
    }
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.always_write

Type: bool Default Value: true

Whether or not to write the file to the destination, even if it doesn't include an import statement

Usage Examples

Default Usage

To inject or import files in your project, add a line that contains the following:

// @import path/to/import.js

Set the source files/directories in your Gruntfile:

grunt.initConfig({
  chicago: {
    files: {
      src : [
        'src/file.js',
        'src/directory'
       ]
    },
  },
});

Or using globbing patterns:

grunt.initConfig({
  chicago: {
    target_name: {
      files: [{
        expand: true,
        cwd: 'src',
        src: [ '*.js', '!*.min.js' ],
        dest: 'dest',
        ext: '.js',
        extDot : 'last'
      }],
    }
  },
});

And execute the task in Terminal:

grunt chicago

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

• 2015-08-20 - v1.0.2
  • Added always_write option.
• 2015-08-19 - v1.0.1
  • Enabled file pattern matching.
• 2015-08-19 - v1.0.0
  • Initial Release.