mirror of
https://github.com/gohugoio/hugo.git
synced 2024-09-20 01:15:13 -04:00
cf591b7c0c
36dd5483f Clarify placement of 404 template 6f0a5f3f0 Update urls.Parse.md c8070e578 Remove reference to Internet Explorer conditional comments (#1975) 3e3458f09 Describe default source map behavior for js.build (#1974) 08c9ed09a Simplify ordinal abbreviation example... (#1970) b5aa8d598 docs(markdownify): mention a context limitation (#1968) 596af47f5 Fixing typo in configuration.md doc (#1966) c47cadfcb Fix `hardWraps` config spelling (#1964) 5739a174e Add detail to tabWidth highlighting option 73a4bcd1f doc: Add hugo-lyra search engine (#1959) 6cc9ebdfd Update uniq function example (#1963) 686a65cf6 Update uniq.md 096f794d0 Update uniq.md 914ca0c38 remove `version` from SVG example (#1957) 58347d41f Update theme 7c806371f Fix 404 error for CloudCannon community learn docs (#1955) 58e42b03d Update theme fd0385ee2 Update theme 513b7a43a Update findRe.md 4d39137ef Update configuration.md b1c3b58a7 Update configuration.md f827cce8d Update configuration.md 3d72ed8fb netlify: Hugo 0.110.0 e6f969c87 Merge branch 'feat/config-rename' 4c0b5a0b5 dos: Regen CLI docs 05d9db705 docs: Regen docshelper f73bdb6e5 Merge commit 'ef6f101e75256c3bb88a6f1f3b5c1273bf8d7382' e83141f88 Format config 4cadf795e Rename config.toml -> hugo.toml c8aa8617f Move config/_default/config.toml -> config.toml 2943c031a Add fill HTTP Response info into .Data in resources.GetRemote git-subtree-dir: docs git-subtree-split: 36dd5483fb8efb6db4488bbaca5f6ac855f8ffea
6.3 KiB
6.3 KiB
title | description | date | publishdate | categories | keywords | menu | weight | sections_weight | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JavaScript Building | Hugo Pipes can process JavaScript files with [ESBuild](https://github.com/evanw/esbuild). | 2020-07-20 | 2020-07-20 |
|
|
45 | 45 |
Any JavaScript resource file can be transpiled and "tree shaken" using js.Build
which takes for argument either a string for the filepath or a dict of options listed below.
Options
- targetPath [string]
- If not set, the source path will be used as the base target path. Note that the target path's extension may change if the target MIME type is different, e.g. when the source is TypeScript.
- params [map or slice]
- Params that can be imported as JSON in your JS files, e.g.:
{{ $js := resources.Get "js/main.js" | js.Build (dict "params" (dict "api" "https://example.org/api")) }}
And then in your JS file:
import * as params from '@params';
Note that this is meant for small data sets, e.g. config settings. For larger data, please put/mount the files into /assets
and import them directly.
- minify [bool]
- Let
js.Build
handle the minification. - inject [slice]
- This option allows you to automatically replace a global variable with an import from another file. The path names must be relative to
assets
. See https://esbuild.github.io/api/#inject - shims [map]
- This option allows swapping out a component with another. A common use case is to load dependencies like React from a CDN (with shims) when in production, but running with the full bundled
node_modules
dependency during development:
{{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }}
{{ $js = $js | js.Build dict "shims" $shims }}
The shim files may look like these:
// js/shims/react.js
module.exports = window.React;
// js/shims/react-dom.js
module.exports = window.ReactDOM;
With the above, these imports should work in both scenarios:
import * as React from 'react'
import * as ReactDOM from 'react-dom';
- target [string]
- The language target.
One of:
es5
,es2015
,es2016
,es2017
,es2018
,es2019
,es2020
oresnext
. Default isesnext
. - externals [slice]
- External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external
- defines [map]
- Allow to define a set of string replacement to be performed when building. Should be a map where each key is to be replaced by its value.
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
- format [string]
- The output format.
One of:
iife
,cjs
,esm
. Default isiife
, a self-executing function, suitable for inclusion as a