在前端开发中，我们不仅需要关注项目代码的实现，还需要关注与项目关联的问题跟踪和解决。在Github中，问题跟踪的功能就是通过Issues实现的。在这个过程中，我们需要不断地查看Issues状态、回复评论、修改Issue状态等等。这一系列操作的重复性程度较高，如果能够自动化处理，则会大大提高工作的效率。
npm包ghissues就是针对Github Issues管理的自动化工具，它提供了一系列现成的API工具，可以帮助我们实现自定义的Github Issues处理流程。接下来，我将向大家介绍npm包ghissues的基本使用方法。
安装
在使用之前，我们需要在项目中引入ghissues包。安装方式如下：
npm install ghissues --save-dev
基本使用
在使用ghissues之前，我们需要通过Github获取一个access_token。获取方式为在Github设置中申请Personal access token，并将其添加到环境变量中。
-- -------------------- ---- -------
----- -------- - -------------------
----- ------- - --------------------
----- -- - ----------
------ --------
----- -----------------------
----- ------------------------
--
-- ----------
---------------
------------ -- -
-------------------
--
---------- -- -
------------------
--
-- -----------
----- -------- - -
------ ----- -- - --- -------
----- ----- -- --- ----------- -- --- --- -------
-
------------------------
----------- -- -
------------------
--
---------- -- -
------------------
--详细使用方法
1. 获取所有Issues
我们可以使用 listIssues() 方法来获取当前项目的所有 Issues。
gh.listIssues()
.then(issues => {
console.log(issues)
})
.catch(err => {
console.error(err)
})listIssues() 方法的返回值为一个promise，返回的值是一个包含所有 Issues 信息的数组。每个 issue 信息都包含以下字段：
- title：issue标题
- body：issue描述
- assignees：上该issue的用户
- labels：标签信息
- state：issue状态
- comments：评论
- created_at：创建时间
- updated_at：最近更新时间
2. 创建 Issue
我们可以使用 createIssue(data) 方法来创建新的 Issue。
-- -------------------- ---- -------
----- -------- - -
------ ----- -- - --- -------
----- ----- -- --- ----------- -- --- --- --------
---------- ------------- -------------
------- ---------- ---------
-
------------------------
----------- -- -
------------------
--
---------- -- -
------------------
--createIssue(data) 方法的参数为一个包含要创建 Issue 信息的对象。其中，title 和 body 属性是必选参数，assignees 和 labels 是可选参数。createIssue()方法的返回结果为创建的 Issue 信息。
3. 更新 Issue
我们可以使用 updateIssue(data, number) 方法来更新 Issue。其中，data参数为要更新 Issue 的信息，number参数为要更新的 Issue 的编号。
-- -------------------- ---- -------
----- ---------- - -
------ ----- -- -- ------- -------
----- ----- -- --- ------- ----------- -- --- --------
------ -------
------- ---------- ---------
-
-------------------------- ----
----------- -- -
------------------
--
---------- -- -
------------------
--updateIssue(data, number) 方法的data参数为要更新 Issue 信息的对象。其中，title 和 body 属性是必选的，assignees 和 labels 是可选参数。
4. 关闭 Issue
我们可以使用 closeIssue(number) 方法来关闭 Issue。其中，number参数为要关闭的 Issue 的编号。
gh.closeIssue('1')
.then(issue => {
console.log(issue)
})
.catch(err => {
console.error(err)
})5. 删除 Issue
我们可以使用 deleteIssue(number) 方法来删除 Issue。其中，number参数为要删除 Issue 的编号。
gh.deleteIssue('1')
.then(issue => {
console.log(issue)
})
.catch(err => {
console.error(err)
})总结
npm包ghissues提供了一系列现成的API工具，可以大大提升我们的前端开发效率。在使用的过程中，我们需要认真阅读操作文档，并按照文档要求正确使用ghissues工具。
不过，使用npm包ghissues不仅仅会仅仅学会如何使用一个工具，而是了解到如何将同一个问题的操作变得自动化，实际上这是工程师们需要精益求精的精神，因为更高的效率取决于更细致的技术实现。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/57820