Skip to content
本页内容

模板

创展插件必须符合平台标准,平台服务将利用提供的信息进行每一个扩展的管理。

通过阅读以下模块了解各个文件的作用,若还不知道如何创建模板,请先阅读 创建一个扩展

package.json

每一个扩展插件信息由一个 package.json 文件进行描述,缺失该文件将导致扩展无法被发布。

package.json 文件至少需要满足以下格式:

json
{
  "name": "<name>",
  "version": "<version>",
  "author": "<author>",
  "description": "[description]",
  "icon": "[icon]",
  "imports": {
    "name": "<name>",
    "main": "<main>"
  }
}
{
  "name": "<name>",
  "version": "<version>",
  "author": "<author>",
  "description": "[description]",
  "icon": "[icon]",
  "imports": {
    "name": "<name>",
    "main": "<main>"
  }
}
< > 代表必须,[ ] 代表可选

以下基础参数分别被用于提供插件信息:

  • name: 扩展插件名称(唯一)
  • version: 当前扩展插件版本号(遵循 npm version 规范)
  • author: 扩展插件作者(后续更新也必须由该作者发布)
  • description: 扩展插件简单描述(默认为空,可选)
  • icon: 扩展插件图标(将作为插件市场预览与构建控件栏显示图标,可选)

修改注意

关于 imports 字段是为 co-extension 项目提供打包参数的,若无特别需求无需改动。

  • imports.name: 打包模块名称(浏览器引入 window 下的变量名)
  • imports.main: 扩展插件打包的入口文件

README

扩展插件说明文件,描述了扩展插件功能以及提供基础使用说明和示例。

为确保其他用户能快速了解扩展插件的功能及使用方法,请编写可靠、详细的文档说明,更多查看 README 标准

CHANGELOG

扩展插件更新日志文件,描述了扩展插件每个版本的更新内容,包括了新增的功能 feature 及异常 bug 的修复。CHANGELOG 的编写比较简单,按预设模板格式补充即可。

日志将在扩展迭代后,为用户选择或更新扩展插件版本提供重要参考。

编写提示

其中,.md 后缀都为 Markdown 文件,在编写说明前请先了解其标准用法。

Powerd by Vitepress.