跳转到内容

开发与分发

你可以持续从源码调试插件,完成后再将它打包成 .eidos-plugin 文件。以下流程适用于入门示例和包含多个模块的项目。

@eidos.space/plugin-tools 提供创建项目、检查和打包命令。它需要 Node.js 22.12 或更高版本,可以通过 npx 调用:

终端窗口
npx @eidos.space/plugin-tools --help

在已有项目中,将 @eidos.space/plugin-tools 和 @eidos.space/plugin-sdk 安装为开发依赖,使用项目锁文件记录依赖版本。SDK 为编辑器提供类型提示,代码使用 import type 导入。

如果要制作 CSV 编辑器,可以生成包含解析、编辑和保存逻辑的示例:

终端窗口
npx @eidos.space/plugin-tools create csv-editor --template document-view
cd csv-editor
npm install

运行 npx @eidos.space/plugin-tools templates 可以查看其他示例及用途。 需要 React 等界面库时,在插件项目中安装相应依赖。打包时会将它们一并包含。

项目较小时,也可以使用独立的 .ts 文件,将声明导出为 manifest,再默认导出 mount 或 activate。检查和打包命令同时接受目录与独立源码文件。

在插件目录中执行:

终端窗口
npx @eidos.space/plugin-tools check . --target lite

这会检查声明、入口和 TypeScript,并检查插件使用的功能适用于 Eidos Lite。修正诊断后,通过插件管理器加载开发源码,验证用户实际使用的入口。

为插件选择相应的测试场景。文本编辑器验证保存重开、撤销重做和外部修改冲突。批量操作验证全部目标记录、取消和部分完成。所有界面都检查亮暗主题与关闭后重新打开。

保存源码会自动重新加载视图。修改访问权限声明后,需要重新审核权限。开发期间的自动更新在本次运行中生效。安装打包后的版本可以让用户在重启后继续使用它。

CLI Serve 可以在表格中加载 file 视图,提供表格查询和通知接口。如果插件需要同时在 Serve 中使用,再执行目标检查:

终端窗口
npx @eidos.space/plugin-tools check . --target cli

Lite 的文件系统、独立页面和扩展操作适用于桌面应用。跨环境使用的视图应在调用可选接口前检查其是否存在。

终端窗口
npx @eidos.space/plugin-tools pack .

命令会输出 .eidos-plugin 安装包和 .sha256 校验文件的路径。将安装包交给用户,通过 Eidos Lite 的插件管理器安装,并为需要使用它的 Space 启用。

在 CLI Serve 中检查安装包:

终端窗口
eidos --json plugin doctor /absolute/plugin.eidos-plugin
eidos serve /absolute/test.eidos --plugin /absolute/plugin.eidos-plugin

doctor 的结果中 compatible: true 表示包符合 CLI 的功能要求。随后在浏览器打开 Serve,从表格的视图菜单中添加插件视图。

保持插件 ID、视图 ID 和设置键稳定。增加插件的 version,检查并打包新版本。使用已有设置和文件的数据副本验证升级,确认用户的配置仍然有效。