KDoctor

KDoctor是一个命令行工具,可帮助设置Kotlin跨平台移动应用程序开发的环境。

概述

KDoctor确保所有所需组件均已正确安装并准备就绪。如果缺少某些内容或未正确配置,KDoctor会突出显示问题并提出解决方案。

KDoctor执行以下诊断:

系统 - 检查操作系统版本
JDK - 检查JDK安装和JAVA_HOME设置
Android Studio - 检查Android Studio安装,Kotlin和Kotlin跨平台移动插件
Xcode - 检查Xcode安装和设置
CocoaPods - 检查ruby环境和cocoapods gem安装

其他诊断:

合成生成的项目 - 从https://github.com/Kotlin/kdoctor/tree/template下载并构建项目
本地Gradle项目 - 检查当前目录中用户的项目

要求

KDoctor仅适用于MacOS。

安装

手动

您可以从GitHub下载存档:

转到Releases页面
下载最新可用版本
将其解压缩到首选位置

Homebrew

通过Homebrew安装,使用以下命令:

brew install kdoctor

从源代码构建

要从源代码构建,请使用:

git clone https://github.com/Kotlin/kdoctor
cd kdoctor
./gradlew assembleReleaseExecutableMacos

使用

在控制台中调用KDoctor并等待其完成诊断

kdoctor
诊断Kotlin跨平台移动环境...

一旦KDoctor完成诊断,它就会生成一份报告。如果未发现问题,您的系统已准备就绪Kotlin跨平台移动开发:

您的系统已准备就绪Kotlin跨平台移动开发!

如果KDoctor通知存在问题,请查看报告:

KDoctor在检查您的环境时发现一个或多个问题。
请查看输出以了解问题描述和可能的解决方案。

检查每个诊断的结果。有3种可能的状态:

[✓] - 成功
[✖] - 失败
[!] - 警告

最注意失败的诊断([✖])并查找以*开头的消息,了解问题描述和潜在解决方案。

也值得检查带有警告([!])的诊断,甚至成功的信息,因为它们可能包含有用的注释和提示。

使用 -h 选项执行KDoctor以打印所有可用选项

kdoctor -h
用法:kdoctor [选项]

选项:
  --version       报告KDoctor的版本
  -v, --verbose   报告扩展信息
  -a, --all       运行额外的诊断,如合成项目的构建和当前目录中项目的分析
  -h, --help      显示此消息并退出

样本详细输出

kdoctor -v
环境诊断:
[✓] 操作系统
  ➤ 操作系统版本: macOS 13.1
    CPU: Apple M1 Max

[✓] Java
  ➤ Java (openjdk version "11.0.16" 2022-07-19 LTS)
    位置: /Users/me/.sdkman/candidates/java/current/bin/java
  ➤ JAVA_HOME: /Users/me/.sdkman/candidates/java/current

[✓] Android Studio
  i 找到多个Android Studio安装
  ➤ Android Studio (AI-222.4459.24.2221.9445173)
    位置: /Users/me/Library/Application Support/JetBrains/Toolbox/apps/AndroidStudio/ch-0/222.4459.24.2221.9445173/Android Studio Preview.app
    捆绑的Java: openjdk 17.0.4.1 2022-08-12
    Kotlin插件: 222-1.8.0-release-AS3739.54
    Kotlin跨平台移动插件: 1.0.0-SNAPSHOT
  ➤ Android Studio (AI-221.6008.13.2211.9477386)
    位置: /Users/me/Library/Application Support/JetBrains/Toolbox/apps/AndroidStudio/ch-2/221.6008.13.2211.9477386/Android Studio.app
    捆绑的Java: openjdk 11.0.15 2022-04-19
    Kotlin插件: 221-1.7.21-release-for-android-studio-AS5591.52
    Kotlin跨平台移动插件: 0.5.2(221)-3
  i 请注意,默认情况下,Android Studio使用捆绑的JDK来执行Gradle任务。
    Gradle JDK可以在Android Studio首选项的"构建、执行、部署"->
    "构建工具"->
    "Gradle"部分进行配置

[✓] Xcode
  ➤ Xcode (14.2)
    位置: /Applications/Xcode-14.2.0.app
  i Xcode JAVA_HOME: /Users/me/Library/Java/JavaVirtualMachines/jbr-17.0.5/Contents/Home
    Xcode JAVA_HOME 可以在
    Xcode->
    设置->
    位置->
    自定义路径中进行配置

[✓] Cocoapods
  ➤ ruby (ruby 3.1.3p185 (2022-11-24 修订 1a6b16756e) [arm64-darwin21])
  ➤ ruby gems (3.3.26)
  ➤ cocoapods (1.11.3)

建议:
  ➤ IDE不建议在包含多个类的文件中运行所有测试
    更多详细信息: https://youtrack.jetbrains.com/issue/KTIJ-22078
结论:
  ✓ 您的系统已准备就绪Kotlin跨平台移动开发!