Volt.Builder (Volt v0.19.4)

Production build — resolve dependencies, split chunks, bundle, and write assets.

Walks the dependency graph from entry files, compiles source through Volt.Pipeline, expands Vite-compatible features such as import.meta.glob() and dynamic import variables, bundles chunks with OXC.bundle/2, rewrites CSS and JavaScript asset references, and writes content-hashed output files with a manifest.

Summary

Functions

build(opts)

Build production assets from one or more entry files.

bundle(opts)

Bundle one JavaScript entry with Volt's normal build graph and return it in memory.

prepare(opts)

Prepare graph output and its manifest without writing destination files.

Functions

build(opts)

@spec build(keyword()) :: {:ok, Volt.Builder.Result.t()} | {:error, term()}

Build production assets from one or more entry files.

Options

:entry — entry file path, plugin-resolved virtual entry specifier, or list of entries (required)
:outdir — output directory (default: "priv/static/assets")
:public_dir — optional Vite-style public directory copied to the static root as-is
:target — JS target (e.g. :es2020)
:minify — minify output (default: true)
:sourcemap — generate source maps (default: true)
:define — compile-time replacements
:node_modules — path to node_modules (default: auto-detect)
:resolve_dirs — additional directories to resolve bare specifiers (e.g. ["deps"])
:package_scopes — source-root/package-directory pairs. Bare imports originating below a source root resolve from its package directory before global package roots.
:name — output base name (default: derived from entry filename)
:aliases — import alias map (e.g. %{"@" => "assets/src"})
:plugins — list of Volt.Plugin modules. Plugin resolve/2 and load/1 hooks can provide virtual modules and virtual build entries.
:mode — build mode for env variables (default: "production")
:env_prefix — env variable prefix or prefixes exposed to client code (default: "VOLT_")
:asset_url_prefix — public URL prefix for emitted asset references (default: "/assets")
:code_splitting — split dynamic imports and multi-entry ESM shared modules into chunks (default: true)
:tree_shaking — remove unused exports (default: true)

:chunks — manual chunk definitions, map of chunk name to list of patterns:

chunks: %{"vendor" => ["vue", "vue-router"], "ui" => ["assets/src/components"]}

:write_manifest — write manifest.json after building (default: true)
:external — specifiers to exclude from the bundle and access as globals. Accepts a list (global name auto-derived) or a map of specifier => global_name:
```
external: ["vue", "phoenix"]
external: %{"vue" => "Vue", "phoenix" => "Phoenix"}
```

bundle(opts)

@spec bundle(keyword()) :: {:ok, Volt.Builder.Bundle.t()} | {:error, term()}

Bundle one JavaScript entry with Volt's normal build graph and return it in memory.

bundle/1 accepts the same graph, compiler, and bundler options as build/1, including :plugins, :aliases, :node_modules, :resolve_dirs, :loaders, :define, :target, and :external. It does not write a manifest or output JavaScript files, and it always returns a single entry bundle.

This API is intended for tools that need executable JavaScript from Volt's production resolver/compiler pipeline without production file output, such as test runners.

prepare(opts)

Prepare graph output and its manifest without writing destination files.