Package io.quarkiverse.quinoa.deployment.config.delegate

Class QuinoaConfigDelegate

java.lang.Object

io.quarkiverse.quinoa.deployment.config.delegate.QuinoaConfigDelegate

All Implemented Interfaces:

QuinoaConfig

public class QuinoaConfigDelegate
extends Object
implements QuinoaConfig

Field Summary

Fields inherited from interface io.quarkiverse.quinoa.deployment.config.QuinoaConfig

DEFAULT_BUILD_DIR, DEFAULT_INDEX_PAGE, DEFAULT_WEB_UI_DIR

Constructor Summary

Constructors

Constructor	Description
QuinoaConfigDelegate(QuinoaConfig delegate)

Method Summary

Modifier and Type	Method	Description
Optional<String>	buildDir()	This the Web UI internal build system (webpack, ...) output directory.
Optional<Boolean>	ci()	Install the packages without generating a lockfile (frozen lockfile) and failing if an update is needed (useful in CI).
DevServerConfig	devServer()	Configuration for the external dev server (live coding server)
Optional<Boolean>	enabled()	Indicate if the extension should be enabled.
boolean	enableSPARouting()	Enable SPA (Single Page Application) routing, all relevant requests will be re-routed to the index page.
boolean	forceInstall()	Force install packages before building.
FrameworkConfig	framework()	Configure framework detection
Optional<List<String>>	ignoredPathPrefixes()	List of path prefixes to be ignored by Quinoa.
String	indexPage()	Name of the index page.
boolean	justBuild()	Indicate if Quinoa should just do the build part.
Optional<String>	packageManager()	Name of the package manager binary.
PackageManagerCommandConfig	packageManagerCommand()	Configuration for overriding build commands
PackageManagerInstallConfig	packageManagerInstall()	Configuration for installing the package manager
boolean	runTests()	Indicate if the Web UI should also be tested during the build phase (i.e: npm test).
String	uiDir()	Path to the Web UI (NodeJS) root directory (relative to the project root).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuinoaConfigDelegate

public QuinoaConfigDelegate(QuinoaConfig delegate)

Method Detail

enabled

public Optional<Boolean> enabled()

Description copied from interface: QuinoaConfig

Indicate if the extension should be enabled.

Specified by:

enabled in interface QuinoaConfig

justBuild

public boolean justBuild()

Description copied from interface: QuinoaConfig

Indicate if Quinoa should just do the build part. If true, Quinoa will NOT serve the Web UI built resources. This is handy when the output of the build is used to be served via something else (nginx, cdn, ...) Quinoa put the built files in 'target/quinoa/build' (or 'build/quinoa/build with Gradle).

Specified by:

justBuild in interface QuinoaConfig

uiDir

public String uiDir()

Description copied from interface: QuinoaConfig

Path to the Web UI (NodeJS) root directory (relative to the project root).

Specified by:

uiDir in interface QuinoaConfig

buildDir

public Optional<String> buildDir()

Description copied from interface: QuinoaConfig

This the Web UI internal build system (webpack, ...) output directory. After the build, Quinoa will take the files from this directory, move them to 'target/quinoa/build' (or build/quinoa/build with Gradle) and serve them at runtime. The path is relative to the Web UI path.

Specified by:

buildDir in interface QuinoaConfig

packageManager

public Optional<String> packageManager()

Description copied from interface: QuinoaConfig

Name of the package manager binary. Only npm, pnpm and yarn are supported for the moment.

Specified by:

packageManager in interface QuinoaConfig

packageManagerInstall

public PackageManagerInstallConfig packageManagerInstall()

Description copied from interface: QuinoaConfig

Configuration for installing the package manager

Specified by:

packageManagerInstall in interface QuinoaConfig

packageManagerCommand

public PackageManagerCommandConfig packageManagerCommand()

Description copied from interface: QuinoaConfig

Configuration for overriding build commands

Specified by:

packageManagerCommand in interface QuinoaConfig

indexPage

public String indexPage()

Description copied from interface: QuinoaConfig

Name of the index page.

Specified by:

indexPage in interface QuinoaConfig

runTests

public boolean runTests()

Description copied from interface: QuinoaConfig

Indicate if the Web UI should also be tested during the build phase (i.e: npm test). To be used in a io.quarkus.test.junit.QuarkusTestProfile to have Web UI test running during a io.quarkus.test.junit.QuarkusTest

Specified by:

runTests in interface QuinoaConfig

ci

public Optional<Boolean> ci()

Description copied from interface: QuinoaConfig

Install the packages without generating a lockfile (frozen lockfile) and failing if an update is needed (useful in CI).

Specified by:

ci in interface QuinoaConfig

forceInstall

public boolean forceInstall()

Description copied from interface: QuinoaConfig

Force install packages before building. It will install packages only if the node_modules directory is absent or when the package.json is modified in dev-mode.

Specified by:

forceInstall in interface QuinoaConfig

framework

public FrameworkConfig framework()

Description copied from interface: QuinoaConfig

Configure framework detection

Specified by:

framework in interface QuinoaConfig

enableSPARouting

public boolean enableSPARouting()

Description copied from interface: QuinoaConfig

Enable SPA (Single Page Application) routing, all relevant requests will be re-routed to the index page. Currently, for technical reasons, the Quinoa SPA routing configuration won't work with RESTEasy Classic.

Specified by:

enableSPARouting in interface QuinoaConfig

ignoredPathPrefixes

public Optional<List<String>> ignoredPathPrefixes()

Description copied from interface: QuinoaConfig

List of path prefixes to be ignored by Quinoa.

Specified by:

ignoredPathPrefixes in interface QuinoaConfig

devServer

public DevServerConfig devServer()

Description copied from interface: QuinoaConfig

Configuration for the external dev server (live coding server)

Specified by:

devServer in interface QuinoaConfig