InitBuild

API 文档InitBuild

生成 Gradle 项目结构。

属性

属性描述
allowFileOverwrite
孵化中

是否允许覆盖构建目录中已存在的文件?此属性可以通过命令行选项 '--overwrite' 设置。默认为 false。

comments
孵化中

是否应在文件中添加解释性注释?

dsl

要创建的构建脚本的期望 DSL,默认为 'kotlin'。此属性可以通过命令行选项 '--dsl' 设置。

insecureProtocol

如何处理用于 Maven 仓库的不安全 (http) URL。此属性可以通过命令行选项 '--insecure-protocol' 设置。默认值为 'warn'。

javaVersion
孵化中

生成的 Java 项目要使用的 Java 版本。设置后,Gradle 将使用提供的值作为所有相关生成项目的目标主要 Java 版本。Gradle 将验证该数字以确保它是有效且受支持的主要版本。

packageName

用于生成的源代码的包名。此属性可以通过命令行选项 '--package' 设置。

projectName

生成的项目名称,默认为项目生成的目录名称。此属性可以通过命令行选项 '--project-name' 设置。

splitProject

是否应将构建拆分为多个子项目?此属性可以通过命令行选项 '--split-project' 和 '--no-split-project' 设置。

testFramework

要在生成的项目中使用的测试框架。此属性可以通过命令行选项 '--test-framework' 设置

type

要生成的期望项目类型,例如 'java-application' 或 'kotlin-library'。

useDefaults
孵化中

是否应自动接受未显式配置的选项的默认值?

useIncubating

生成的构建是否可以使用新的和不稳定的功能?启用后,生成的构建将使用在次要版本之间可能不稳定的新模式、API 或功能。如果您想尝试 Gradle 的最新功能,请使用此选项。默认情况下,init 将生成一个使用稳定功能和行为的构建。

方法

无方法

脚本块

无脚本块

属性详情

Property<Boolean> allowFileOverwrite

注意:此属性是 孵化中 的,并且可能在 Gradle 的未来版本中更改。

是否允许覆盖构建目录中已存在的文件?此属性可以通过命令行选项 '--overwrite' 设置。默认为 false。

默认值
默认为 'false'

Property<Boolean> comments

注意:此属性是 孵化中 的,并且可能在 Gradle 的未来版本中更改。

是否应在文件中添加解释性注释?

此属性可以通过命令行选项 '--comments' 和 '--no-comments' 设置。

默认值
true

String dsl

要创建的构建脚本的期望 DSL,默认为 'kotlin'。此属性可以通过命令行选项 '--dsl' 设置。

默认值
默认为 'groovy'

如何处理用于 Maven 仓库的不安全 (http) URL。此属性可以通过命令行选项 '--insecure-protocol' 设置。默认值为 'warn'。

默认值
默认为 'warn'

Property<String> javaVersion

注意:此属性是 孵化中 的,并且可能在 Gradle 的未来版本中更改。

生成的 Java 项目要使用的 Java 版本。设置后,Gradle 将使用提供的值作为所有相关生成项目的目标主要 Java 版本。Gradle 将验证该数字以确保它是有效且受支持的主要版本。

默认值
运行 Gradle 的 Java 版本

String packageName

用于生成的源代码的包名。此属性可以通过命令行选项 '--package' 设置。

String projectName

生成的项目名称,默认为项目生成的目录名称。此属性可以通过命令行选项 '--project-name' 设置。

默认值
默认为项目目录名称

Property<Boolean> splitProject

是否应将构建拆分为多个子项目?此属性可以通过命令行选项 '--split-project' 和 '--no-split-project' 设置。

String testFramework

要在生成的项目中使用的测试框架。此属性可以通过命令行选项 '--test-framework' 设置

默认值
empty (默认测试框架取决于请求的 type)

String type

要生成的期望项目类型,例如 'java-application' 或 'kotlin-library'。

此属性可以通过命令行选项 '--type' 设置。

默认为 'basic' - 最小的脚手架,遵循 Gradle 最佳实践。如果在项目根目录中找到 `pom.xml`,则类型默认为 'pom',并且现有项目将转换为 Gradle。

此选项的可能值由 InitBuild.getAvailableBuildTypes() 提供。

默认值
empty (或者如果项目目录中存在 pom.xml 文件,则为 pom)

Property<Boolean> useDefaults

注意:此属性是 孵化中 的,并且可能在 Gradle 的未来版本中更改。

是否应自动接受未显式配置的选项的默认值?

如果为 true,则跳过交互式对话框,并且完成命令无需用户输入。

此属性可以通过命令行选项 '--use-defaults' 和 '--no-use-defaults' 设置。

默认值
false

Property<Boolean> useIncubating

生成的构建是否可以使用新的和不稳定的功能?启用后,生成的构建将使用在次要版本之间可能不稳定的新模式、API 或功能。如果您想尝试 Gradle 的最新功能,请使用此选项。默认情况下,init 将生成一个使用稳定功能和行为的构建。

默认值
默认为 'false'