biofriction-wp-theme/node_modules/gulp-babel/readme.md

120 lines
2.4 KiB
Markdown
Raw Normal View History

2021-10-26 14:18:09 +02:00
# gulp-babel [![Build Status](https://travis-ci.org/babel/gulp-babel.svg?branch=master)](https://travis-ci.org/babel/gulp-babel)
> Use next generation JavaScript, today, with [Babel](https://babeljs.io)
*Issues with the output should be reported on the Babel [issue tracker](https://phabricator.babeljs.io/).*
## Install
```
$ npm install --save-dev gulp-babel babel-preset-env
```
## Usage
```js
const gulp = require('gulp');
const babel = require('gulp-babel');
gulp.task('default', () =>
gulp.src('src/app.js')
.pipe(babel({
presets: ['env']
}))
.pipe(gulp.dest('dist'))
);
```
## API
### babel([options])
#### options
See the Babel [options](https://babeljs.io/docs/usage/options/), except for `sourceMap` and `filename` which is handled for you.
## Source Maps
Use [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) like this:
```js
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: ['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()`](https://babeljs.io/docs/usage/api/).
#### Example
```js
const gulp = require('gulp');
const babel = require('gulp-babel');
const through = require('through2');
function logFileHelpers() {
return through.obj((file, enc, cb) => {
console.log(file.babel.usedHelpers);
cb(null, file);
});
}
gulp.task('default', () =>
gulp.src('src/**/*.js')
.pipe(babel({
presets: ['env']
}))
.pipe(logFileHelpers())
)
```
## 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
```
Use it as plugin:
```js
const gulp = require('gulp');
const babel = require('gulp-babel');
gulp.task('default', () =>
gulp.src('src/app.js')
.pipe(babel({
plugins: ['transform-runtime']
}))
.pipe(gulp.dest('dist'))
);
```
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)