Sliprail 是一款强大的效率工具,其核心功能之一就是支持创建自定义扩展。本指南将详细介绍如何创建你自己的 Sliprail 扩展。
在开始之前,需要了解 Sliprail 扩展拥有自己的架构,可以利用 Node.js 接口和专门的 Sliprail SDK。要探索可用的接口,你可以安装 @sliprail/sdk 包,该包为所有扩展 API 提供了 TypeScript 类型定义。
Sliprail 团队提供了一个官方 GitHub 仓库模板来帮助你快速上手:sliprail-extension-template。
如果你想创建任何人都可以安装使用的扩展:
manifest.json 文件中,将 id 字段设置为你注册时获得的扩展 ID。这一步对于扩展的正确识别和功能至关重要。对于仅供你自己使用的扩展:
manifest.json 文件中,将 id 字段设置为你注册时获得的扩展 ID。这确保你的扩展能够被系统正确识别。在开发过程中,你可能需要调试扩展来识别和修复问题。Sliprail 提供了内置的调试功能:
Sliprail 提供了调试日志接口,允许你在扩展执行期间打印调试信息:
@sliprail/sdk 包提供的调试日志 API 来输出调试信息要查看来自扩展的调试消息:
此功能提供了对调试信息的直接访问,让你能够轻松监控扩展行为并在开发过程中排查问题。
Sliprail 不会自动为扩展运行 npm install。如果你的扩展使用了 npm 包,你必须:
你的扩展可以利用:
@sliprail/sdk 包提供的 APISliprail 扩展不支持原生模块。扩展应使用纯 JavaScript 构建,以确保在不同环境下的兼容性和稳定性。这包括避免使用 node-gyp 或类似工具编译的原生插件。
Sliprail 商店支持搜索第三方扩展。用户可以直接通过商店界面发现并安装你的扩展。我们鼓励你专注于创建高质量、实用的扩展,为用户提供真正的价值。
现在你已经了解了创建 Sliprail 扩展的基础知识,你可以:
@sliprail/sdk 接口祝你编码愉快!