diff options
Diffstat (limited to 'docs/content/en/hugo-pipes/babel.md')
| -rwxr-xr-x | docs/content/en/hugo-pipes/babel.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/content/en/hugo-pipes/babel.md b/docs/content/en/hugo-pipes/babel.md index 44b4e670e..73ccf01d4 100755 --- a/docs/content/en/hugo-pipes/babel.md +++ b/docs/content/en/hugo-pipes/babel.md @@ -8,14 +8,16 @@ menu: parent: hugo-pipes weight: 70 weight: 70 -signatures: ["resources.Babel RESOURCE [OPTIONS]", "babel RESOURCE [OPTIONS]"] +function: + aliases: [babel] + returnType: resource.Resource + signatures: ['resources.Babel [OPTIONS] RESOURCE'] --- ## Usage Any JavaScript resource file can be transpiled to another JavaScript version using `resources.Babel` which takes for argument the resource object and an optional dict of options listed below. Babel uses the [babel cli](https://babeljs.io/docs/en/babel-cli). - {{% note %}} Hugo Pipe's Babel requires the `@babel/cli` and `@babel/core` JavaScript packages to be installed in the project or globally (`npm install -g @babel/cli @babel/core`) along with any Babel plugin(s) or preset(s) used (e.g., `npm install @babel/preset-env --save-dev`). @@ -26,7 +28,6 @@ If you are using the Hugo Snap package, Babel and plugin(s) need to be installed We add the main project's `node_modules` to `NODE_PATH` when running Babel and similar tools. There are some known [issues](https://github.com/babel/babel/issues/5618) with Babel in this area, so if you have a `babel.config.js` living in a Hugo Module (and not in the project itself), we recommend using `require` to load the presets/plugins, e.g.: - ```js module.exports = { presets: [ @@ -43,24 +44,23 @@ module.exports = { ### Options -config [string] -: Path to the Babel configuration file. Hugo will, by default, look for a `babel.config.js` in your project. More information on these configuration files can be found here: [babel configuration](https://babeljs.io/docs/en/configuration). - -minified [bool] -: Save as many bytes as possible when printing +config +: (`string`) Path to the Babel configuration file. Hugo will, by default, look for a `babel.config.js` in your project. More information on these configuration files can be found here: [babel configuration](https://babeljs.io/docs/en/configuration). -noComments [bool] -: Write comments to generated output (true by default) +minified +: (`bool`) Save as many bytes as possible when printing -compact [bool] -: Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set. +noComments +: (`bool`) Write comments to generated output (true by default) -verbose [bool] -: Log everything +compact +: (`bool`) Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set. -sourceMap [string] -: Output `inline` or `external` sourcemap from the babel compile. External sourcemaps will be written to the target with the output file name + ".map". Input sourcemaps can be read from js.Build and node modules and combined into the output sourcemaps. +verbose +: (`bool`) Log everything +sourceMap +: (`string`) Output `inline` or `external` sourcemap from the babel compile. External sourcemaps will be written to the target with the output file name + ".map". Input sourcemaps can be read from js.Build and node modules and combined into the output sourcemaps. ### Examples |