ryanseddon / gulp-es6-module-transpiler

MIT License
61 stars 17 forks source link

gulp-es6-module-transpiler

Gulp plugin for the ES6 Module Transpiler

NPM version Build Status Dependency Status

npm install gulp-es6-module-transpiler

Usage

Basic usage

var transpile  = require('gulp-es6-module-transpiler');

gulp.task('build', function() {
    return gulp.src('src/**/*.js')
        .pipe(transpile({
            formatter: 'bundle'
        }))
        .pipe(gulp.dest('lib'));
})

With source maps

var sourcemaps = require('gulp-sourcemaps');
var transpile  = require('gulp-es6-module-transpiler');

gulp.task('build', function() {
    return gulp.src('src/**/*.js')
        .pipe(sourcemaps.init())
        .pipe(transpile({
            formatter: 'bundle'
        }))
        .pipe(sourcemaps.write('./'))
        .pipe(gulp.dest('lib'));
 })

Options

formatter String|Formatter|Formatter constructor [optional]

Name of built-in formatter, formatter instance of formatter constructor function. Controls the output format of transpiler scripts. All built-in formatters are available as formatters property of required module require('gulp-es6-module-transpiler').formatters.

Defaults to es6-module-transpiler default formatter.

Important es6-module-transpiler version 0.9.x supports bundle and commonjs formatters only. To support AMD format, please use es6-module-transpiler-amd-formatter.

basePath String [optional]

All module names will be resolved and named relatively to this path.

Defaults to process.cwd().

importPaths Array<String> [optional]

Array of path that will be used to resolve modules.

Defaults to [ options.basePath ].

sourceMaps Boolean [optional]

If set to false, sourceMappingURL is not appended to transpiled files and source maps are not applied. Defaults to true.

Release history

License

MIT License