Repository files navigation

A Broccoli plugin that transpiles ES6 modules to other module types usingSquare'ses6-module-transpiler.

Note: Thees6-module-transpiler package underwent a major refactorafterv0.4.0, the previous version of this package that works with the oldertranspiler is available on thetranspiler-0.4 branch.

varcompileModules=require('broccoli-es6-module-transpiler');vartranspiledLib=compileModules(lib,{formatter:'commonjs'});

The bundle format is perfect for packaging your app's modules into one file thatcan be loaded in the browserwithout needing a module loader.

varcompileModules=require('broccoli-es6-module-transpiler');vartranspiledLib=compileModules(lib,{formatter:'bundle',output   :'app.js'});

Note: Theoutput option has a specified value to tell the transpiler whereto output the new JavaScript file that contains the bundled transpiled modules.Anoutput value is required when using the Bundle Format.

The latest version of Square'stranspiler is flexible and pluggable, andwhile it doesn't ship with AMD support built-in you can use the AMD formatter:es6-module-transpiler-amd-formatter.

varcompileModules=require('broccoli-es6-module-transpiler');varAMDFormatter=require('es6-module-transpiler-amd-formatter');vartranspiledLib=compileModules(lib,{formatter:newAMDFormatter()});

options.formatter{String | Object}

The formatter instance or built-in name to use to transpile the modules.Built-in formatters:bundle,commonjs.

Default:bundle.

options.resolvers{Array}

An array of resolver classes used to resolve modules to their source code.

Default:[ FileResolver ].

options.output{String}

The path where the transpiler should output the transpiled modules to. Forformatters that output one file per module, this should be a directory, whileformatters like the Bundle Format require a value for this option and it must bea file path.

Default:".".

options.basePath{String}

The path used to resolve the transpiled modules' source paths against. The resolved path will then serve as thesourceFileName value for the module in the output file's source map.

Default:srcDir.

options.sourceRoot{String}

The path to use as thesourceRoot value in the output file's source map.

Default:"/".

options.description{String}

Used to add a description to the top of the compiled file.