Skip to content

开发者模式用于在本地直接运行插件,享受即时热重载与更快的开发循环,无需打包安装。

提示

已通过“安装开发插件”加入的插件,会在命令副标题处显示 “| dev”,便于与正式版本区分。

你将获得:

  • 通过指令一键“安装”本地插件目录(无需打包)
  • 打开插件时 Sofast 自动启动/复用本地 Dev Server 并连接
  • 在 Sofast 内部看到热重载与错误覆盖(Overlay)
  • 列表中该插件命令的副标题会显示“| dev”,便于区分

前置条件

  • 插件根目录包含 package.json 且声明了 commands 字段(与正式插件一致)。
  • 推荐使用 Vite 作为开发脚本,例如:
json
{
  "scripts": {
    "dev": "vite"
  }
}

Sofast 会自动启动你的开发脚本并连接,无需手动配置端口。

安装本地开发插件

  1. 在 Sofast 中搜索并执行“安装开发插件”。
  2. 选择你的插件根目录(包含 package.json 的目录)。
  3. 安装成功后,插件会以“开发插件”的形式注册,命令副标题会显示 “| dev”。

随后打开该命令即可开始调试;Sofast 会自动启动或复用本地开发服务并连接到插件界面。

目录结构与命令声明

  • UI 代码结构可自定义;确保开发脚本可正常服务一个 index.html 即可。
  • package.json 中用 commands 声明你的命令,例如:
json
{
  "commands": [
    { "name": "snake", "title": "贪吃蛇", "mode": "view" }
  ]
}

特殊提示

无界面(No-View)模式暂不支持,后续会提供支持。

键盘与焦点

开发模式下的快捷键

开发模式下,插件需要“自行监听”键盘事件(例如在页面/组件层面绑定快捷键)。 快捷键的生效以插件界面获得焦点为准:当你点击插件界面或按 Tab 切换到插件区域后,界面会以轻微的边框/高亮样式提示焦点,就可以触发你在插件内注册的快捷键了。 后续版本将提供更便捷的快捷键处理方式。

常见问题

  • 打开后白屏/无响应:

    • 确认本地能正常 npm run dev / pnpm dev
    • 检查 package.jsoncommands 是否有效。
  • 浏览器被自动打开:

    • 请在开发脚本配置里关闭自动打开外部浏览器;Sofast 会在内部连接调试页面。
  • 键盘事件不起作用:

    • 点击插件界面或按 Tab 切换焦点,确认焦点提示样式出现后再试。

卸载/移除

再次“安装开发插件”可添加其他目录。若要移除某个开发插件,从安装列表移除该目录(未来会提供更便捷的管理入口)后,该插件就不会被 Sofast 注册展示。