sdk/com.m8test.script.builder.api/Settings

Settings

interface Settings : PluginAware<Settings> , ExtensionAware, Variable, ScriptContextual

每个构建都需要一个 Settings, 每个 Settings 可以包含多个 Project.

Author

M8Test, [email protected], https://m8test.com

Types

Link copied to clipboard
interface InclusionConfig

在 Settings 包含 Project 时用于配置项目构建的接口.

Functions

Link copied to clipboard
abstract fun afterEvaluate(listener: (Settings) -> Unit)

添加 settings 脚本文件执行后的监听器.

Link copied to clipboard
abstract fun beforeEvaluate(listener: (Settings) -> Unit)

添加 settings 脚本文件执行前的监听器.

Link copied to clipboard
abstract fun configureInclusion(path: String, config: Settings.InclusionConfig.() -> Unit)

配置 path 指定的项目.

Link copied to clipboard
abstract fun getContext(): ScriptContext

获取脚本上下文对象 ScriptContext.

Link copied to clipboard
abstract fun getExtensions(): ExtensionContainer

获取扩展容器.

Link copied to clipboard
abstract fun getGlobalName(): String

获取作为全局变量时的名称.

Link copied to clipboard
abstract fun getPlugins(): PluginContainer<Settings>

获取插件容器.

Link copied to clipboard
abstract fun getProject(path: String): Project

通过项目路径获取 Project 对象.

Link copied to clipboard
abstract fun getProjects(): List<Project>

获取当前 Settings 中所有 Project .

Link copied to clipboard
abstract fun getPublicType(): Type

获取 Variable 注入到脚本时需要显示的类型.

Link copied to clipboard
abstract fun include(path: String, config: Settings.InclusionConfig.() -> Unit)

将 path 指定的项目包含到构建中.

Link copied to clipboard
abstract fun isPrefixRequired(): Boolean

是否需要添加前缀, 每种编程语言添加的前缀不一样, 前缀可以通过 Language.getVariablePrefix 获取.

Link copied to clipboard
abstract fun isSuffixRequired(): Boolean

是否需要添加后缀, 每种编程语言添加的后缀不一样, 后缀可以通过 Language.getVariableSuffix 获取.

Link copied to clipboard
abstract fun onBuildFinished(listener: (BuildResult) -> Unit)

添加项目构建结束监听器.

Link copied to clipboard
abstract fun onProjectsEvaluated(listener: (Settings) -> Unit)

添加所有项目 Project.getBuildFile 构建脚本执行完成后的监听器.

Link copied to clipboard
abstract fun onProjectsLoaded(listener: (Settings) -> Unit)

添加所有项目加载完成监听器, Project.getBuildFile 构建脚本还没有执行.