如何在编写Gradle插件时编写适当的警告消息?

时间:2014-03-10 14:09:38

标签: plugins coding-style gradle warnings message

我正在尝试编写一个Gradle插件,我有一个用户指定一堆文件的情况,当文件没有特定的扩展名时,则必须抛出警告,因为这些文件无法处理。 所以我想知道是否有一个约定如何构造适当的警告消息,所以消息要清晰,不要在数千行的项目日志中消失。

我认为:

WARNING!!! The file ${file.getName()} is with incompatible extention type ${extention}. The appropriate extension is ${EXTETNIO_TYPE}. The current file will not be taken during the build."

但是在查看Gradle代码时。他们的警告信息只是没有警告或其他任何内容的消息。 请给我你的建议。

1 个答案:

答案 0 :(得分:2)

通常使用log.warn()记录警告消息。但是,如果无法处理文件,则抛出GradleException可能更合适。应尽可能避免警告,因为它们会产生噪音,要求用户始终检查命令行输出,并且容易被忽视。