文档

运行与调试

启用开发者模式后,可以直接从本地目录加载扩展,并在开发过程中重新加载。

加载已解压的扩展

  1. 打开 Sliprail 设置 > 扩展
  2. 启用开发者模式并确认安全提示
  3. 打开开发者文件菜单
  4. 选择加载已解压的扩展
  5. 选择包含 manifest.json 的目录

Sliprail 会验证注册 ID、清单字段、入口文件和默认导出。加载错误会显示在界面中,并写入调试日志。

修改代码后,需要时先重新构建入口文件,再点击开发者模式区域中的重新加载扩展

调试日志

可以在快捷指令或扩展生命周期处理函数中使用 context.debugLog

handle: (context) => {
  context.debugLog('Shortcut started', {
    parameter: context.parameter,
  })
}

打开日志的方法:

  1. 打开 Sliprail 设置
  2. 点击设置窗口底部附近的调试日志
  3. Sliprail 会使用默认文本编辑器打开当前日志文件

日志同时包含 Sliprail 和扩展消息,因此建议在每条自定义日志中写清扩展名或指令名。

常见加载问题

  • 扩展 ID 尚未注册
  • 清单缺少必填字段
  • main 文件不存在
  • 入口模块没有默认导出扩展对象
  • 第三方依赖没有打包
  • 原生 Node.js 依赖与 Sliprail 运行时不兼容