npm 包 @next/gh-issues 使用教程

如果你是一个前端工程师，你一定会经常遇到和 GitHub Issues 相关的工作。但是，如果你想把一个简单的 GitHub Issue 迁移到你的网站上，这会变得比较困难。不过，有了 @next/gh-issues 这个 npm 包，这个流程将变得非常简单。

安装

要使用 @next/gh-issues，你需要首先在你的项目中安装它。你可以通过 npm 进行安装：

npm install @next/gh-issues

用法

一旦你安装了 @next/gh-issues，你可以使用它轻松地将 GitHub Issues 迁移到你的网站上。下面我们将演示如何使用这个包。

1. 授权

首先，你需要授权访问你的 GitHub 仓库。你可以通过设置环境变量来进行授权：

export GITHUB_TOKEN=your_github_api_token

或者，你可以在实例化时传入 accessToken 参数：

import GhIssues from '@next/gh-issues';

const ghIssues = new GhIssues({
  accessToken: 'your_github_api_token'
});

你可以前往 GitHub Personal Access Tokens 页面 创建一个新的 personal access token。

2. 获取 issues 列表

通过调用 getIssues 方法来获取你的 GitHub Issues 列表：

const issues = await ghIssues.getIssues({
  owner: 'your_github_username',
  repo: 'your_github_repository',
  state: 'open'
});
console.log(issues);

上述代码将返回在给定仓库中所有未关闭的问题。

3. 获取单个 issue

通过调用 getIssue 方法传入待获取的 issue 号来获取单个问题：

const issue = await ghIssues.getIssue({
  owner: 'your_github_username',
  repo: 'your_github_repository',
  issueNumber: 1
});
console.log(issue);

上述代码将返回在给定仓库中编号为 1 的 Issue。

4. 创建 issue

通过调用 createIssue 方法来创建新的 GitHub Issue：

const result = await ghIssues.createIssue({
  owner: 'your_github_username',
  repo: 'your_github_repository',
  title: 'Issue Title',
  body: 'Issue Detail'
});
console.log(result);

上述代码将在指定的仓库中创建一个新的 issue。

5. 关闭问题

通过调用 closeIssue 方法来关闭一个问题：

const result = await ghIssues.closeIssue({
  owner: 'your_github_username',
  repo: 'your_github_repository',
  issueNumber: 1
});
console.log(result);

上述代码将关闭指定仓库中的编号为 1 的 issue。

总结

通过使用 @next/gh-issues，你不再需要手动迁移 GitHub Issues 到你的网站上了。这让前端工程师的工作变得更加容易和高效。希望本文能够帮助你使用 @next/gh-issues，如果你有任何问题或疑问，欢迎协助交流。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e244867