介绍
npm 包 gh-issues-utils 是一个适用于 Github Issues 的辅助工具，它可以帮助开发者更加方便地管理自己或团队的 Issues，并提供了一些常用的功能，例如：添加/删除标签、打开/关闭 Issues、查询所有 Issues 等等。本文将详细介绍如何使用 gh-issues-utils。
如何使用
准备工作
在开始使用 gh-issues-utils 之前，我们需要在 Github 上创建一个 API Token。
登录 Github，点击头像右上角 Settings -> Developer settings -> Personal access tokens
点击 Generate new token 按钮，填写 Token 描述，并勾选 repo 权限，然后点击 Generate token 生成 Token。
安装 gh-issues-utils
使用 npm 安装 gh-issues-utils：
npm i gh-issues-utils
初始化配置
在使用 gh-issues-utils 之前，我们需要先初始化一个配置文件。
-- -------------------- ---- ------- ----- ------------- - -------------------------- ----- ------------ - - ------ ------------------------ ------ ----------------------- ----- ----------------- - ----- ----------- - --- ---------------------------
使用方法
查询所有 Issues
const allIssues = await issuesUtils.getAllIssues() console.log(allIssues)
查询指定状态的 Issues
const issuesByState = await issuesUtils.getIssuesByState('open')
console.log(issuesByState)根据标签查询 Issues
const issuesByLabel = await issuesUtils.getIssuesByLabel('bug')
console.log(issuesByLabel)新建 Issue
const newIssue = {
title: 'new issue',
body: 'this is a brand new issue',
labels: ['bug'],
}
await issuesUtils.createIssue(newIssue)关闭 Issue
await issuesUtils.closeIssue(issueNumber)
打开 Issue
await issuesUtils.reopenIssue(issueNumber)
添加标签
await issuesUtils.addLabels(issueNumber, ['bug'])
删除标签
await issuesUtils.removeLabel(issueNumber, 'bug')
指导意义
gh-issues-utils 是一个便捷工具，它可以节省我们管理 Issues 的时间，提高我们的工作效率。但是，在应用 gh-issues-utils 的过程中，我们也需要遵守 Github 的规范，例如：不要滥用 Issues、Issues 应该是具有可追溯性和明确目标的、不要在 Issues 中讨论无关问题等。使用工具是为了方便工作、提高效率，但是我们仍然需要严格遵守规范，以保证项目开发的顺利进行。
总结
在本文中，我们详细地介绍了 npm 包 gh-issues-utils 的使用方法，包括如何安装、初始化配置文件以及如何调用各个 API 方法。在应用本工具的过程中，我们需要遵守 Github 的规范，保证 Issues 的质量。希望本文对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005527781e8991b448cff59