在前端开发中,使用 npm 包是非常常见的事情。kerplunk-github 是一个有趣又实用的 npm 包,它可以将 GitHub 上的 issues 以可视化的形式展现出来,方便开发者进行管理。本文将详细介绍如何使用 kerplunk-github 这个 npm 包。
安装 kerplunk-github
使用 npm 安装 kerplunk-github:
--- ------- ---------------
配置 kerplunk-github
在使用 kerplunk-github 之前,需要先进行一些配置。
配置 GitHub token
首先,在 GitHub 上生成一个 token。生成 token 的方式如下:
- 在 GitHub 上登录账号
- 点击头像,进入 Settings
- 选择 Developer settings -> Personal access tokens
- 点击 Generate new token,填写 token 的名称和权限
- 生成 token,并复制保存
然后,在项目的配置文件(./config.js
)中,添加 GitHub token:
- --------- - -------- ------------------------ - -
记得将 YOUR_GITHUB_TOKEN_HERE
替换为上一步生成的 token。
配置 kerplunk-github
在使用之前,还需要对 kerplunk-github 做一些配置:
----- --- - -------------------------- ------- - -------------- - ---------- - ----- --- - ---- ------------- -- --------- ------ --- ------ --- ----- --- -- ----- -------- ------ --- - --------- ----- ------------- ---- -- ---------- -------- -------------- ----------- --- ------ ---- - --- -- --- ------ ----------------- - ------------ - -------
其中,owner
和 repo
分别是指 GitHub 仓库的拥有者和仓库名。
使用 kerplunk-github
完成配置后,就可以使用 kerplunk-github 了。
获取 issues
要获取仓库中所有的 issues,可以通过下面的方式获取:
----- ------ - ----- -------------------------- ----- ------- -- ------------------ ------ -- ------- ------------------
创建 issue
要创建一个新的 issue,可以使用以下代码:
----- -------- - - ------ ---- ----- ------- ----- ---- ----- ------------ - ----- ---------------------------------- ---------------- ----- ----------
更新 issue
要更新一个已存在的 issue,可以使用以下代码:
----- ----------- - - ----- --------- - ------- ------ ----- ------------------------------------- ---------- ------------------ --------------- ----------
删除 issue
要删除一个 issue,可以使用下面的代码:
----- ----------- - - ----- ------------------------------------- ------------------ --------------- ----------
总结
kerplunk-github 包的使用虽然并不复杂,但是在实际应用中需要我们进行细致的配置和使用。希望本文能对 kerplunk-github 的使用有所帮助。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066efd4c49986ca68d8a79