quarkdown-cli/com.quarkdown.cli.util/CleanRefusal

CleanRefusal

Reason why cleaning a directory is refused for safety. Combined with --clean, accidental targeting of a sensitive directory could result in irreversible data loss, so the CLI refuses any of these cases up front.

Inheritors

Types

ContainsSourceFile

data class ContainsSourceFile(val source: File) : CleanRefusal

The directory (recursively) contains the main source file of the compilation.

FilesystemRoot

data object FilesystemRoot : CleanRefusal

The directory is a filesystem root (e.g. / on Unix, C:\ on Windows).

HomeDirectory

data object HomeDirectory : CleanRefusal

The directory is the user's home directory.

RepositoryRoot

data object RepositoryRoot : CleanRefusal

The directory looks like the root of a source-controlled project (it contains a .git entry).

WorkingDirectory

data object WorkingDirectory : CleanRefusal

The directory is the current working directory the CLI was invoked from.

Properties

message

abstract val message: String

Human-readable explanation of why the directory cannot be cleaned.