KDoctor: Your Ultimate Troubleshooting Companion for the Kotlin Multiplatform Ecosystem

What is KDoctor?

Installing KDoctor

brew install kdoctor

1. Install KDoctor.

2. Open a terminal window.

3. Type kdoctor and press Enter.

4. Wait for KDoctor to complete the diagnostics. The output will show whether your system is ready for Kotlin Multiplatform Mobile development.

KDoctor - The Tool Overview

• findAndroidStudio() method in AndroidStudioDiagnostic class, which searches for Android Studio installations and filters out backups created by the JetBrains Toolbox.

• findGradleWrapper() method in GradleDiagnostic class, which searches for Gradle wrapper scripts in the current directory and its parent directories, and returns the path of the first script found.

• CocoapodsDiagnostic class, which checks the Ruby and Ruby Gems installations, and verifies the installation and version of CocoaPods.

• JavaDiagnostic class, which checks whether Java is installed and whether the JAVA_HOME environment variable is set correctly.

• findXcode function takes a path to an Xcode installation and returns an Application object representing the Xcode installation. The diagnose function uses this function to find all Xcode installations on the system.

• The main entry point of the KDoctor tool. The main function instantiates and runs a Main object, which is a CliktCommand object that parses the command line arguments using the Clikt library.

Conclusion

Reference

Source Code Explanation: KDoctor Tool by Kotlin

actual fun getSystem(): System = MacosSystem()

class Doctor(private val system: System) {
    fun diagnoseKmmEnvironment(
        verbose: Boolean,
        debug: Boolean,
        extraDiagnostics: Boolean,
        localCompatibilityJson: String?,
        templateProjectTag: String?
    ): Flow<String> = channelFlow {
        if (verbose) {
            send("Environment diagnose:\\n")
        } else {
            send("Environment diagnose (to see all details, use -v option):\\n")
        }
        ...
    }
}

internal const val KDOCTOR_VERSION = "1.0.0"

fun main(args: Array<String>) = Main().main(args)

private class Main : CliktCommand(name = "kdoctor") {

		val showVersion: Boolean by option(
		        "--version",
		        help = "Report a version of KDoctor"
	    ).flag()
    val isVerbose: Boolean by option(
        "--verbose", "-v",
        help = "Report an extended information"
    ).flag()
    val isExtraDiagnostics: Boolean by option(
        "--all", "-a",
        help = "Run extra diagnostics such as a build of a synthetic project and an analysis of a project in the current directory"
    ).flag()

    val showDevelopmentTeams: Boolean by option(
        "--team-ids",
        help = "Report all available Apple dev team ids"
    ).flag()

    val isDebug: Boolean by option("--debug", hidden = true).flag()
    val localCompatibilityJson: String? by option("--compatibilityJson", hidden = true)
    val templateProjectTag: String? by option("--templateProject", hidden = true)


    override fun run() {
        ...
    }
}

expect fun getSystem(): System

enum class OS(private val str: String) {
    MacOS("macOS"),
    Windows("Windows"),
    Linux("Linux");

    override fun toString() = str
}

enum class Shell(val path: String, val profile: String) {
    Bash("/bin/bash", "~/.bash_profile"),
    Zsh("/bin/zsh", "~/.zprofile")
}

data class ProcessResult(val code: Int, val rawOutput: String?) {
    val output get() = if (code == 0) rawOutput else null
}

interface System {
    val currentOS: OS
    val osVersion: Version?
    val cpuInfo: String?
    val homeDir: String
    val shell: Shell?

    fun getEnvVar(name: String): String?
    fun execute(command: String, vararg args: String): ProcessResult

    fun fileExists(path: String): Boolean
    fun readFile(path: String): String?
    fun writeTempFile(content: String): String
    fun readArchivedFile(pathToArchive: String, pathToFile: String): String?
    fun findAppsPathsInDirectory(prefix: String, directory: String, recursively: Boolean = false): List<String>
}

fun System.isUsingRosetta() =
    execute("sysctl", "sysctl.proc_translated").output
        ?.substringAfter("sysctl.proc_translated: ")
        ?.toIntOrNull() == 1

fun System.isUsingM1() =
    cpuInfo?.contains("Apple") == true

fun System.parsePlist(path: String): Map<String, Any>? {
    ...
}

fun System.spotlightFindAppPaths(appId: String): List<String> =
    execute("/usr/bin/mdfind", "kMDItemCFBundleIdentifier=\\"$appId\\"").output
        ?.split("\\n")
        ?.filter { it.isNotBlank() }
        .orEmpty()

object TextPainter {
    const val RESET = "\\u001B[0m"
    const val RED = "\\u001B[31m"
    const val GREEN = "\\u001B[32m"
    const val YELLOW = "\\u001B[33m"
    const val BOLD = "\\u001B[1m"
}

class XcodeDiagnostic(private val system: System) : Diagnostic() {
    override val title = "Xcode"

    override fun diagnose(): Diagnosis {
        ...
    }

    private fun findXcode(path: String): Application? {
        Logger.d("findXcode($path)")
        val plist = system.parsePlist("$path/Contents/Info.plist") ?: return null
        val version = plist["CFBundleShortVersionString"]?.toString()?.trim('"') ?: return null
        val name = plist["CFBundleName"]?.toString()
            ?.trim('"')
            ?: path.substringAfterLast("/").substringBeforeLast(".")
        return Application(name, Version(version), path)
    }
}

class AndroidStudioDiagnostic(private val system: System) : Diagnostic() {
    override val title = "Android Studio"

    override fun diagnose(): Diagnosis {
        ...
    }

    private fun findAndroidStudio(path: String): Application? {
        Logger.d("findAndroidStudio($path)")
        val plist = system.parsePlist("$path/Contents/Info.plist") ?: return null
        val version = plist["CFBundleVersion"]?.toString()?.trim('"') ?: return null
        val name = plist["CFBundleName"]?.toString()?.trim('"')
            ?: path.substringAfterLast("/").substringBeforeLast(".")
        return Application(name, Version(version), path)
    }
}

actual fun getSystem(): System = TODO("JVM target is only for unit tests")