插件模板工程

2026-11-15

blc-plugin-template 是官方的插件起点工程:后台命令、浏览器页面、状态保存、构建配置、测试与发布工作流都配好,clone 下来改几个名字就能开始写自己的插件,不用从空目录猜清单格式。

模板内容一览:

  • 示例后台命令与浏览器视图(官方 SDK v1,纯 TypeScript;页面用原生 DOM 写法,可换成 React/Vue);
  • 页面状态保存与保存契约示例,node:test 测试用 mock 的 PluginContext,不需要启动宿主;
  • npm run package 一键产出 dist-package/<名称>-<版本>.tgz 与 SHA-256 校验文件;
  • GitHub Actions 发布工作流:推送 v* 标签自动构建、测试、打包并创建 Release,包名、版本与产物文件名都从 package.json 读取,改完名字直接复用。

用模板开始

推荐 GitHub 模板方式:打开仓库点「Use this template」生成自己的新仓库,或命令行执行 gh repo create my-plugin --template biglazycat-writer/blc-plugin-template --private --clone。也可以 clone 后把 remote 换成自己的仓库,或下载 ZIP 解压;在宿主 MCP 服务里调用 plugin_project_create 同样能生成标准工程(接入方式见「MCP 与外部 AI」)。

必改清单

模板 README 提供完整清单,核心是这几处,改完运行 npm run build && npm test 确认通过:

  1. package.json 的 name、description 与 version;
  2. biglazycat.displayName / description——插件在宿主里显示的名称与说明;
  3. 命令 id 前缀(模板默认 template.*):清单 contributes.commands[].id 与 src/main.ts 的 ctx.commands.register(...) 必须逐字一致,否则宿主启用时会拒绝;
  4. 视图与菜单的 id、标题,以及 README 里的仓库链接。

清单字段受 SDK 的 manifest.schema.json 约束,逐字段说明见「SDK 清单 Schema」;运行环境准备与完整开发流程见「插件开发流程」。官方的「排版导出」与「微信公众号发布」两个插件是同一套结构的更完整参考实现。