Quarkus Web Bundler - Configuration Reference

The directory in the resources which serves as root for the web assets

Environment variable: QUARKUS_WEB_BUNDLER_WEB_ROOT

The directory in the project root dir which contains web assets (relative to the project root)

Environment variable: QUARKUS_WEB_BUNDLER_PROJECT_WEB_DIR

Files to ignore, specified relative to the web directory.

Additional ignored files may be specified using the regex: or glob: prefix to indicate whether the value should be interpreted as a regular expression or a glob pattern.

These entries are added to the default set of ignored files, so the defaults do not need to be repeated unless customization is required.

Environment variable: QUARKUS_WEB_BUNDLER_IGNORED_FILES

The default set of ignored files, specified relative to the web directory.

These defaults are intended to be extended via ignored-files, which allows additional patterns to be configured, but if needed they can also be overriden.

Entries may be prefixed with regex: or glob:. The default ignored files include:

Environment variable: QUARKUS_WEB_BUNDLER_DEFAULT_IGNORED_FILES

Enable or disable this entry point.
You can use this to use the map key as key and dir for this entry point.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE__BUNDLE_

Whether this entry point should produce its own output bundle.

When output=false, the entry point is only used as an import for other entry points. It won’t be bundled or served on its own.

This is useful when a directory is consumed by multiple other bundles but doesn’t need to be emitted as a standalone bundle.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE__BUNDLE__OUTPUT

The directory for this entry point under the web root.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE__BUNDLE__DIR

The key for this entry point (use the same key as another to bundle them together).

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE__BUNDLE__KEY

Indicate if this directory contains qute tags (as .html files) This is only available if the Quarkus Qute extension is in the project.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE__BUNDLE__QUTE_TAGS

When configured with an internal path (e.g. 'foo/bar'), Bundle files will be served on this path by Quarkus (prefixed by {quarkus.http.root-path}). When configured with an external URL (e.g. 'https://my.cdn.org/'), Bundle files will NOT be served by Quarkus and all resolved paths in the bundle and mapping will automatically point to this url (a CDN for example).

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE_PATH

Easily debug the bundling using chrome inspect (DevMode only)

Environment variable: QUARKUS_WEB_BUNDLER_DEBUG

Sass/Scss plugin for the Web Bundler is enabled by default

Environment variable: QUARKUS_WEB_BUNDLER_SASS

Enable or disable bundle splitting (https://esbuild.github.io/api/#splitting) Code shared between multiple entry points is split off into a separate shared file (chunk) that both entry points import

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_SPLITTING

Configure the file extensions using the js loader: https://esbuild.github.io/content-types/#javascript

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_JS

Configure the file extensions using the jsx loader: https://esbuild.github.io/content-types/#jsx

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_JSX

Configure the file extensions using the tsx loader: https://esbuild.github.io/content-types/#jsx

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_TSX

Configure the file extensions using the ts loader: https://esbuild.github.io/content-types/#typescript

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_TS

Configure the file extensions using the css loader: https://esbuild.github.io/content-types/#css

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_CSS

Configure the file extensions using the local-css loader: https://esbuild.github.io/content-types/#css

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_LOCAL_CSS

Configure the file extensions using the global-css loader: https://esbuild.github.io/content-types/#css

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_GLOBAL_CSS

Configure the file extensions using the file loader: https://esbuild.github.io/content-types/#file This loader will copy the file to the output directory and embed the file name into the bundle as a string.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_FILE

Configure the file extensions using the copy loader: https://esbuild.github.io/content-types/#copy

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_COPY

Configure the file extensions using the base64 loader: https://esbuild.github.io/content-types/#base64

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_BASE64

Configure the file extensions using the binary loader: https://esbuild.github.io/content-types/#binary

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_BINARY

Configure the file extensions using the dataurl loader: https://esbuild.github.io/content-types/#data-url

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_DATA_URL

Configure the file extensions using the empty loader: https://esbuild.github.io/content-types/#empty-file

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_EMPTY

Configure the file extensions using the text loader: https://esbuild.github.io/content-types/#text

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_TEXT

Configure the file extensions using the json loader: https://esbuild.github.io/content-types/#json

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_LOADERS_JSON

This defines the list of external paths for esbuild (https://esbuild.github.io/api/#external). Instead of being bundled, the import will be preserved.

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_EXTERNAL

Configuration for source-map generation (https://esbuild.github.io/api/#sourcemap)

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_SOURCE_MAP

List of environments for the bundle

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLING_ENVS__ENVS_

Disable this option to allow using runtime web dependencies. When a runtime scope web dependency is used, the dependency will be present in the target app and served at runtime. When a compile only scope web dependency is used, the dependency will only be used at build time and will not be present in the target app.

Environment variable: QUARKUS_WEB_BUNDLER_DEPENDENCIES_COMPILE_ONLY

Enable or disable auto-import of web dependencies: all: auto-import all web dependencies (scripts and styles) styles: auto-import only styles web dependencies (scss, sass, css) none: disable auto-import

** Only direct dependencies are auto-imported, not transitive ones.**

This is using the dependencies package.json (module, main, style, scss, saas fields) to detect the presence of source scripts and styles: - For all libraries enriching your html experience (htmx, hypercript, lazyload, …​), you don’t necessarily need a script, auto-import is a comfort. - For styling libraries (Bootstrap, Semantic, …​), you most likely want to always auto-import the styles. - For other web libraries (React, Vue, Lit, …​), you will import everything manually in your app scripts.

Environment variable: QUARKUS_WEB_BUNDLER_DEPENDENCIES_AUTO_IMPORT

Configure browser live-reload in dev-mode. With live-reload, changes in the web-app are automatically triggering a reload of the page in the browser. When changing styles, the changes is applied directly (without reload).

Environment variable: QUARKUS_WEB_BUNDLER_BROWSER_LIVE_RELOAD

Path to the node_modules parent directory (relative to the project root).

Environment variable: QUARKUS_WEB_BUNDLER_NODE_MODULES

When enabled, Quarkus will create redirections from {bundlePath}/{entryPointKey}.{js,css} to the corresponding file containing the unique hash. This is useful for fixed external access to the bundle files (fullstack microservices).

Environment variable: QUARKUS_WEB_BUNDLER_BUNDLE_REDIRECT

The default charset

Environment variable: QUARKUS_WEB_BUNDLER_CHARSET