grunt-esperanto v0.4.0

grunt-esperanto

Wrapper for the esperanto module transpiler

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

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

grunt.loadNpmTasks('grunt-esperanto');

The "esperanto" task

Overview

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

grunt.initConfig({
  esperanto: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.separator

Type: String Default value: '\n'

A string to place between concatenated files.

options.type

Type: String Default value: 'amd'

Specify the output format.

Available types:

• 'amd' to output AMD modules, works with e.g. Require.JS
• 'commonjs' or cjs to output CommonJS modules, works with node.js and io.js.
• 'umd' to output UMD (universal module definition) content - works as an AMD module, a CommonJS module, or as a browser global.

options.bundleOpts

Type: Object Default value: {}

Accept an esperanto options parameter.

options.filePathAsModule

Type: Boolean Default value: false

When outputting an amd module, if true will use the file path as the module name, stripping the .js suffix. This supercedes using bundleOpts.amdName which is a static equivalent.

Usage Examples

grunt.initConfig({
  esperanto: {
    options: {
      type: 'cjs',
    },
    files: {
      expand: true,
      cwd: 'src/es6',
      src : ['**/*.js'],
      dest: 'dest/out.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.