gulp-babel

What is gulp-babel?

The gulp-babel package is a Gulp plugin that allows you to use Babel to transpile your JavaScript files. Babel is a JavaScript compiler that lets you use next-generation JavaScript, today. It can transform syntax, polyfill features that are missing in your target environment, and more.

What are gulp-babel's main functionalities?

Transpile ES6 to ES5

This feature allows you to transpile ES6 JavaScript code to ES5, making it compatible with older browsers. The code sample demonstrates a Gulp task that reads a JavaScript file from the 'src' directory, uses Babel to transpile it, and then writes the output to the 'dist' directory.

const gulp = require('gulp');
const babel = require('gulp-babel');

gulp.task('default', () => {
  return gulp.src('src/app.js')
    .pipe(babel({
      presets: ['@babel/env']
    }))
    .pipe(gulp.dest('dist'));
});

Use Babel plugins

This feature allows you to use specific Babel plugins to transform your code. The code sample demonstrates a Gulp task that uses the Babel plugin for transforming arrow functions.

const gulp = require('gulp');
const babel = require('gulp-babel');

gulp.task('default', () => {
  return gulp.src('src/app.js')
    .pipe(babel({
      plugins: ['@babel/plugin-transform-arrow-functions']
    }))
    .pipe(gulp.dest('dist'));
});

Source Maps

This feature allows you to generate source maps for your transpiled code, which can be very useful for debugging. The code sample demonstrates a Gulp task that initializes source maps, transpiles the code using Babel, and then writes the source maps to the 'dist' directory.

const gulp = require('gulp');
const babel = require('gulp-babel');
const sourcemaps = require('gulp-sourcemaps');

gulp.task('default', () => {
  return gulp.src('src/app.js')
    .pipe(sourcemaps.init())
    .pipe(babel({
      presets: ['@babel/env']
    }))
    .pipe(sourcemaps.write('.'))
    .pipe(gulp.dest('dist'));
});

Other packages similar to gulp-babel

gulp-typescript

The gulp-typescript package is a Gulp plugin for compiling TypeScript files. It offers similar functionality to gulp-babel but is specifically designed for TypeScript. It can compile TypeScript to JavaScript, generate declaration files, and more.

gulp-coffee

The gulp-coffee package is a Gulp plugin for compiling CoffeeScript files. Like gulp-babel, it allows you to transpile code from one language to another, but it is specifically for CoffeeScript.

gulp-uglify

The gulp-uglify package is a Gulp plugin for minifying JavaScript files. While it doesn't transpile code like gulp-babel, it is often used in conjunction with gulp-babel to minify the transpiled code for production.

README

This readme is for gulp-babel v8 + Babel v7 Check the 7.x branch for docs with Babel v6 usage

gulp-babel

Use next generation JavaScript, today, with Babel

Issues with the output should be reported on the Babel issue tracker.

Install

Install gulp-babel if you want to get the pre-release of the next version of gulp-babel.

# Babel 7
$ npm install --save-dev gulp-babel @babel/core @babel/preset-env

# Babel 6
$ npm install --save-dev gulp-babel@7 babel-core babel-preset-env

Usage

const gulp = require('gulp');
const babel = require('gulp-babel');

gulp.task('default', () =>
	gulp.src('src/app.js')
		.pipe(babel({
			presets: ['@babel/env']
		}))
		.pipe(gulp.dest('dist'))
);

API

babel([options])

options

See the Babel options, except for sourceMap and filename which is handled for you.

Source Maps

Use gulp-sourcemaps like this:

const gulp = require('gulp');
const sourcemaps = require('gulp-sourcemaps');
const babel = require('gulp-babel');
const concat = require('gulp-concat');

gulp.task('default', () =>
	gulp.src('src/**/*.js')
		.pipe(sourcemaps.init())
		.pipe(babel({
			presets: ['@babel/env']
		}))
		.pipe(concat('all.js'))
		.pipe(sourcemaps.write('.'))
		.pipe(gulp.dest('dist'))
);

Babel Metadata

Files in the stream are annotated with a babel property, which contains the metadata from babel.transform().

Example

const gulp = require('gulp');
const babel = require('gulp-babel');
const through = require('through2');

function logBabelMetadata() {
	return through.obj((file, enc, cb) => {
		console.log(file.babel.test); // 'metadata'
		cb(null, file);
	});
}

gulp.task('default', () =>
	gulp.src('src/**/*.js')
		.pipe(babel({
			// plugin that sets some metadata
			plugins: [{
				post(file) {
					file.metadata.test = 'metadata';
				}
			}]
		}))
		.pipe(logBabelMetadata())
)

Runtime

If you're attempting to use features such as generators, you'll need to add transform-runtime as a plugin, to include the Babel runtime. Otherwise, you'll receive the error: regeneratorRuntime is not defined.

Install the runtime:

$ npm install --save-dev @babel/plugin-transform-runtime 
$ npm install --save @babel/runtime 

Use it as plugin:

const gulp = require('gulp');
const babel = require('gulp-babel');

gulp.task('default', () =>
	gulp.src('src/app.js')
		.pipe(babel({
			plugins: ['@babel/transform-runtime']
		}))
		.pipe(gulp.dest('dist'))
);

License

MIT © Sindre Sorhus

Changelog

8.0.0-beta.1 (2018-01-26)

• [Fix] Drop dependency on deprecated gulp-util (#137)
• [Chore] Update repository: add CHANGELOG.md, update .gitignore, license year, update dependencies, add lock files, add npm badge, mention gulp-babel@next.