RuleContext

sealed class RuleContext

Rule Context keeps track of currently exporting content.

Inheritors

Types

Link copied to clipboard
data class ExportingManualOverride(val manualOverride: ManualOverride, val lockFile: LockFile, val configFile: ConfigFile, val workingSubDir: String) : RuleContext

Rule context representing a manual override.

Link copied to clipboard
data class ExportingOverride(val path: String, val type: OverrideType, val lockFile: LockFile, val configFile: ConfigFile, val workingSubDir: String) : RuleContext

Rule context representing an 'override'.

Link copied to clipboard
data class ExportingProject(val project: Project, val lockFile: LockFile, val configFile: ConfigFile, val workingSubDir: String) : RuleContext

Rule context representing a project.

Link copied to clipboard
data class Finished(val lockFile: LockFile, val configFile: ConfigFile, val workingSubDir: String) : RuleContext

Rule context indicating that all other actions have been finished.

Link copied to clipboard
data class MissingProject(val project: Project, val lockFile: LockFile, val configFile: ConfigFile, val workingSubDir: String) : RuleContext

Rule context representing a missing project.

Properties

Link copied to clipboard
Link copied to clipboard
open val lockFile: LockFile
Link copied to clipboard

Functions

Link copied to clipboard
fun createFile(bytes: ByteArray, path: String, vararg subpath: String): RuleResult

Creates a new file at the specified path& returns a result.

fun createFile(bytesCallback: suspend () -> <Error class: unknown class><ByteArray, ActionError>?, path: String, vararg subpath: String): RuleResult

Lazily creates a new file at the specified path if it does not already exist, and returns a result.

Link copied to clipboard
inline fun <T> createJsonFile(value: T, path: String, vararg subpath: String, format: <Error class: unknown class> = json): RuleResult

Creates a new JSON file at the specified path& returns a result.

Link copied to clipboard

Returns an error.

Link copied to clipboard
fun getPath(): <Error class: unknown class>
fun getPath(path: String, vararg subpath: String): <Error class: unknown class>
Link copied to clipboard

Ignores this rule context.

Link copied to clipboard
fun RuleContext.ruleResult(message: String, packaging: Packaging): RuleResult