在现代web应用程序中，使用GitHub API来管理用户评论和问题列表是一个普遍的技术。而Octokit-plugin-mentions作为一个NPM包来扩展Octokit，并添加了GitHub评论中的@mentions功能，也是一个非常有用的工具。在这篇文章中，我们将会理解这个NPM包，并学习如何在你的应用程序中使用它。
1. 准备工作
在开始学习使用Octokit-plugin-mentions之前，我们需要有调用GitHub API的访问令牌和相应的github账户信息。在Octokit的官网中注册一个新的token，并保存到本地环境变量中。同时，我们还需要使用npm包管理器安装Octokit本身和Octokit-plugin-mentions这个插件：
npm install @octokit/rest @octokit/plugin-mentions
接着，我们可以在我们的项目中导入Octokit的库，并注册Octokit-plugin-mentions插件。下面是一个示例代码：
-- -------------------- ---- -------
----- - ------- - - ------------------------
----- - -------- - - -----------------------------------
----- ------- - --- ---------
----- -------------------------
---- -
------ ------------
----- ------------
----- -------------
------ -------------
-
--
------------------------我们可以通过传递一个与authentication相关的对象来初始化Octokit类。在本例中，我们使用process.env.GITHUB_TOKEN，它是我们本地环境变量中的Github访问密钥。通过设置log对象，我们可以方便地在开发过程中进行日志记录或调试。最后，使用octokit.plugin来注册Octokit-plugin-mentions插件。
2. Octokit-plugin-mentions的使用
在Octokit-plugin-mentions中，有两种类型的评论：问题评论和回答评论。我们可以使用Octokit API的issues.createComment方法来创建一个新的问题评论，或者使用pulls.createReviewComment方法来创建一个新的回答评论
-- -------------------- ---- ------- -- ---------- ----- ------ - ----- ------------------------------ ------ ---------- ----- ---------- ------- ---- ----- ------ ------ --- --- ----- -- -- ---------- ----- ------ - ----- ----------------------------------- ------ ---------- ----- ---------- ------------ ---- ----- ------ ----- ----- --
@mentions 代码片段是使用Octokit API的markdown.render方法生成的。你可能想知道为什么我们需要这个，而不是简单地使用字符串字面值。这是因为如果你希望在给出或回答的评论中添加链接或提及其他作者，则需要使用markdown格式。在这个例子中，我们向 John 发生一个问候，他在此应被提及。我们将markdown类容转换成HTML文本，并在GitHub评论中使用它：
const mdBody = octokit.markdown.render({ text: result.data.body })
await octokit.issues.createComment({
owner: 'octokit',
repo: 'rest.js',
number: 124,
body: `@John, see my response below:\n${mdBody}`
})这一堆代码来构建一个新问题评论。当我们向指定的问题发表评论时，请使用issues.addComment方法，并在评论中添加@mentions：
const result = await octokit.issues.createComment({
owner: 'octokit',
repo: 'rest.js',
number: 123,
body: '@John Hello, how are you. Thank you for your help, @anu was able to help me with this.'
})3. 总结
到这里，我们已经学习了如何使用NPM包Octokit-plugin-mentions来增强使用GitHub API的应用程序。我们现在也知道如何使用@mention功能在GitHub评论中提及其他作者。我们可以使用markdown.render方法将markdown格式的文本转换为HTML，并将其添加到问题评论或回答评论中。
在有了上述基础之后，我们可以为我们的应用程序添加更多的功能，并在开发过程中不断优化和优化它们。希望这篇文章对你有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f9d3d1de16d83a6702d