Giter Site home page Giter Site logo

codylindley / systemjs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from systemjs/systemjs

0.0 2.0 0.0 6.74 MB

Universal dynamic module loader

License: MIT License

Shell 0.38% JavaScript 94.86% HTML 4.72% CoffeeScript 0.02% CSS 0.02% Handlebars 0.01%

systemjs's Introduction

SystemJS

Gitter

For upgrading to SystemJS 0.16, see the ES6 Module Loader 0.16 release upgrade notes for more information, or read the updated Getting Started guide below.

Universal dynamic module loader - loads ES6 modules, AMD, CommonJS and global scripts in the browser and NodeJS. Works with both Traceur and Babel.

Designed to work with the ES6 Module Loader polyfill (9KB) for a combined total footprint of 16KB minified and gzipped.

Runs in IE8+ and NodeJS.

For discussion, see the Google Group.

For a list of guides and tools, see the community project page.

Documentation

Getting Started

Browser Use

Download es6-module-loader.js into the same folder as system.js.

Load SystemJS with a single script tag:

<script src="system.js"></script>

It will then load es6-module-loader.js itself.

To load ES6, locate traceur.js in the baseURL path and it will be loaded when needed.

For use with Babel, locate the browser.js file at babel.js in the baseURL and set:

<script>
  System.transpiler = 'babel';
</script>

Alternatively a custom path to Babel or Traceur can also be set through paths:

System.config({
  paths: {
    traceur: 'path/to/traceur.js'
  }
});

NodeJS Use

To load modules in NodeJS, install SystemJS with:

  npm install systemjs traceur

(making sure to also install Traceur or Babel as needed, as they are not included as dependencies as of SystemJS 0.16)

We can then load modules equivalently to in the browser:

var System = require('systemjs');

/* 
 * Include
 *   System.transpiler = 'babel';
 * to use Babel instead of Traceur
 */

// loads './app.js' from the current directory
System.import('./app').then(function(m) {
  console.log(m);
});

If configuring the baseURL for use in Windows, prepend file: i.e.

System.config({
 baseURL: 'file:' + path.resolve('../path')
});

Plugins

Plugins handle alternative loading scenarios, including loading assets such as CSS or images, and providing custom transpilation scenarios.

Supported Plugins:

  • CSS System.import('my/file.css!')
  • Image System.import('some/image.png!image')
  • JSON System.import('some/data.json!').then(function(json){})
  • Text System.import('some/text.txt!text').then(function(text) {})

Additional Plugins:

  • CoffeeScript System.import('./test.coffee!')
  • Jade
  • JSX System.import('template.jsx!')
  • Markdown System.import('app/some/project/README.md!').then(function(html) {})
  • WebFont System.import('google Port Lligat Slab, Droid Sans !font')
  • Ember Handlebars System.import('template.hbs!')

Plugins are loaded from the module name of the extension. To set them up, you'll most likely want to add map configuration. For example:

System.map['css'] = 'path/to/css/plugin';

Loading through plugin is indicated with ! at the end of the name:

System.import('file.css!');      // will use the "css" plugin, assumed from the extension
System.import('file.css!text');  // will use the "text" plugin, instead of checking the extension

Read the guide here on creating plugins.

Running the tests

To install the dependencies correctly, run bower install from the root of the repo, then open test/test.html in a browser with a local server or file access flags enabled.

License

MIT

systemjs's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.