插件打包指南

如果你准备给 Lime 打包插件，当前最重要的事实源是安装链路本身：插件包通过本地文件或 URL 进入 Lime，安装器会校验压缩格式并读取包内清单。

当前打包入口

当前公开可确认的安装入口只有两类：

• 本地文件安装
• URL 安装

当前安装器接受这些压缩格式：

• .zip
• .tar.gz
• .tgz

建议把“插件根目录”直接打进压缩包，并确保包内能明确定位到 plugin.json。

plugin.json 是当前安装清单

当前安装器会从压缩包中提取并校验 plugin.json。对外发布时，建议始终提供这份文件，并在发布前用当前 Lime 版本做一次真实安装验证。

一个最小示例：

{
  "name": "example_plugin",
  "version": "1.0.0",
  "plugin_type": "script",
  "entry": "config.json",
  "hooks": ["on_request"],
  "ui": {
    "surfaces": ["tools"],
    "entry": "dist/index.js",
    "title": "Example Plugin"
  }
}

当前清单字段

必填基础字段

• name
  • 不能为空
  • 只允许字母、数字、连字符和下划线
  • 长度不能超过 64
• version
  • 需要满足当前 semver 校验
  • 当前接受 x.y、x.y.z、x.y.z-suffix 这类格式
• entry
  • 不能为空
  • 表示插件入口文件路径

常用可选字段

• description
• author
• homepage
• license
• min_lime_version
• config_schema
• hooks

如果声明了 hooks，当前只接受由字母、数字、下划线或冒号组成的名称。

plugin_type

当前清单 schema 识别这些类型：

• script
• binary
• native

其中当前公开主路径应默认按 script 打包；native 仍属于预留能力，不建议作为对外稳定发布前提。若使用 binary，还需要补充二进制下载与平台映射信息。

ui

如果插件需要在 Lime 内暴露界面，可声明 ui 段。当前已存在的字段包括：

• surfaces
• icon
• title
• entry
• description
• default_width
• default_height

surfaces 用于声明 UI 入口位置。当前代码中常见的 surface 标识包括 tools、sidebar、main、settings；发布前仍应在目标版本中实际验证展示结果。

binary

如果插件类型为 binary，当前清单还支持补充：

• binary_name
• github_owner
• github_repo
• platform_binaries
• checksum_file

这类插件通常还需要分别准备各平台产物，并验证可执行文件权限与下载地址是否可用。

发布前最少检查

建议至少完成以下检查：

1. 用当前 Lime 版本做一次真实安装
2. 确认 plugin.json 能通过安装器校验
3. 确认插件能出现在 已安装插件包，并在需要时进入 已加载插件
4. 如果声明了 ui，确认目标 surface 能正常出现
5. 如果声明了 min_lime_version，同步写清最低版本要求

当前文档只保证“安装链路与字段约束”的说明，不再把尚未稳定的插件生态流程写成既成事实。