core/com.varabyte.kobweb.gradle.core.util

Package-level declarations

Types

DownloadedFileMetadata

@Serializable

class DownloadedFileMetadata(val fromUrl: String, val contentType: String?)

Additional information about the file we just downloaded.

DownloadResult

class DownloadResult(val file: File, val metadata: DownloadedFileMetadata)

HtmlUtil

object HtmlUtil

KobwebVersionUtil

object KobwebVersionUtil

LoggingReporter

class LoggingReporter(logger: Logger) : Reporter

Reporter

interface Reporter

Interface that abstracts out reporting error messages.

RootAndFile

class RootAndFile(val root: File, val file: File)

Functions

configureComposeCompiler

fun Project.configureComposeCompiler()

configureHackWorkaroundSinceWebpackTaskIsBrokenInContinuousMode

fun TaskCollection<KotlinWebpack>.configureHackWorkaroundSinceWebpackTaskIsBrokenInContinuousMode()

downloadOrCached

fun ProjectLayout.downloadOrCached(logger: Logger, url: URL): DownloadResult

generateModuleMetadataFor

fun Project.generateModuleMetadataFor(target: TargetPlatform<*>)

All Kobweb dependencies should include a module.json to identify themselves as such.

getBuildScripts

fun ProjectLayout.getBuildScripts(): List<Path>

Return all Gradle build scripts within the given project layout.

getJsDependencyResults

fun Project.getJsDependencyResults(): Provider<List<ResolvedDependencyResult>>

Lazily returns a list of this module's direct JS dependencies (no transitive dependencies included).

getResourceSources

fun Project.getResourceSources(target: TargetPlatform<*>): Provider<SourceDirectorySet>

getTransitiveJsDependencyResults

fun Project.getTransitiveJsDependencyResults(): Provider<List<ResolvedDependencyResult>>

Lazily returns a list of this module's direct & transitive JS dependencies.

hasDependencyNamed

fun Provider<List<ResolvedDependencyResult>>.hasDependencyNamed(name: String): Provider<Boolean>

Lazily evaluates whether the provided dependency is included in the list of resolved dependencies.

importCss

fun STYLE.importCss(url: String, layerName: String? = null)

Adds an @import rule to import a CSS stylesheet, optionally loading it into a specific CSS Cascade layer.

isDescendantOf

fun File.isDescendantOf(maybeAncestor: File): Boolean

fun File.isDescendantOf(maybeAncestorTest: (File) -> Boolean): Boolean

kobwebCacheDir

fun Task.kobwebCacheDir(): Provider<Directory>

Return a unique build cache directory for this task.

fun ProjectLayout.kobwebCacheDir(): Provider<Directory>

Return a unique build cache directory.

kobwebCacheFile

fun Task.kobwebCacheFile(path: String): Provider<RegularFile>

Return a file under the cache directory for this task.

fun ProjectLayout.kobwebCacheFile(path: String): Provider<RegularFile>

Return a file under the cache directory.

namedOrNull

inline fun <V : Task> TaskCollection<in V>.namedOrNull(name: String): TaskProvider<V>?

Replacement for findByName that supports task configuration avoidance.

searchZipFor

fun File.searchZipFor(path: String, handle: (ByteArray) -> Unit)

If the target file is a zip file, search it for a single file that it may contain.

suggestKobwebProjectName

fun Project.suggestKobwebProjectName(): String

Suggest a name to use to represent this Kobweb project.

toUidString

fun Project.toUidString(): String

Generate a consistent, unique ID for this project.