Transpiles JavaScript modules from one format to another.
Transpiles JavaScript modules from one format to another.
It supports from:
- es6,
- cjs,
- amd,
- steal
to
- amd,
- steal,
- cjs.
Currently, it can not transpile to ES6 module syntax.
> npm install transpile --save-dev
transpile.to transpiles from one format to another format. transpile.able
lets you know if a transpile is possible.
Formats are specified by strings like:
- "es6" - ES6 Module syntax like import Point from "math";
- "cjs" - CommonJS syntax like var _ = require('underscore');
- "amd" - Asynchronous Module Definition
syntax like define(['jquery'],function($){});
- "steal" - steal syntax like steal('jquery', function($){})
Transpiles from the load's format to the specified format. If
the load does not specify a format, "es6" modules are assumed. Returns
an object containing the transpiled source and sourceMap (if sourceMap option provided).
Example:
``js
var transpile = require('transpile');
var res = transpile.to({
name: "my/module",
source: "var foo = require('foo')",
metadata: {format: "cjs"}
}, "amd")
res.code //-> "define("my/module", function(require, exports, module) { ... "
`
A load is an object in the shape of
an ES6 Load Record like:
`js`
{
name: "moduleName",
source: "source code",
metadata: {format: "formatName"}
}
#### NOTE
Previously transpile.to returned a string containing the transpiled source. To accomodate Source Maps support the API has changed and now returns an object that looks like:
`js`
{
code: "define(...", // The transpiled source,
map: {}, // A source map, if sourceMaps option is provided.
ast: {} // A Mozilla Parser API compatible AST, created by Esprima
}
#### options
- __normalizeMap__ Object - A mapping module names that willfunction(name, currentName, address) -> String
be used to replace dependency names in the transpiled result.
- __normalize__ - A functionBoolean=false
that can be used to change moduleNames that are written in the transpiled result.
- __namedDefines__ - Set to true to insert named defines. String=traceur
- __transpiler__ - Set which ES6 transpiler to use. Valid options are traceur or 6to5 with traceur being the default.function(source, compileOptions, options) -> Object
- __transpile__ - If you want to handle tranpiling yourself and not use the built-in options, this is a function that will be given the source and is expected to return an object containing a code string.Boolean=false
- __sourceMaps__ - Set to true to return a map and ast object along with the result.Boolean=false
- __sourceMapsContent__ - If sourceMaps is set to true, this option will include the original source contents with the source maps.
Returns the path used to transpile
from fromFormat to toFormat. If transpiling is not possible, null will be
returned.
Example:
`js``
var res = transpile.able("steal","cjs");
res //-> ["steal","amd"];
This means that a module will be converted from "steal" to "amd" and then
to "cjs".
> npm test