kobweb-common/com.varabyte.kobweb.project/KobwebFolder

KobwebFolder

class KobwebFolder(val path: Path)(source)

The Kobweb folder is a special folder which contains various configuration files, runtime files, and other output associated with a Kobweb project.

The class is essentially a typed wrapper around a Path instance which points at the folder.

If a normal directory has a Kobweb folder inside of it, then it is considered a Kobweb project.

If a Kobweb project contains any subfolders that themselves own a Kobweb folder, then that is considered a different project and opaque to the parent project.

Constructors

KobwebFolder

constructor(path: Path)

Creates an instance of KobwebFolder based on the given path. Throws an IllegalArgumentException if the path is invalid or does not exist. Prefer using a safe constructor function when possible, such as inPath.

Types

Companion

object Companion

Properties

path

val path: Path

The Path object that represents the folder location.