From c70239255fc146beceda4e9bfe73fb09c049bff6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?=
 <bjorn.erik.pedersen@gmail.com>
Date: Wed, 4 Dec 2024 13:31:45 +0100
Subject: [PATCH] Update JS docs vs Hugo v0.140

---
 .../layouts/shortcodes/include.html           |  2 +-
 content/en/functions/js/Batch.md              | 30 +++++++
 content/en/functions/js/Build.md              | 83 +----------------
 content/en/functions/js/_common/_index.md     | 13 +++
 content/en/functions/js/_common/options.md    | 89 +++++++++++++++++++
 5 files changed, 134 insertions(+), 83 deletions(-)
 create mode 100644 content/en/functions/js/Batch.md
 create mode 100644 content/en/functions/js/_common/_index.md
 create mode 100644 content/en/functions/js/_common/options.md

diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html
index 9ad6e4ecb0f..cb9c1258742 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html
+++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html
@@ -10,7 +10,7 @@
 */}}
 
 {{- with .Get 0 }}
-  {{- with site.GetPage . }}
+  {{- with or (site.GetPage .) ($.Page.GetPage .) }}
     {{- .RenderShortcodes }}
   {{- else }}
     {{- errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
diff --git a/content/en/functions/js/Batch.md b/content/en/functions/js/Batch.md
new file mode 100644
index 00000000000..15e15e382c4
--- /dev/null
+++ b/content/en/functions/js/Batch.md
@@ -0,0 +1,30 @@
+---
+title: js.Batch
+description: TODO1
+categories: []
+keywords: []
+action:
+  aliases: []
+  related:
+    - functions/js/Build
+    - functions/js/Babel
+    - functions/resources/Fingerprint
+    - functions/resources/Minify
+  returnType: resource.Resource
+  signatures: ['js.Batch ID']
+toc: true
+---
+
+## TODOs updated JS docs vs batching etc.
+
+- [ ] Update include.html template in the theme
+- [ ] Write js.Batch docs. format=esm.
+
+## Options
+
+format
+: (`string`) Currently only `esm` in [ESBuild's code splitting].
+
+{{% include "./_common/options.md" %}}
+
+[ESBuild's code splitting]: https://esbuild.github.io/api/#splitting
\ No newline at end of file
diff --git a/content/en/functions/js/Build.md b/content/en/functions/js/Build.md
index 2a948416e0c..e5ba6555650 100644
--- a/content/en/functions/js/Build.md
+++ b/content/en/functions/js/Build.md
@@ -45,94 +45,13 @@ 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.
-
-```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:
-
-```js
-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:
-
-```go-html-template
-{{ $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
-// js/shims/react.js
-module.exports = window.React;
-```
-
-```js
-// js/shims/react-dom.js
-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/client';
-```
-
-target
-: (`string`) The language target. One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`. Default is `esnext`.
-
-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.
-
-```go-html-template
-{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
-```
-
 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
 : (`string`) Whether to generate `inline` or `external` source maps from esbuild. External source maps will be written to the target with the output file name + ".map". Input source maps can be read from js.Build and node modules and combined into the output source maps. By default, source maps are not created.
 
-JSX {{< new-in 0.124.0 >}}
-: (`string`) How to handle/transform JSX syntax. One of: `transform`, `preserve`, `automatic`. Default is `transform`. Notably, the `automatic` transform was introduced in React 17+ and will cause the necessary JSX helper functions to be imported automatically. See https://esbuild.github.io/api/#jsx
-
-JSXImportSource {{< new-in 0.124.0 >}}
-: (`string`) Which library to use to automatically import its JSX helper functions from. This only works if `JSX` is set to `automatic`. The specified library needs to be installed through npm and expose certain exports. See https://esbuild.github.io/api/#jsx-import-source
-
-The combination of `JSX` and `JSXImportSource` is helpful if you want to use a non-React JSX library like Preact, e.g.:
-
-```go-html-template
-{{ $js := resources.Get "js/main.jsx" | js.Build (dict "JSX" "automatic" "JSXImportSource" "preact") }}
-```
-
-With the above, you can use Preact components and JSX without having to manually import `h` and `Fragment` every time:
-
-```jsx
-import { render } from 'preact';
-
-const App = () => <>Hello world!</>;
-
-const container = document.getElementById('app');
-if (container) render(<App />, container);
-```
+{{% include "./_common/options.md" %}}
 
 ### Import JS code from /assets
 
diff --git a/content/en/functions/js/_common/_index.md b/content/en/functions/js/_common/_index.md
new file mode 100644
index 00000000000..4328d4d145b
--- /dev/null
+++ b/content/en/functions/js/_common/_index.md
@@ -0,0 +1,13 @@
+---
+cascade:
+  _build:
+    list: never
+    publishResources: false
+    render: never
+---
+
+<!--
+Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
+
+Include the rendered content using the "include" shortcode. 
+-->
diff --git a/content/en/functions/js/_common/options.md b/content/en/functions/js/_common/options.md
new file mode 100644
index 00000000000..baa86726c0f
--- /dev/null
+++ b/content/en/functions/js/_common/options.md
@@ -0,0 +1,89 @@
+---
+_comment: Do not remove front matter.
+---
+
+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:
+
+```js
+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.
+
+loaders
+: (`map`) {{< new-in "0.140.0" >}}  Configuring a loader for a given file type lets you load that file type with an import statement or a require call. For example configuring the .png file extension to use the data URL loader means importing a .png file gives you a data URLcontaining the contents of that image. Loaders available are `none`, `base64`, `binary`, `copy`,  `css`,  `dataurl`, `default`, `empty`, `file`, `global-css`, `js`, `json`, `jsx`, `local-css`,  `text`, `ts`, `tsx`. See https://esbuild.github.io/api/#loader
+
+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:
+
+```go-html-template
+{{ $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
+// js/shims/react.js
+module.exports = window.React;
+```
+
+```js
+// js/shims/react-dom.js
+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/client';
+```
+
+target
+: (`string`) The language target. One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`. Default is `esnext`.
+
+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.
+
+```go-html-template
+{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
+```
+
+JSX {{< new-in 0.124.0 >}}
+: (`string`) How to handle/transform JSX syntax. One of: `transform`, `preserve`, `automatic`. Default is `transform`. Notably, the `automatic` transform was introduced in React 17+ and will cause the necessary JSX helper functions to be imported automatically. See https://esbuild.github.io/api/#jsx
+
+JSXImportSource {{< new-in 0.124.0 >}}
+: (`string`) Which library to use to automatically import its JSX helper functions from. This only works if `JSX` is set to `automatic`. The specified library needs to be installed through npm and expose certain exports. See https://esbuild.github.io/api/#jsx-import-source
+
+The combination of `JSX` and `JSXImportSource` is helpful if you want to use a non-React JSX library like Preact, e.g.:
+
+```go-html-template
+{{ $js := resources.Get "js/main.jsx" | js.Build (dict "JSX" "automatic" "JSXImportSource" "preact") }}
+```
+
+With the above, you can use Preact components and JSX without having to manually import `h` and `Fragment` every time:
+
+```jsx
+import { render } from 'preact';
+
+const App = () => <>Hello world!</>;
+
+const container = document.getElementById('app');
+if (container) render(<App />, container);
+```
\ No newline at end of file