Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.97 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.97 KB
Raw

grunt-pure-cjs

Grunt plugin for Pure CommonJS builder

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-pure-cjs --save-dev

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

grunt.loadNpmTasks('grunt-pure-cjs');

The "pure_cjs" task

Options

  • map: String|Function(input, output)|Boolean — source map file; optional, doesn't generate source map by default; if true is provided, path default to function (input, output) { return output + '.map' }.
  • exports: String|Function(input, output) — Exports top module with UMD with given global object name; optional, doesn't wrap into UMD by default.
  • transform: Array|Function(input) — Array of or single function that returns transformation through-stream(s) to be used against input files before their usage; optional.
  • See Pure CommonJS builder for other options.

If set, built module will be wrapped into anonymous function and exports from top (input) module will be placed into provided value.

Usage Example

grunt.initConfig({
  pure_cjs: {
    options: {
      exports: 'SuperLib'
    },
    files: {
      'built/superLib.js': 'src/topModule.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.