grunt-wrap-combo

Wrap, forks from grunt-wrap, add options.compiler

Getting Started

This plugin requires Grunt ~0.4.2

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

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

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

The "wrap" task

Overview

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

grunt.initConfig({
  wrap: {
    basic: {
      src: ['test/fixtures/basic'],
      dest: 'tmp/basic',
      options: {
        separator: '',
        // need a custom value to pass var
        customvalue: '<%= pkg.version %>',
        // compile (edit) content with function
        compiler: function(content, options) {
          return content.replace(/@VERSION/g, options.customvalue);
        },
        wrapper: ['\'', '\'']
      }
    },
    advanced: {
      cwd: 'test/fixtures/',
      expand: true,
      src: ['advanced'],
      dest: 'tmp/',
      options: {
        indent: '\t',
        separator: '',
        // compile (edit) content with function
        compiler: function(content, options) {
          return content.replace(/  /g, options.indent);
        }
      }
    }
});

Options

options.compiler

Type: Function Default value: undefined

A value that is used to compiler content with options.

options.wrapper

Type: Function|Array Default value: ['', '']

A value that is used to wrapper content.

options.separator

Type: String Default value: \n

A value that is used to seperate sections.

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

• 2014-01-28 - v0.2.1 - Update README.md and .travis.yml.
• 2014-01-17 - v0.2.0 - Update README.md.
• 2014-01-17 - v0.1.0 - Initial release.