如何使用我自己编写的工作区插件?

我是一名开发者,我刚刚自己编写了一个工作区插件 koishi-plugin-example,并且已经调试完成了。我要如何在生产环境下使用这个插件呢?是否一定需要发布后才能使用呢?我有点担心我的插件污染插件市场,不太想发布……

5 个赞

如何使用自己编写的插件?

  • 模板项目开发:yarn dev
  • 模板项目生产:yarn build 后 yarn start
  • 给其他实例使用:先将插件发布(build+pub)后再去其他实例下载

不想污染插件市场怎么办?

推荐你使用 scoped 包。scoped 包是带有特定 @xxx/ 前缀的包(比如下图)。

image

scoped 包的坏处是名字变长了,好处是不会污染插件市场(因为 scope 由你本人持有,别人永远不会与你冲突)。

如何将一个普通的插件变成 scoped 的插件

  1. 假设你的插件叫 koishi-plugin-example,位于 external/example 目录下,你的 npm 用户名叫 @alice
  2. 打开 package.json,将 koishi-plugin-example 修改为 @alice/koishi-plugin-example
  3. 打开根目录下的 tsconfig.json,看到一行被注释掉的代码:
// "@scope/koishi-plugin-*": ["external/*/src"],

现在我们把它复制一遍,并把复制后的那行取消注释,改成:

"@alice/koishi-plugin-*": ["external/*/src"], ← 这是复制后的,注意左边有 @alice,右边没有(如果有就删掉)
// "@scope/koishi-plugin-*": ["external/*/src"],
  1. 重新 yarn(这一步是必须的!)
  2. 如果你已经添加到 Koishi 实例中,可以启动 Koishi,并重新添加