Skip to content

Commit

Permalink
content: Miscellaneous edits
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmooring
jmooring authored Feb 17, 2025
1 parent e098a77 commit 074cd1a
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 103 deletions.
1 change: 0 additions & 1 deletion content/en/content-management/archetypes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ menu:
docs:
parent: content-management
weight: 140
quicklinks:
weight: 140
toc: true
aliases: [/content/archetypes/]
Expand Down
10 changes: 4 additions & 6 deletions content/en/functions/js/Build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,12 @@ The `js.Build` function uses the [evanw/esbuild] package to:

## Options

###### targetPath

(`string`) If not set, the source path will be used as the base target path.
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.

###### format

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

{{% include "./_common/options.md" %}}

Expand Down
171 changes: 75 additions & 96 deletions content/en/functions/js/_common/options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,128 +2,107 @@
_comment: Do not remove front matter.
---

###### params
params
: (`map` or `slice`) Params that can be imported as JSON in your JS files, e.g.

(`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:

```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';
```

```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.

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.

###### minify
loaders
: {{< new-in 0.140.0 />}}
: (`map`) 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.

(`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.

###### loaders
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:

{{< new-in 0.140.0 />}}
```go-html-template
{{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }}
{{ $js = $js | js.Build dict "shims" $shims }}
```

(`map`) 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.
: The _shim_ files may look like these:

###### inject
```js
// js/shims/react.js
module.exports = window.React;
```

(`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.
```js
// js/shims/react-dom.js
module.exports = window.ReactDOM;
```

###### shims
: With the above, these imports should work in both scenarios:

(`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:
```js
import * as React from 'react';
import * as ReactDOM from 'react-dom/client';
```

```go-html-template
{{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }}
{{ $js = $js | js.Build dict "shims" $shims }}
```
target
: (`string`) The language target. One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`. Default is `esnext`.

The _shim_ files may look like these:
platform
: {{< new-in 0.140.0 />}}
: (`string`) One of `browser`, `node`, `neutral`. Default is `browser`. See https://esbuild.github.io/api/#platform.

```js
// js/shims/react.js
module.exports = window.React;
```
externals
: (`slice`) External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external.

```js
// js/shims/react-dom.js
module.exports = window.ReactDOM;
```
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.

With the above, these imports should work in both scenarios:
```go-html-template
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
```

```js
import * as React from 'react';
import * as ReactDOM from 'react-dom/client';
```
drop
: {{< new-in 0.144.0 />}}
: (`string`) Edit your source code before building to drop certain constructs: One of `debugger` or `console`.
: See https://esbuild.github.io/api/#drop

###### target
sourceMap
: (`string`) Whether to generate `inline`, `linked` or `external` source maps from esbuild. Linked and external source maps will be written to the target with the output file name + ".map". When `linked` a `sourceMappingURL` will also be written to the output file. By default, source maps are not created. Note that the `linked` option was added in Hugo 0.140.0.

(`string`) The language target. One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`. Default is `esnext`.
sourcesContent
: {{< new-in 0.140.0 />}}
: (`bool`) Whether to include the content of the source files in the source map. By default, this is `true`.

###### platform
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.

{{< new-in 0.140.0 />}}
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.

(`string`) One of `browser`, `node`, `neutral`. Default is `browser`. See https://esbuild.github.io/api/#platform.
: The combination of `JSX` and `JSXImportSource` is helpful if you want to use a non-React JSX library like Preact, e.g.:

###### externals
```go-html-template
{{ $js := resources.Get "js/main.jsx" | js.Build (dict "JSX" "automatic" "JSXImportSource" "preact") }}
```

(`slice`) External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external.
: With the above, you can use Preact components and JSX without having to manually import `h` and `Fragment` every time:

###### defines
```jsx
import { render } from 'preact';

(`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.
const App = () => <>Hello world!</>;

```go-html-template
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
```

###### drop

Edit your source code before building to drop certain constructs: One of `debugger` or `console`.

{{< new-in 0.144.0 />}}

See https://esbuild.github.io/api/#drop

###### sourceMap

(`string`) Whether to generate `inline`, `linked` or `external` source maps from esbuild. Linked and external source maps will be written to the target with the output file name + ".map". When `linked` a `sourceMappingURL` will also be written to the output file. By default, source maps are not created. Note that the `linked` option was added in Hugo 0.140.0.

###### sourcesContent

{{< new-in 0.140.0 />}}

(`bool`) Whether to include the content of the source files in the source map. By default, this is `true`.

###### 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);
```
const container = document.getElementById('app');
if (container) render(<App />, container);
```

0 comments on commit 074cd1a

Please sign in to comment.