0.2.0 • Published 10 years ago

grunt-wrap-define v0.2.0

Weekly downloads
1
License
-
Repository
github
Last release
10 years ago

grunt-wrap-define

Wrap javascript in anonymous defines that require a named module mapped to a variable.

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-wrap-define --save-dev

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

grunt.loadNpmTasks('grunt-wrap-define');

The "wrap_define" task

Overview

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

grunt.initConfig({
  wrapDefine: {
    options: {dependencies: [{name: 'jquery', extern: 'jQuery'}]},
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});

Options

options.dependencies

Type: Array Default value: []

An array of either strings or objects of the form {'name': 'moduleName', 'extern': 'externName'} that defines how to wrap the input code.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  wrapDefine: {
    options: {dependencies: [{name: 'jquery', extern: 'jQuery'}]},
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});
## 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](http://gruntjs.com/).

## Release History
0.1.0 - Initial release