描述 Nep 包的基本信息,表位于 package.toml
。
通用信息表。
包名,推荐仅使用英文、中文和空格。
不得包含下划线(_
),请使用空格或横杠线(-
)代替。
String
name = "VSCode"
包的简短描述,尽量从官方渠道摘取简介。
String
description = "微软开发的跨平台开源编辑器"
包模板,当前版本中仅能为 "Software"。
String 枚举
Software
template = "Software"
包版本号,使用 ExSemVer 规范。
ExSemVer 规范在 SemVer 的基础上在PATCH
和PRE
之间增加了一位RESERVED
位,用于标记不同的打包版本,或是用来兼容在 Windows 平台常见的 4 位版本号;若上游版本号符合 SemVer 规范则将RESERVED
位置0
即可。
String
version = "1.0.0.0"
包作者,第一作者应为打包者,后面通常跟发行商、制作方。
支持使用 <>
包裹作者邮箱。
Vec<String>
authors = ["Cno <dsyourshy@qq.com>", "Microsoft"]
可选 开源许可证的 SPDX 标识符或 EULA 链接。
String
license = "MIT"
可选 包图标 URL。
String
icon = "https://code.visualstudio.com/favicon.ico"
可选 是否使用严格模式,缺省为true
。
启用严格模式时,如果某一步骤出错则工作流会立即停止执行并报告错误;否则工作流只会对错误进行警告然后继续运行后续步骤。
注意如果希望使用内置变量ExitCode
,请将strict
设置为false
。
bool
strict = false
软件包独占表。
软件发行域,通常填写上游组织名称。
若软件包的直接上游为发行商/组织则使用发行商的名称,例如 PortableApps
;若软件包的直接上游为官方网站则使用开发商/组织的名称,例如 Microsoft
。
若上游组织为正式的、拥有独立域名的组织,则将发行域开头大写,例如对于 GitHub 发布的 GitHub Desktop
软件使用 GitHub
作为发行域;若上游组织表示对一个群体的泛指,则将发行域开头小写,例如对于将发行托管在 GitHub Releases 上的开源项目使用 github
作为发行域。
String
scope = "Microsoft"
软件上游 URL,可以是官方网站的下载页或发行商/组织提供的发行详情页。
String
upstream = "https://code.visualstudio.com/"
软件分类,推荐为 Edgeless 插件包分类中的一种。
String
category = "集成开发"
可选 软件的编译目标架构,缺省表示安装时不检查架构兼容性。
String 枚举
X64
X86
ARM64
arch = "X64
软件语言,Multi
表示多语言。
String 枚举
Multi
zh-CN
en-US
language = "Multi"
可选 主程序路径,可以是相对路径或绝对路径。
如果使用绝对路径,必须以内置变量开头。
String
可选 标签,用于联想推荐相似包或聚合多个相近的包。
不需要重复输入包名、分类或是作者名中的信息。
Vec<String>
tags = ["electron", "typescript"]
可选 别名,用于关联查找。
不需要重复输入标签中的信息。
Vec<String>
alias = ["code", "vsc", "Visual Studio Code"]
可选 注册表入口,如果该软件是调用安装器安装的且在注册表中有 Uninstall 入口,提供该字段可以免去编写卸载工作流并帮助 ept 获取更多信息。
支持如下 3 个位置的入口:
String