sdk/com.m8test.script.core.api.config/ScriptProjectConfig

ScriptProjectConfig

interface ScriptProjectConfig : ScriptConfig

定义了脚本工程的完整配置信息。

此接口用于描述一个脚本项目的所有元数据，例如项目名、版本、作者、入口文件等。

Author

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

Functions

Link copied to clipboard
abstract fun addAsset(asset: String): Boolean

添加一个在打包为 APK 时需要包含到 assets 目录中的文件或目录。

Link copied to clipboard
abstract fun compileOnly(webResourceBuilder: WebResource.() -> Unit)

添加仅仅用于编译的依赖, 可以是 jar, dex, apk

Link copied to clipboard
abstract fun getArguments(): List<String>

获取脚本参数列表.

Link copied to clipboard
abstract fun getAssets(): List<String>

获取在打包为 APK 时需要包含到 assets 目录中的文件或目录列表。

Link copied to clipboard
abstract fun getAuthor(): Author

获取项目作者信息。

Link copied to clipboard
abstract fun getCompileOnlyDependencies(): List<WebResource>

获取所有的仅仅用于编译的依赖.

Link copied to clipboard
abstract fun getComponents(): List<WebResource>

获取脚本执行时需要的所有组件名.

Link copied to clipboard
abstract fun getDescription(): String

获取项目描述信息。

Link copied to clipboard
abstract fun getEntry(): String

获取项目的主入口脚本文件路径。

Link copied to clipboard
abstract fun getInitScripts(): List<String>

获取初始化脚本列表。

Link copied to clipboard
abstract fun getLanguage(): WebResource

获取脚本语言, 因为实现语言插件时已经确定语言是什么了, 所以不需要此方法获取语言名称.

Link copied to clipboard
abstract fun getLogo(): String

获取项目 Logo 图标的路径。

Link copied to clipboard
abstract fun getName(): String

脚本运行时的名称.

Link copied to clipboard
abstract fun getPackageName(): String

获取项目包名。

Link copied to clipboard
abstract fun getPath(): ScriptFile

获取原始的脚本工程路径。

Link copied to clipboard
abstract fun getRootPath(): ScriptFile

获取脚本工程解压后的根目录。

Link copied to clipboard
abstract fun getStatus(): String

获取项目状态。

Link copied to clipboard
abstract fun getVersion(): Version

获取项目版本信息。

Link copied to clipboard
abstract fun isStandalone(): Boolean

脚本是否需要运行在新的 ScriptEngine 中, 因为脚本运行时已经确定是否需要运行在新的 ScriptEngine 中了, 所以不需要此方法.

Link copied to clipboard
abstract fun removeAsset(asset: String): Boolean

从 assets 列表中移除一个文件或目录。

Link copied to clipboard
abstract fun requireComponent(webResourceBuilder: WebResource.() -> Unit)

添加一个组件.

Link copied to clipboard
abstract fun setArguments(arguments: List<String>)

设置脚本运行时的参数列表, 此参数列表会以全局变量的形式添加到脚本中.

Link copied to clipboard
abstract fun setAssets(assets: List<String>)

设置在打包为 APK 时需要包含到 assets 目录中的文件或目录列表。

Link copied to clipboard
abstract fun setAuthor(authorBuilder: Author.() -> Unit)

使用 DSL 配置项目作者信息。

Link copied to clipboard
abstract fun setDescription(description: String)

设置项目描述信息。

Link copied to clipboard
abstract fun setEntry(entry: String)

设置项目的主入口脚本文件。

Link copied to clipboard
abstract fun setLanguage(webResourceBuilder: WebResource.() -> Unit)

设置脚本语言.

Link copied to clipboard
abstract fun setLogo(logo: String)

设置项目 Logo 图标的路径。

Link copied to clipboard
abstract fun setName(name: String)

设置项目名称。

Link copied to clipboard
abstract fun setPackageName(packageName: String)

设置项目包名。

Link copied to clipboard
abstract fun setPath(path: ScriptFile)

设置原始的脚本工程文件或目录路径。

Link copied to clipboard
abstract fun setStandalone(value: Boolean)

是否将脚本运行在新的 ScriptEngine 中, 默认将脚本运行在当前 ScriptEngine 中.

Link copied to clipboard
abstract fun setStatus(status: String)

设置项目状态，例如 "release", "snapshot" 等。

Link copied to clipboard
abstract fun setVersion(versionBuilder: Version.() -> Unit)

使用 DSL 配置项目版本信息。