gohugoio-hugo/docs/content/en/hugo-pipes/js.md

title, description, date, publishdate, lastmod, categories, keywords, menu, weight, sections_weight, draft

title	description	date	publishdate	lastmod	categories	keywords	menu	weight	sections_weight	draft
JavaScript Building	Hugo Pipes can process JavaScript files with [ESBuild](https://github.com/evanw/esbuild).	2020-07-20	2020-07-20	2020-07-20	asset management		docs parent weight pipes 45	45	45	false

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.

minify [bool]

Let js.Build handle the minification.

target [string]

The language target. One of: es5, es2015, es2016, es2017, es2018, es2019, es2020 or esnext. Default is esnext.

externals [slice]

External dependencies. If a dependency should not be included in the bundle (Ex. library loaded from a CDN.), it should be listed here.

{{ $externals := slice "react" "react-dom" }}

Marking a package as external doesn't imply that the library can be loaded from a CDN. It simply tells Hugo not to expand/include the package in the JS file.

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] {{< new-in "0.74.3" >}}

The output format. One of: iife, cjs, esm. Default is iife, a self-executing function, suitable for inclusion as a <script> tag.

Examples

{{ $built := resources.Get "js/index.js" | js.Build "main.js" }}

Or with options:

{{ $externals := slice "react" "react-dom" }}
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}

{{ $opts := dict "targetPath" "main.js" "externals" $externals "defines" $defines }}
{{ $built := resources.Get "scripts/main.js" | js.Build $opts }}
<script type="text/javascript" src="{{ $built.RelPermalink }}" defer></script>

Shimming a JS library

It's a very common practice to load external libraries using CDN rather than importing all packages in a single JS file, making it bulky. To do the same with Hugo, you'll need to shim the libraries as follows. In this example, algoliasearch and instantsearch.js will be shimmed.

Firstly, add the following to your project's package.json:

{
  "browser": {
    "algoliasearch/lite": "./public/js/shims/algoliasearch.js",
    "instantsearch.js/es/lib/main": "./public/js/shims/instantsearch.js"
  }
}

What this does is it tells Hugo to look for the listed packages somewhere else. Here we're telling Hugo to look for algoliasearch/lite and instantsearch.js/es/lib/main in the project's public/js/shims folder.

Now we'll need to create the shim JS files which export the global JS variables module.exports = window.something. You can create a separate shim JS file in your assets directory, and redirect the import paths there if you wish, but a much cleaner way is to create these files on the go, by having the following before your JS is built.

{{ $a := "module.exports = window.algoliasearch" | resources.FromString "js/shims/algoliasearch.js" }}
{{ $i := "module.exports = window.instantsearch" | resources.FromString "js/shims/instantsearch.js" }}

{{/* Call RelPermalink unnecessarily to generate JS files */}}
{{ $placebo := slice $a.RelPermalink $i.RelPermalink }}

That's it! You should now have a browser-friendly JS which can use external JS libraries.