全部配置 / APP-ALLWARNINGSASERRORS

警告视为错误

allWarningsAsErrors · APP-ALLWARNINGSASERRORS · Gradle DSL · 同源入口 Werror

重要:高 · 影响大 默认:默认关 场合:场景可配 来源:上游原样

默认值:默认关。未开则警告不升为错误。使用场合:场景可配。场景可配:有明确目标(性能、包体、安全、兼容)时再改。

它是做什么的

用途。存在警告时按错误失败(对齐 -Werror),适合 CI 门禁。

影响。改变警告是否阻断构建或是否可见;影响 CI 门禁灵敏度,不改变运行语义。

适用场景。CI 或质量门禁;本地迭代可按需放宽。

取值说明

布尔

  • Report an error if there are any warnings.

可写。true / false

定义依据:dsl/KotlinCommonCompilerToolOptions.kt 在仓库中打开

怎么用

  1. 配置入口:build.gradle.kts → kotlin.compilerOptions.allWarningsAsErrors
  2. 示例
// 文件:build.gradle.kts(应用的 Kotlin 模块,例如 composeApp)
kotlin {
  compilerOptions {
    allWarningsAsErrors.set(/* value */)
  }
}
  1. 生效:Sync 后执行对应 Kotlin 编译任务。
  2. 验证:编译日志出现 `allWarningsAsErrors`。
  3. 回滚:删除对应 compilerOptions 项后 Clean 并重编。
  4. 注意:按 Debug/Release 分流配置,避免公共污染。

同源旧旗标

应用工程只按上方「怎么用」里的 Gradle 示例配置。下面列出编译器还认识的旧名字,避免对着旧文档混用。

优先级:同一「警告当错误」能力;工程里优先用 compilerOptions.allWarningsAsErrors。

  • 推荐旗标compilerOptions.allWarningsAsErrors(键 allWarningsAsErrors) — Gradle DSL(compilerOptions)。
  • 旧旗标(勿用)-Werror(键 Werror) — Native 编译器参数(警告升级为错误)。

默认行为 默认关

不写这个配置时,编译器会怎么处理?

此选项默认关闭,不设置时不生效。需要时显式开启。

未开则警告不升为错误。

相关文档

以下摘抄原文中与本配置最相关的段落,便于速读;完整上下文请点原文。 上游与 CPF 分栏对照。

溯源与对照

状态
稳定(正式选项)
版本基线
2.2.21-1.0.0
定义位置类型
Gradle 插件 API(compilerOptions)
源码路径
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonCompilerToolOptions.kt 在仓库中打开