grunt-gumup

Concatenate Gumup units.

Getting Started

This plugin requires Grunt ~0.4.0

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

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

grunt.loadNpmTasks('grunt-gumup');

Gumup task

Run this task with the grunt gumup command.

Task targets, files and options may be specified according to the Grunt Configuring tasks guide.

Options

Any specified option will be passed through directly to Gumup, thus you can specify any option that Gumup supports.

onResolve

Type: String Function
Default: null

Set the resolved dependencies as value into the project's Grunt configuration or pass them as an argument to user callback. If it is null then the dependencies will be concatenated to the dest files.

separator

Type: String
Default: grunt.util.linefeed

Concatenated files will be joined on this string. If you're post-processing concatenated JavaScript files with a minifier, you may need to use a semicolon ';' as the separator.

Gumup options

cwd

Type: String
Default: '.'

All options paths are relative to this path.

encoding

Type: String
Default: 'utf-8'

Unit files encoding.

externals

Type: GumupOptions~externals[]
Default: []

External units description.

gumupSpy

Type: Function
Default: null

Callback to setup the GumupSpy constructor. It is used to extend Gumup functionality. The callback accepts one argumet that is a current implementation of the constructor. You can extend this constructor or return your own.

unitPath

Type: String[]
Default: ['.']

Paths that are used to find the Gumup units.

GumupOptions~externals

globals

Type: String
Default: []

Global variables that are occuped by the external unit.

files

Type: String
Default: []

Files of the external unit.

usages

Type: String

Gumup unit files that depends from this unit.

Usage Examples

Default options

This configuration will resolve dependencies of the main unit and concatenate them.

grunt.initConfig({
  gumup: {
    dist: {
      files: {
        'dest/index.js': ['main.js']
      }
    }
  }
});

Pass the result to a task

This configuration will resolve dependencies of the main unit and pass them to uglify:dist task.

grunt.initConfig({
  gumup: {
    dist: {
      options: {
        onResolve: 'uglify.dist.files'
      },
      files: {
        'dest/index.js': ['main.js']
      }
    }
  }
});

Process the result with a user callback

This configuration will resolve dependencies of the main unit and log them.

grunt.initConfig({
  gumup: {
    dist: {
      options: {
        onResolve: function(fileList) {
          console.log(fileList);
        }
      },
      files: {
        'dest/index.js': ['main.js']
      }
    }
  }
});

Sample from the tests

grunt.initConfig({
  gumup: {
    sample: {
      options: {
        cwd: 'test/fixtures',
        externals: [
          {
            globals: ['firstLib'],
            files: ['third-party/first-lib.js'],
            usages: ['sample/lib/first.js']
          },
          {
            globals: ['secondLib'],
            files: [
              'third-party/third-lib.js',
              'third-party/second-lib.js'
            ],
            usages: ['sample/baz.js']
          }
        ],
        unitPath: ['sample']
      },
      files: {
        'tmp/sample-with-required-units.js': [
          'test/fixtures/sample/main.js',
          'test/fixtures/sample/util/*'
        ],
        'tmp/sample-without-required-units.js': [
          'test/fixtures/sample/main.js'
        ]
      }
    }
  }
});

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

(Nothing yet)