diff options
Diffstat (limited to 'docs/content/en/hugo-pipes/js.md')
| -rw-r--r-- | docs/content/en/hugo-pipes/js.md | 44 |
1 files changed, 16 insertions, 28 deletions
diff --git a/docs/content/en/hugo-pipes/js.md b/docs/content/en/hugo-pipes/js.md index ff29ca958..c95688e68 100644 --- a/docs/content/en/hugo-pipes/js.md +++ b/docs/content/en/hugo-pipes/js.md @@ -3,7 +3,6 @@ title: JavaScript Building description: Hugo Pipes can process JavaScript files with [ESBuild](https://github.com/evanw/esbuild). date: 2020-07-20 publishdate: 2020-07-20 -lastmod: 2020-07-20 categories: [asset management] keywords: [] menu: @@ -12,7 +11,6 @@ menu: weight: 45 weight: 45 sections_weight: 45 -draft: 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. @@ -20,33 +18,33 @@ Any JavaScript resource file can be transpiled and "tree shaken" using `js.Build ### Options targetPath [string] -: If not set, the source path will be used as the base target path. +: 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] {{< new-in "0.78.0" >}} +params [map or slice] : Params that can be imported as JSON in your JS files, e.g.: ```go-html-template {{ $js := resources.Get "js/main.js" | js.Build (dict "params" (dict "api" "https://example.org/api")) }} ``` -And then in your JS file: +And then in your JS file: ```js 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] {{< new-in "0.81.0" >}} +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 {{< new-in "0.81.0" >}} +shims : 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: -``` +```go-html-template {{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }} {{ $js = $js | js.Build dict "shims" $shims }} ``` @@ -63,17 +61,12 @@ module.exports = window.React; module.exports = window.ReactDOM; ``` - With the above, these imports should work in both scenarios: ```js import * as React from 'react' import * as ReactDOM from 'react-dom'; ``` -sourceMap [string, bool] {{< new-in "0.75.0" >}} -: Let `js.Build` output sourceMap. Current only inline is supported. true defaults to inline. - One of: '`inline`, `external` - Default is "" (disabled) target [string] : The language target. @@ -91,19 +84,17 @@ defines [map] {{ $defines := dict "process.env.NODE_ENV" `"development"` }} ``` -format [string] {{< new-in "0.74.3" >}} +format [string] : The output format. One of: `iife`, `cjs`, `esm`. Default is `iife`, a self-executing function, suitable for inclusion as a <script> tag. sourceMap -: Whether to generate `inline` or `external` sourcemap from esbuild. 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. +: Whether to generate `inline` or `external` sourcemap from esbuild. External sourcemaps will be written to the target with the output filename + ".map". Input sourcemaps can be read from js.Build and node modules and combined into the output sourcemaps. ### Import JS code from /assets -{{< new-in "0.78.0" >}} - -Since Hugo `v0.78.0` `js.Build` has full support for the virtual union file system in [Hugo Modules](/hugo-modules/). You can see some simple examples in this [test project](https://github.com/gohugoio/hugoTestProjectJSModImports), but in short this means that you can do this: +`js.Build` has full support for the virtual union file system in [Hugo Modules](/hugo-modules/). You can see some simple examples in this [test project](https://github.com/gohugoio/hugoTestProjectJSModImports), but in short this means that you can do this: ```js import { hello } from 'my/module'; @@ -129,14 +120,14 @@ For other files (e.g. `JSON`, `CSS`) you need to use the relative path including import * as data from 'my/module/data.json'; ``` -Any imports in a file outside `/assets` or that does not resolve to a component inside `/assets` will be resolved by [ESBuild](https://esbuild.github.io/) with the **project directory** as the resolve directory (used as the starting point when looking for `node_modules` etc.). Also see [hugo mod npm pack](/commands/hugo_mod_npm_pack/). If you have any imported NPM dependencies in your project, you need to make sure to run `npm install` before you run `hugo`. +Any imports in a file outside `/assets` or that does not resolve to a component inside `/assets` will be resolved by [ESBuild](https://esbuild.github.io/) with the **project directory** as the resolve directory (used as the starting point when looking for `node_modules` etc.). Also see [hugo mod npm pack](/commands/hugo_mod_npm_pack/). If you have any imported npm dependencies in your project, you need to make sure to run `npm install` before you run `hugo`. Also note the new `params` option that can be passed from template to your JS files, e.g.: ```go-html-template {{ $js := resources.Get "js/main.js" | js.Build (dict "params" (dict "api" "https://example.org/api")) }} ``` -And then in your JS file: +And then in your JS file: ```js import * as params from '@params'; @@ -145,14 +136,13 @@ import * as params from '@params'; Hugo will, by default, generate a `assets/jsconfig.json` file that maps the imports. This is useful for navigation/intellisense help inside code editors, but if you don't need/want it, you can [turn it off](/getting-started/configuration/#configure-build). - ### Include Dependencies In package.json / node_modules -Any imports in a file outside `/assets` or that does not resolve to a component inside `/assets` will be resolved by [ESBuild](https://esbuild.github.io/) with the **project directory** as the resolve directory (used as the starting point when looking for `node_modules` etc.). Also see [hugo mod npm pack](/commands/hugo_mod_npm_pack/). If you have any imported NPM dependencies in your project, you need to make sure to run `npm install` before you run `hugo`. +Any imports in a file outside `/assets` or that does not resolve to a component inside `/assets` will be resolved by [ESBuild](https://esbuild.github.io/) with the **project directory** as the resolve directory (used as the starting point when looking for `node_modules` etc.). Also see [hugo mod npm pack](/commands/hugo_mod_npm_pack/). If you have any imported npm dependencies in your project, you need to make sure to run `npm install` before you run `hugo`. -{{< new-in "0.78.1" >}} From Hugo `0.78.1` the start directory for resolving NPM packages (aka. packages that live inside a `node_modules` folder) is always the main project folder. +The start directory for resolving npm packages (aka. packages that live inside a `node_modules` folder) is always the main project folder. -**Note:** If you're developing a theme/component that is supposed to be imported and depends on dependencies inside `package.json`, we recommend reading about [hugo mod npm pack](/commands/hugo_mod_npm_pack/), a tool to consolidate all the NPM dependencies in a project. +**Note:** If you're developing a theme/component that is supposed to be imported and depends on dependencies inside `package.json`, we recommend reading about [hugo mod npm pack](/commands/hugo_mod_npm_pack/), a tool to consolidate all the npm dependencies in a project. ### Examples @@ -169,7 +159,5 @@ Or with options: {{ $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> +<script src="{{ $built.RelPermalink }}" defer></script> ``` - - |