跳到主要内容
版本号:Next

插件生成器

安装 Yeoman 生成器

Verdaccio 是一个可插拔应用程序,旨在帮助开发人员生成新插件,我们有一个基于 Yeoman 的自定义生成器 用于生成各种插件。

要安装生成器,您必须先安装 yeoman 命令 yo

npm install -g yo@4

然后,在终端运行以下命令安装自定义生成器。

npm i -g generator-verdaccio-plugin

:::警告

generator-verdaccio-plugin 与 yeoman 版本 5 尚不兼容。 您必须使用版本 4 才能正常运行。

:::

使用生成器

使用 yeoman 非常简单,您可以在此处阅读有关它的更多信息。

成功安装后,在终端中运行 yo verdaccio-plugin 并按照以下步骤操作。

➜ yo verdaccio-plugin

Just found a `.yo-rc.json` in a parent directory.
Setting the project root at: /Users/user/verdaccio_yo_generator

_-----_ ╭──────────────────────────╮
| | │ Welcome to │
|--(o)--| │ generator-verdaccio-plug │
`---------´ │ in plugin generator! │
( _´U`_ ) ╰──────────────────────────╯
/___A___\ /
| ~ |
__'.___.'__
´ ` |° ´ Y `

? What is the name of your plugin? (customname)

最佳实践

  • 我们建议使用 Typescript 来开发新插件,我们提供了对类型的广泛支持,可以帮助您进行开发。
? What is the name of your plugin? my-plugin
? Select Language (Use arrow keys)
❯ typescript
javascript
  • 在描述你的插件时,要简短而明确,记住一个好的描述会增加你的插件被使用的机会。
? 请描述您的插件(一个很棒的 verdaccio 插件)
  • 不要犹豫,添加有意义的关键词,例如 verdaccioplugin 或您的插件类型。 好的关键字将帮助我们找到您,并在未来改进我们收集的有关所有插件的信息。
? 输入您的关键字(逗号分隔) verdaccio,plugin,storage,minio,verdaccio-plugin
  • 请持续更新您的生成器****,不要错过任何错误修复和性能改进。

贡献

帮助我们改进生成器,您可以在以下资源仓库中做出贡献。

https://github.com/verdaccio/generator-verdaccio-plugin