grunt-lodash

grunt-lodash ^v0.2.0

Grunt wrapper around the Lo-Dash build tool.

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-lodash');

Overview

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

grunt.initConfig({
  'lodash': {
    'build': {
      // output location
      'dest': 'build/lodash.build.js',
      'options': {
        // modifiers for prepared builds
        // backbone, legacy, modern, mobile, strict, underscore
        'modifier': 'backbone'
      }
    }
  }
});

As you might have guessed, this would produce the same output as

lodash backbone -o build/lodash.build.js

All configuration options

More information can be found in the Lo-Dash custom builds section

'lodash': {
  'target': {
    // output location
    'dest': 'build/lodash.build.js'
  },
  'options': {
    // modifiers for prepared builds
    // backbone, legacy, modern, mobile, strict, underscore
    'modifier': 'backbone',
    'category': ['collections', 'functions'],
    'exports': ['amd', 'commonjs', 'node'],
    'iife': '!function(window,undefined){%output%}(this)',
    'include': ['each', 'filter', 'map'],
    'minus': ['result', 'shuffle'],
    'plus': ['random', 'template'],
    'template': './*.jst',
    'settings': '{interpolate:/\\{\\{([\\s\\S]+?)\\}\\}/g}',
    'moduleId': 'underscore',
    // with or without the --
    // these are the only tested options,
    // as the others don't make sense to use here
    'flags': [
      '--stdout',
      'debug',
      '--minify',
      'source-map'
    ],
    // with or without the -
    // these are the only tested options,
    // as the others don't make sense to use here
    'shortFlags': [
      'c',
      '-d',
      'm',
      '-p'
    ]
  }
}

Support

grunt-lodash has been tested in at least Node.js 0.8.19-0.10.7 (Node bug #5622 prevents 0.10.8-0.10.10 from working)

Release Notes

^v0.2.0

• Configuration syntax uses “grunt-style”
• Ability to specify custom version of Lo-Dash through peerDependency
• Use grunt.util.spawn to use Lo-Dash’s build process directly
• Full test suite

The full changelog is available here.

Contributing

If you’d like to file an issue or submit a pull request, please check the contributing guidelines

Resources

• grunt
• Getting started
• Lo-Dash

Author

Blaine Bublitz

Contributors

John-David Dalton	Kit Cambridge	Mathias Bynens