当您的扩展开发和测试完成后,就可以将其发布给其他用户了。发布过程主要针对公开扩展,并通过 GitHub 进行管理。
Sliprail 扩展推荐使用纯 JavaScript 或 ES 模块(.js 或 .mjs 文件)开发。使用纯 JavaScript 的优势在于:
如果您的扩展使用了 TypeScript 或其他需要编译的语言,可以根据自己的需求配置相应的构建流程。
重要提醒:扩展代码运行在 Sliprail 的主线程中,请确保您的扩展代码不会长时间阻塞主线程。
async/await 或 Promise 处理 I/O 操作setImmediate/setTimeout 分片处理阻塞主线程可能导致 Sliprail 界面卡顿、响应缓慢,甚至影响用户体验。
如果您的扩展仅使用 Node.js 内置模块和 @sliprail/sdk 提供的 API,那么无需任何额外的构建或打包步骤。
如果您的扩展依赖第三方 npm 包,需要注意:
node_modules 目录发布新版本时,请确保推送到 GitHub 的代码包含所有打包后的文件。
发布公开扩展的过程非常简单:
准备代码:确保所有必需的文件(manifest.json、扩展代码、图标等)都已准备好
推送到 GitHub:将您的代码推送到注册扩展时指定的 GitHub 仓库
自动部署:Sliprail 会定期检查已注册的扩展仓库。当检测到更新时,会自动拉取最新版本
用户随后就可以在 Sliprail 扩展管理中更新到您的扩展的最新版本。
私有扩展无需发布到任何平台。它们通过"加载本地扩展"功能直接在您的机器上运行。您只需确保代码保存在本地即可。