KiteConfig/io.github.yuroyami.kiteconfig/KiteConfigCheckTask

KiteConfigCheckTask

@DisableCachingByDefault(because = "Reads mutable source-tree state; diagnostics must reflect the current checkout.")

abstract class KiteConfigCheckTask : KiteConfigDiagnosticTaskBase

Strict counterpart to KiteConfigDoctorTask. It runs the identical aggregate, read-only checks, always writes a deterministic report, and fails after report creation when ERROR findings (or optionally warnings) exist.

The four read-only tasks

Task	Answers	Fails the build
`kiteVerify`	which values did KiteConfig resolve?	no
`kiteDoctor`	what is wrong with my setup?	no
`kiteCheck`	the same, for CI	yes, on ERROR findings
`kitePlan`	what would the mutation tasks write?	no

None of the four writes to your source tree, and none of them needs dryRun. Colour is added when a real terminal is attached; NO_COLOR, TERM=dumb, and --console=plain each turn it off, and -Pkiteconfig.color=true|false forces it.

Constructors

KiteConfigCheckTask

constructor()

Properties

activeAgpVersion

@get:Internal

abstract val activeAgpVersion: Property<String>

activeComposeVersion

@get:Internal

abstract val activeComposeVersion: Property<String>

activeKgpVersion

@get:Internal

abstract val activeKgpVersion: Property<String>

@get:Internal

abstract val agpOnClasspath: Property<Boolean>

@get:Internal

abstract val agpRequired: Property<Boolean>

androidApplicationProjects

@get:Internal

abstract val androidApplicationProjects: ListProperty<String>

androidEmitMonochrome

@get:Internal

abstract val androidEmitMonochrome: Property<Boolean>

androidLogoInputFingerprint

@get:Internal

abstract val androidLogoInputFingerprint: Property<String>

androidManifestPaths

@get:Internal

abstract val androidManifestPaths: ListProperty<String>

@get:Internal

abstract val androidResDir: DirectoryProperty

androidResPaths

@get:Internal

abstract val androidResPaths: ListProperty<String>

@get:Internal

abstract val appiconsetDir: DirectoryProperty

@get:Internal

abstract val appId: Property<String>

@get:Internal

abstract val appName: Property<String>

@get:Internal

abstract val autoRewrites: Property<Boolean>

cleanupLegacyLogoArtifacts

@get:Internal

abstract val cleanupLegacyLogoArtifacts: Property<Boolean>

@get:Internal

abstract val colorEnabled: Property<Boolean>

Presentation only, so it never affects up-to-date checks.

composeOnClasspath

@get:Internal

abstract val composeOnClasspath: Property<Boolean>

composeRequired

@get:Internal

abstract val composeRequired: Property<Boolean>

var description: @Nullable String

desktopApplicationProjects

@get:Internal

abstract val desktopApplicationProjects: ListProperty<String>

desktopBundleId

@get:Internal

abstract val desktopBundleId: Property<String>

desktopDeriveUpgradeUuid

@get:Internal

abstract val desktopDeriveUpgradeUuid: Property<Boolean>

desktopIconsExplicit

@get:Internal

abstract val desktopIconsExplicit: Property<Boolean>

desktopLinuxPackageName

@get:Internal

abstract val desktopLinuxPackageName: Property<String>

detectedAndroidApplicationProjects

@get:Internal

abstract val detectedAndroidApplicationProjects: ListProperty<String>

detectedDesktopApplicationProjects

@get:Internal

abstract val detectedDesktopApplicationProjects: ListProperty<String>

@get:Internal

var enabled: Boolean

@get:Input

abstract val failOnWarnings: Property<Boolean>

Also fail after writing the report when warnings exist. Default false.

filterAndroidResources

@get:Internal

abstract val filterAndroidResources: Property<Boolean>

var group: @Nullable String

hasCustomActions

val hasCustomActions: Boolean

hasVersionCodeOverride

@get:Internal

abstract val hasVersionCodeOverride: Property<Boolean>

impliesSubProjects

var impliesSubProjects: Boolean

@get:Internal

abstract val infoPlistFile: RegularFileProperty

@get:Internal

abstract val iosBuildNumber: Property<String>

@get:Internal

abstract val iosBundleId: Property<String>

iosDeploymentTarget

@get:Internal

abstract val iosDeploymentTarget: Property<String>

iosLogoInputFingerprint

@get:Internal

abstract val iosLogoInputFingerprint: Property<String>

iosMarketingVersion

@get:Internal

abstract val iosMarketingVersion: Property<String>

@get:Internal

abstract val iosTargetNames: ListProperty<String>

@get:Internal

abstract val kgpOnClasspath: Property<Boolean>

@get:Internal

abstract val kgpRequired: Property<Boolean>

@get:Internal

abstract val locales: ListProperty<String>

@get:Internal

abstract val manifestFile: RegularFileProperty

@get:Internal

abstract val pbxprojFile: RegularFileProperty

plistConflictPolicy

@get:Internal

abstract val plistConflictPolicy: Property<PlistConflictPolicy>

@get:Internal

abstract val projectRootDir: DirectoryProperty

@get:Internal

abstract val proMotion120Hz: Property<Boolean>

propagateAppName

@get:Internal

abstract val propagateAppName: Property<Boolean>

propagateBundleId

@get:Internal

abstract val propagateBundleId: Property<Boolean>

propagateDesktop

@get:Internal

abstract val propagateDesktop: Property<Boolean>

propagateLocaleList

@get:Internal

abstract val propagateLocaleList: Property<Boolean>

@get:Internal

abstract val propagateLogo: Property<Boolean>

propagateVersion

@get:Internal

abstract val propagateVersion: Property<Boolean>

@get:OutputFile

abstract val reportFile: RegularFileProperty

Report destination. By default this follows reportFormat under build/reports/kiteconfig/diagnostics.json or diagnostics.sarif.

@get:Input

abstract val reportFormat: Property<KiteConfigDiagnosticReportFormat>

Machine-readable output format. Default KiteConfigDiagnosticReportFormat.JSON.

resolvedVersionCode

@get:Internal

abstract val resolvedVersionCode: Property<Int>

sanitizeIosProject

@get:Internal

abstract val sanitizeIosProject: Property<Boolean>

@get:Internal

abstract val splashAndroid: Property<Boolean>

@get:Internal

abstract val splashDesktop: Property<Boolean>

@get:Internal

abstract val splashIos: Property<Boolean>

@get:Internal

abstract val splashIosArmed: Property<Boolean>

splashManifestPlaceholderPresent

@get:Internal

abstract val splashManifestPlaceholderPresent: Property<Boolean>

@get:Internal

abstract val splashThemeSet: Property<Boolean>

val state: TaskStateInternal

@get:Internal

abstract val syncIos: Property<Boolean>

val timeout: Property<Duration>

usesNonExemptEncryption

@get:Internal

abstract val usesNonExemptEncryption: Property<Boolean>

versionGuardsIgnored

@get:Internal

abstract val versionGuardsIgnored: Property<Boolean>

@get:Internal

abstract val versionName: Property<String>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

fun check()

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

open override fun dependsOn(vararg paths: Any): Task

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

doNotTrackStateIf

open override fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)

open override fun finalizedBy(vararg paths: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

open override fun getDependsOn(): MutableSet<Any>

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonsNotToTrackState

open override fun getReasonsNotToTrackState(): MutableSet<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open override fun property(propertyName: String): Any

open override fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)

restoreTaskActions

open override fun restoreTaskActions(taskActions: MutableList<InputChangesAwareTaskAction>)

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDidWork(didWork: Boolean)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

open override fun usesService(service: Provider<out BuildService<*>>)