application/com.varabyte.kobweb.gradle.application.tasks

Package-level declarations

Types

KobwebBrowserCacheIdTask

@DisableCachingByDefault(because = "Trivial output, not worth caching.")

abstract class KobwebBrowserCacheIdTask : KobwebTask

A task for generating an ID that can be used for naming a cache bucket on a CI.

KobwebCacheAppBackendDataTask

@CacheableTask

abstract class KobwebCacheAppBackendDataTask : DefaultTask

Collect all backend app data from the current site and all library dependencies, writing the result to appDataFile.

KobwebCacheAppFrontendDataTask

@CacheableTask

abstract class KobwebCacheAppFrontendDataTask : DefaultTask

Collect all frontend app data from the current site and all library dependencies, writing the result to appDataFile.

KobwebCopySupplementalResourcesTask

@DisableCachingByDefault(because = "This is just a copy task (and caching the files would not avoid the copy).")

abstract class KobwebCopySupplementalResourcesTask @Inject constructor(appBlock: AppBlock, val indexFile: Provider<RegularFile>) : KobwebCopyTask

KobwebCopyTask

@DisableCachingByDefault(because = "Base task; up to children to decide caching strategy for themselves.")

abstract class KobwebCopyTask(desc: String) : KobwebTask

Common base class for all "Kobweb copy" tasks, with convenience methods for processing & copying files.

KobwebCopyWorkerJsOutputTask

@DisableCachingByDefault(because = "This is just a copy task (and caching the files would not avoid the copy).")

abstract class KobwebCopyWorkerJsOutputTask @Inject constructor(appBlock: AppBlock) : KobwebCopyTask

Copy JS output which is automatically packaged into metadata by the Kobweb worker plugin.

KobwebCreatePublicDevFilesTask

@DisableCachingByDefault(because = "Trivial output, not worth caching.")

abstract class KobwebCreatePublicDevFilesTask @Inject constructor(appBlock: AppBlock) : KobwebTask

Create a special public dev folder, useful to add information that a dev server can check.

KobwebCreateServerScriptsTask

@DisableCachingByDefault(because = "Trivial output, not worth caching.")

abstract class KobwebCreateServerScriptsTask : KobwebTask

A simple task for creating scripts which can be used to run the Kobweb server in production mode.

KobwebExportConfInputs

class KobwebExportConfInputs(val siteRoot: String, val basePath: String, val script: String, val api: String?)

KobwebExportTask

@UntrackedTask(because = "Task runs a server / does not create output meant to be consumed by Gradle.")

abstract class KobwebExportTask @Inject constructor(exportBlock: AppBlock.ExportBlock, val confInputs: KobwebExportConfInputs, val siteLayout: Provider<SiteLayout>) : KobwebTask

KobwebGenerateApisFactoryTask

@DisableCachingByDefault(because = "Trivial output, not worth caching.")

abstract class KobwebGenerateApisFactoryTask @Inject constructor(appBlock: AppBlock) : KobwebGenerateTask

KobwebGenerateSiteEntryTask

@CacheableTask

abstract class KobwebGenerateSiteEntryTask @Inject constructor(appBlock: AppBlock, val basePath: String, val buildTarget: BuildTarget, val confInputs: KobwebGenSiteEntryConfInputs) : KobwebGenerateTask

KobwebGenerateSiteIndexTask

@CacheableTask

abstract class KobwebGenerateSiteIndexTask @Inject constructor(appBlock: AppBlock, val confInputs: KobwebGenIndexConfInputs, val buildTarget: BuildTarget) : KobwebGenerateTask

KobwebGenerateTask

@DisableCachingByDefault(because = "Base task; up to children to decide caching strategy for themselves.")

abstract class KobwebGenerateTask(desc: String) : KobwebTask

Common base class for all "Kobweb generate" tasks.

KobwebGenIndexConfInputs

class KobwebGenIndexConfInputs(val title: String, val basePath: String, val script: String)

KobwebGenSiteEntryConfInputs

class KobwebGenSiteEntryConfInputs(val redirects: List<KobwebGenSiteEntryConfInputs.Redirect>)

KobwebListRoutesTask

@UntrackedTask(because = "This task just generates logging output meant for a user to read in the terminal.")

abstract class KobwebListRoutesTask : KobwebTask

Print all routes for the current site to the console.

KobwebStartTask

@UntrackedTask(because = "Task runs a server / does not create output meant to be consumed by Gradle.")

abstract class KobwebStartTask @Inject constructor(remoteDebuggingBlock: AppBlock.ServerBlock.RemoteDebuggingBlock, env: ServerEnvironment, siteLayout: Provider<SiteLayout>, systemProperties: MapProperty<String, String>, reuseServer: Boolean) : KobwebTask

Start a Kobweb web server.

KobwebStopTask

@UntrackedTask(because = "Task stops a server / does not create output meant to be consumed by Gradle.")

abstract class KobwebStopTask : KobwebTask

Stop a Kobweb web server started by the KobwebStartTask.

KobwebUnpackServerJarTask

@DisableCachingByDefault(because = "Trivial output, not worth caching.")

abstract class KobwebUnpackServerJarTask : KobwebTask

Extract the server jar from this plugin's resources into the .kobweb folder.

Functions

routes

fun AppFrontendData.routes(excludeDynamicRoutes: Boolean): List<String>