es6-module-loader

ES6 Module Loader Polyfill

Dynamically loads ES6 modules in browsers and NodeJS with support for loading existing and custom module formats through loader hooks.

This project implements dynamic module loading through System exactly to the previous ES6-specified loader API at 2014-08-24 ES6 Specification Draft Rev 27, Section 15 and will continue to track this API as it is re-drafted as a browser specification (currently most likely to be at https://github.com/whatwg/loader).

• Provides an asynchronous loader (System.import) to dynamically load ES6 modules.
• Supports both Traceur and 6to5 for compiling ES6 modules and syntax into ES5 in the browser with source map support.
• Fully supports ES6 circular references and live bindings.
• Includes baseURL and paths implementations.
• Can be used as a tracing tool for static analysis of modules.
• Polyfills ES6 Promises in the browser with an optionally bundled ES6 promise implementation.
• Supports IE8+, with IE9+ support for ES6 development without pre-compilation.
• The complete combined polyfill, including ES6 promises, comes to 9KB minified and gzipped, making it suitable for production use, provided that modules are built into ES5 making them independent of Traceur.

For an overview of build workflows, see the production guide.

For an example of a universal module loader based on this polyfill for loading AMD, CommonJS and globals, see SystemJS.

Documentation

• A brief overview of ES6 module syntax
• Configuring the loader
• Production workflows
• Circular References & Bindings
• Extending the loader through loader hooks
• Tracing API

Getting Started

If using ES6 syntax (optional), include traceur.js or 6to5.js in the page first then include es6-module-loader.js:

  <script src="traceur.js"></script>
  <script src="es6-module-loader.js"></script>

To use 6to5, set the transpiler to 6to5 with the loader configuration:

<script>
  System.transpiler = '6to5';
</script>

Then we can write any ES6 module:

mymodule.js:

  export class q {
    constructor() {
      console.log('this is an es6 class!');
    }
  }

and load the module dynamically in the browser

<script>
  System.import('mymodule').then(function(m) {
    new m.q();
  });
</script>

The dynamic loader returns a Module object, which contains getters for the named exports (in this case, q).

Setting transpilation options

If using Traceur, these can be set with:

System.traceurOptions = {...};

Or with 6to5:

System.to5Options = {...};

Module Tag

As well as defining window.System, this polyfill provides support for the <script type="module"> tag:

<script type="module">
  // loads the 'q' export from 'mymodule.js' in the same path as the page
  import { q } from 'mymodule';

  new q(); // -> 'this is an es6 class!'
</script>

Because it is only possible to load ES6 modules with this tag, it is not suitable for production use in this way.

See the demo folder in this repo for a working example demonstrating both module loading the module tag in the browser.

NodeJS Use

  npm install es6-module-loader

For use in NodeJS, the Loader and System globals are provided as exports:

index.js:

  var System = require('es6-module-loader').System;
  /*  
   *  Include:
   *    System.transpiler = '6to5'; 
   *  to use 6to5 instead of Traceur
   */

  System.import('some-module').then(function(m) {
    console.log(m.p);
  });

some-module.js:

  export var p = 'NodeJS test';

Running the application:

> node index.js
NodeJS test

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.

Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "lib" subdirectory!

Testing

• npm run test:node will use node to to run the tests
• npm run test:browser will run npm run test:browser-6to5 and npm run test:browser-traceur
• npm run test:browser-[transpiler] use karma to run the tests with traceur or 6to5.
• npm run test:browser:perf will use karma to run benchmarks

npm run test:browser-[transpiler] supports options after a double dash (--) :

• You can use the --polyfill option to test the code with polyfill.

• You can use the --coverage option to test and extract coverage info.

• You can use the --ie8 option to test the code in the ie8 scope only.

• You can use the --saucelabs option to use karma and saucelabs to run the tests in various browsers. Note: you will need to export your username and key to launch it.

  export SAUCE_USERNAME={your user name} && export SAUCE_ACCESS_KEY={the access key that you see once logged in}
  npm run test:browsers -- --saucelabs
  

Credit

Copyright (c) 2015 Luke Hoban, Addy Osmani, Guy Bedford

License

Licensed under the MIT license.