KiteConfigDoctorTask

@DisableCachingByDefault(because = "Reads mutable source-tree state and always reports current diagnostics.")
abstract class KiteConfigDoctorTask : KiteConfigDiagnosticTaskBase

Resilient human-readable setup diagnostic. Every supported check is attempted and reported with a stable ID. This task never fails merely because findings contain errors; use KiteConfigCheckTask for CI enforcement.

The four read-only tasks

TaskAnswersFails the build
kiteVerifywhich values did KiteConfig resolve?no
kiteDoctorwhat is wrong with my setup?no
kiteCheckthe same, for CIyes, on ERROR findings
kitePlanwhat 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

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Internal
abstract val activeAgpVersion: Property<String>
Link copied to clipboard
@get:Internal
abstract val activeComposeVersion: Property<String>
Link copied to clipboard
@get:Internal
abstract val activeKgpVersion: Property<String>
Link copied to clipboard
@get:Internal
abstract val agpOnClasspath: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val agpRequired: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val androidApplicationProjects: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val androidEmitMonochrome: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val androidLogoInputFingerprint: Property<String>
Link copied to clipboard
@get:Internal
abstract val androidManifestPaths: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val androidResDir: DirectoryProperty
Link copied to clipboard
@get:Internal
abstract val androidResPaths: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val appiconsetDir: DirectoryProperty
Link copied to clipboard
@get:Internal
abstract val appId: Property<String>
Link copied to clipboard
@get:Internal
abstract val appName: Property<String>
Link copied to clipboard
@get:Internal
abstract val autoRewrites: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val cleanupLegacyLogoArtifacts: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val colorEnabled: Property<Boolean>

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

Link copied to clipboard
@get:Internal
abstract val composeOnClasspath: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val composeRequired: Property<Boolean>
Link copied to clipboard
var description: @Nullable String
Link copied to clipboard
@get:Internal
abstract val desktopApplicationProjects: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val desktopBundleId: Property<String>
Link copied to clipboard
@get:Internal
abstract val desktopDeriveUpgradeUuid: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val desktopIconsExplicit: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val desktopLinuxPackageName: Property<String>
Link copied to clipboard
@get:Internal
abstract val detectedAndroidApplicationProjects: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val detectedDesktopApplicationProjects: ListProperty<String>
Link copied to clipboard
@get:Internal
var enabled: Boolean
Link copied to clipboard
@get:Internal
abstract val filterAndroidResources: Property<Boolean>
Link copied to clipboard
var group: @Nullable String
Link copied to clipboard
Link copied to clipboard
@get:Internal
abstract val hasVersionCodeOverride: Property<Boolean>
Link copied to clipboard
Link copied to clipboard
@get:Internal
abstract val infoPlistFile: RegularFileProperty
Link copied to clipboard
@get:Internal
abstract val iosBuildNumber: Property<String>
Link copied to clipboard
@get:Internal
abstract val iosBundleId: Property<String>
Link copied to clipboard
@get:Internal
abstract val iosDeploymentTarget: Property<String>
Link copied to clipboard
@get:Internal
abstract val iosLogoInputFingerprint: Property<String>
Link copied to clipboard
@get:Internal
abstract val iosMarketingVersion: Property<String>
Link copied to clipboard
@get:Internal
abstract val iosTargetNames: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val kgpOnClasspath: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val kgpRequired: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val locales: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val manifestFile: RegularFileProperty
Link copied to clipboard
@get:Internal
abstract val pbxprojFile: RegularFileProperty
Link copied to clipboard
@get:Internal
abstract val plistConflictPolicy: Property<PlistConflictPolicy>
Link copied to clipboard
@get:Internal
abstract val projectRootDir: DirectoryProperty
Link copied to clipboard
@get:Internal
abstract val proMotion120Hz: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateAppName: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateBundleId: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateDesktop: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateLocaleList: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateLogo: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val propagateVersion: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val resolvedVersionCode: Property<Int>
Link copied to clipboard
@get:Internal
abstract val sanitizeIosProject: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashAndroid: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashDesktop: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashIos: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashIosArmed: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashManifestPlaceholderPresent: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val splashThemeSet: Property<Boolean>
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
@get:Internal
abstract val syncIos: Property<Boolean>
Link copied to clipboard
val timeout: Property<Duration>
Link copied to clipboard
@get:Internal
abstract val usesNonExemptEncryption: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val versionGuardsIgnored: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val versionName: Property<String>

Functions

Link copied to clipboard
open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)
Link copied to clipboard
open override fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open operator override fun compareTo(other: Task): Int
Link copied to clipboard
open override fun configure(closure: Closure<Any>): Task
Link copied to clipboard
open override fun dependsOn(vararg paths: Any): Task
Link copied to clipboard
fun diagnose()
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
open override fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open override fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)
Link copied to clipboard
open override fun finalizedBy(vararg paths: Any): Task
Link copied to clipboard
open override fun getActions(): MutableList<Action<in Task>>
Link copied to clipboard
open override fun getAnt(): AntBuilder
Link copied to clipboard
@Internal
open override fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open override fun getDependsOn(): MutableSet<Any>
Link copied to clipboard
open override fun getDestroyables(): TaskDestroyables
Link copied to clipboard
open override fun getDidWork(): Boolean
Link copied to clipboard
open override fun getExtensions(): ExtensionContainer
Link copied to clipboard
open override fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open override fun getIdentityPath(): Path
Link copied to clipboard
open override fun getInputs(): TaskInputsInternal
Link copied to clipboard
@Internal
open override fun getLifecycleDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getLocalState(): TaskLocalState
Link copied to clipboard
open override fun getLogger(): Logger
Link copied to clipboard
open override fun getLogging(): LoggingManager
Link copied to clipboard
open override fun getMustRunAfter(): TaskDependency
Link copied to clipboard
open override fun getName(): String
Link copied to clipboard
open override fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open override fun getOutputs(): TaskOutputsInternal
Link copied to clipboard
open override fun getPath(): String
Link copied to clipboard
open override fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open override fun getSharedResources(): MutableList<ResourceLock>
Link copied to clipboard
open override fun getShouldRunAfter(): TaskDependency
Link copied to clipboard
open override fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>
Link copied to clipboard
open override fun getTaskDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getTaskIdentity(): TaskIdentity<*>
Link copied to clipboard
open override fun getTemporaryDir(): File
Link copied to clipboard
open override fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open override fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open override fun hasTaskActions(): Boolean
Link copied to clipboard
Link copied to clipboard
open override fun mustRunAfter(vararg paths: Any): Task
Link copied to clipboard
open override fun notCompatibleWithConfigurationCache(reason: String)
Link copied to clipboard
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>)
Link copied to clipboard
open override fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open override fun property(propertyName: String): Any
Link copied to clipboard
open override fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)
Link copied to clipboard
open override fun restoreTaskActions(taskActions: MutableList<InputChangesAwareTaskAction>)
Link copied to clipboard
open override fun setActions(replacements: MutableList<Action<in Task>>)
Link copied to clipboard
open override fun setDependsOn(dependsOn: MutableIterable<*>)
Link copied to clipboard
open override fun setDidWork(didWork: Boolean)
Link copied to clipboard
open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
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>)
Link copied to clipboard
open override fun setProperty(name: String, value: Any)
Link copied to clipboard
open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
open override fun usesService(service: Provider<out BuildService<*>>)