创建 Sliprail 扩展：从零开始构建你的效率工具

Sliprail 是一款强大的效率工具，其核心功能之一就是支持创建自定义扩展。本指南将详细介绍如何创建你自己的 Sliprail 扩展。

入门准备

在开始之前，需要了解 Sliprail 扩展拥有自己的架构，可以利用 Node.js 接口和专门的 Sliprail SDK。要探索可用的接口，你可以安装 @sliprail/sdk 包，该包为所有扩展 API 提供了 TypeScript 类型定义。

官方模板

Sliprail 团队提供了两个官方 GitHub 仓库模板来帮助你快速上手：

1. 单个扩展模板: sliprail-extension-template - 适合创建只包含一个扩展的仓库。
2. 多扩展包模板: sliprail-extension-bundle-template - 适合在单个仓库中创建多个扩展。

创建公开扩展

如果你想创建任何人都可以安装使用的扩展：

1. 创建 GitHub 仓库: 首先在 GitHub 上创建一个公开仓库。
2. 注册你的扩展: 访问 https://account.fengcen.io/developer 创建新的 Sliprail 扩展，注册时请填写 GitHub 仓库链接。注册完成后，你将获得一个扩展 ID，该 ID 唯一标识你的扩展。
3. 配置 manifest.json: 在你的扩展的 manifest.json 文件中，将 id 字段设置为你注册时获得的扩展 ID。这一步对于扩展的正确识别和功能至关重要。
4. 开发扩展: 参考官方模板来构建你的扩展功能。
5. 发布部署: 将代码推送到 GitHub 仓库，用户即可安装你的扩展。

创建私有扩展

对于仅供你自己使用的扩展：

1. 创建私有扩展: 前往 https://account.fengcen.io/developer 创建新的 Sliprail 扩展，在可见性选项中选择 "私有"，无需填写 GitHub 仓库链接。注册后你将获得一个扩展 ID。
2. 配置 manifest.json: 在你的扩展的 manifest.json 文件中，将 id 字段设置为你注册时获得的扩展 ID。这确保你的扩展能够被系统正确识别。
3. 开发扩展: 参考官方模板来构建你的扩展。
4. 本地加载: 在 Sliprail 扩展管理界面中加载本地扩展，即可立即进行测试和开发。

调试你的扩展

在开发过程中，你可能需要调试扩展来识别和修复问题。Sliprail 提供了内置的调试功能：

调试日志

Sliprail 提供了调试日志接口，允许你在扩展执行期间打印调试信息：

• 使用 @sliprail/sdk 包提供的调试日志 API 来输出调试信息
• 调试消息帮助你跟踪执行流程并识别潜在问题
• 你可以根据开发需求控制调试输出的详细程度

访问调试日志

要查看来自扩展的调试消息：

1. 打开设置: 导航到 Sliprail 设置面板
2. 点击调试日志: 找到并点击 "调试日志" 选项，直接打开调试日志文件
3. 查看输出: 调试日志文件将会打开，显示来自你扩展的所有调试消息

此功能提供了对调试信息的直接访问，让你能够轻松监控扩展行为并在开发过程中排查问题。

重要技术注意事项

依赖管理

Sliprail 不会自动为扩展运行 npm install。如果你的扩展使用了 npm 包，你必须：

• 将所有依赖与代码一起打包
• 推送到 GitHub 仓库时包含所有打包文件
• 确保扩展无需额外安装步骤即可运行

可用 API

你的扩展可以利用：

• Node.js 接口和模块
• @sliprail/sdk 包提供的 API
• TypeScript 类型定义以获得更好的开发体验
• 用于故障排除的调试日志接口

原生模块

Sliprail 扩展不支持原生模块。扩展应使用纯 JavaScript 构建，以确保在不同环境下的兼容性和稳定性。这包括避免使用 node-gyp 或类似工具编译的原生插件。

扩展发现

目前，Sliprail 官网不会展示第三方扩展。不过，未来可能会在官方网站上展示流行的扩展。专注于创建高质量、实用的扩展，为用户提供真正的价值。

后续步骤

现在你已经了解了创建 Sliprail 扩展的基础知识，你可以：

• 克隆其中一个官方模板
• 探索 @sliprail/sdk 接口
• 开始构建你的第一个扩展
• 利用调试日志功能实现顺利开发
• 加入社区分享你的创作

祝你编码愉快！