npm 包 generator-kanali-plugin 使用教程

阅读时长 3 分钟读完
  • 作者:xxx
  • 时间:2021.11.11

前言

generator-kanali-plugin 是一个 NPM 包,用于生成 kanali 插件模板,并可以根据模板进行自定义开发。本文将带领大家使用 generator-kanali-plugin,了解如何快速生成 kanali 插件模板,并进行自定义开发。

使用步骤

安装 generator-kanali-plugin

首先需要全局安装 generator-kanali-plugin:

安装完成后,在终端输入 yo kanali-plugin 即可生成一个 kanali 插件模板。

生成 kanali 插件模板

在终端输入以下命令:

按照提示依次输入以下信息:

  • What's your plugin name?:输入你的插件名称
  • What's your plugin description?:输入你的插件描述
  • Your Github username::输入你的 Github 用户名

输入完成后,会自动生成一个 kanali 插件模板。

自定义开发

框架目录结构

-- -------------------- ---- -------
--- ---------
--- ------------
--- ---                         - ------
-   --- --------
-   --- ---
--- ----                        - ------
-   --- -----------            - ------
-   --- ---
--- ---------                   - ------
-   --- ----------
-   --- ---
--- ----                        - ------
-   --- -------
-   --- ---
--- ----------

lib 目录下实现你的插件逻辑,data 目录下可以添加你的插件参数配置文件,templates 目录下可以添加你的插件模板文件,test 目录下可以添加你的插件测试用例。

构建

构建后的插件包位于 dist 目录下,可以将其上传到 Github 并在机器上部署。

示例代码

插件默认入口文件 ./lib/index.js

-- -------------------- ---- -------
---- --------

----- ------- - --------------------
----- ------- - -----------------------------------------

-------------- - -
  ----- ---- ---------- ----
  -------- --------

  ------------------ -
    ------ -------- - --- ----------- ------------------ -
      ----- -----
    --
  -
--

配置文件 ./data/params.yaml

总结

本文详细介绍了如何使用 generator-kanali-plugin,并使用示例代码进行了说明。希望能对大家有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055ead81e8991b448dc27d

纠错
反馈