Package io.quarkiverse.quinoa.deployment.config

Interface QuinoaConfig

  • All Known Implementing Classes:
    QuinoaConfigDelegate
    @ConfigMapping(prefix="quarkus.quinoa")
@ConfigRoot(phase=BUILD_TIME)
public interface QuinoaConfig

    • Method Detail

      • enabled

        @WithParentName
@ConfigDocDefault("enabled (disabled in test mode)")
Optional<Boolean> enabled()
        Indicate if the extension should be enabled.

      • justBuild

        @WithDefault("false")
boolean justBuild()
        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).

      • uiDir

        @WithDefault("src/main/webui")
String uiDir()
        Path to the Web UI (NodeJS) root directory (relative to the project root).

      • buildDir

        @ConfigDocDefault("framework detection with fallback to \'build/\'")
Optional<String> buildDir()
        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.

      • packageManager

        @ConfigDocDefault("auto-detected based on lockfile falling back to \'npm\'")
Optional<String> packageManager()
        Name of the package manager binary. Only npm, pnpm and yarn are supported for the moment.

      • indexPage

        @WithDefault("index.html")
String indexPage()
        Name of the index page.

      • runTests

        @WithDefault("false")
boolean runTests()
        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

      • ci

        @ConfigDocDefault("true if environment CI=true")
Optional<Boolean> ci()
        Install the packages without generating a lockfile (frozen lockfile) and failing if an update is needed (useful in CI).

      • forceInstall

        @WithDefault("false")
boolean forceInstall()
        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.

      • enableSPARouting

        @WithDefault("false")
@WithName("enable-spa-routing")
boolean enableSPARouting()
        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.

      • ignoredPathPrefixes

        @ConfigDocDefault("ignore values configured by \'quarkus.resteasy-reactive.path\', \'quarkus.resteasy.path\' and \'quarkus.http.non-application-root-path\'")
Optional<List<String>> ignoredPathPrefixes()
        List of path prefixes to be ignored by Quinoa.

      • devServer

        DevServerConfig devServer()
        Configuration for the external dev server (live coding server)

      • getNormalizedIgnoredPathPrefixes

        static List<String> getNormalizedIgnoredPathPrefixes​(QuinoaConfig config)

      • toHandlerConfig

        static QuinoaHandlerConfig toHandlerConfig​(QuinoaConfig config,
                                           boolean prodMode,
                                           io.quarkus.vertx.http.runtime.HttpBuildTimeConfig httpBuildTimeConfig)

      • isDevServerMode

        static boolean isDevServerMode​(QuinoaConfig config)

      • isEnabled

        static boolean isEnabled​(QuinoaConfig config)