mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-14 12:57:54 +00:00
![Bjørn Erik Pedersen](/assets/img/avatar_default.png)
cb18a5183 Fix broken link 07a0198bf Config: Place Google Analytics tag ID under the services key 4bf0c719f Fix typo 50d8ad1af Fix muiltilingual menu definition instructions 1a32519a9 Fix typos 6f34ca8e0 Explain usage of front matter to target a template 5bd977257 Improve goldmark config docs 447632938 Remove Docker notes from installation instructions 84741d173 Update reference to hugo.work 0338d7c71 Fix menu template f5d2f5ed4 Fix typos in content/en/functions/fmt a3a40ff99 Add return type to functions 85ac3e779 Remove outdated feature image d47d889e4 Fix signatures 7551ba28f Document safe.JSStr function e77993be0 Document keyVals function 4dba20db3 Update theme babf91544 Update echoparam 8c8203efa Adjust related functions 4cb1b30fc Fix example ba95eca64 Improve showcase prose 5d3dcf366 Add Overmind Studios showcase 8d634ac70 Change code blocks from indented to fenced cfab978e6 Add missing code fences 407dd5c47 Limit related pages for functions to other functions 9fa67d981 Fix .Site.LastChange doc 393aa16d0 netlify: Hugo 0.119.0 f864af97a docs: Even more about images.Process 9d772d5f0 docs: More about images.Process bc655f869 docs: Regen docshelper 41c3536d1 Merge commit '9aec42c5452b3eb224888c50ba1c3f3b68a447e9' 918ed53f4 Add images.Process filter 573645883 Add $image.Process a1151b0fd Add images.Opacity filter git-subtree-dir: docs git-subtree-split: cb18a5183fc62f301ffde50b8c39f03e4b897aec
6.3 KiB
6.3 KiB
title | linkTitle | description | categories | keywords | menu | weight | signatures | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
js.Build | JavaScript building | Process a JavaScript file with [ESBuild](https://github.com/evanw/esbuild). |
|
|
60 |
|
Usage
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. configuration 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