随着开源社区的持续发展，越来越多的开发者和组织加入到 GitHub 开源社区中。在这个高度开放和协作的环境中，如何快速构建和扩展自己的行业和项目，已经成为一个关键的问题。Create-probot-plugin 就是一个解决方案，它是一个基于 Node.js 的包，用于快速创建和扩展 GitHub 应用中的插件，可以轻松地为您的开源项目增加一些自定义功能。
安装和使用
Create-probot-plugin 是一个开源的 Node.js 包，可以通过 npm 进行安装。安装命令如下：
npm install -g create-probot-plugin
安装完成后，在终端中输入以下命令即可创建一个基本的 Probot 插件：
create-probot-plugin my-probot-plugin
这个命令将创建一个名为 my-probot-plugin 的文件夹，并在其中生成一些基本的代码和结构，以便您可以快速开始编写自己的插件。在这个基本的插件中，您可以找到以下文件和文件夹：
- .github/workflows: 在 GitHub 上运行的工作流文件。
- scripts/create.ts: 用于从模板生成插件的脚本。
- src/index.ts: 插件入口文件，定义您的插件的行为。
- test/index.test.ts: 包含用于测试插件的测试代码。
在这个示例插件中，Probot 将监听 GitHub 上 issues 事件，并在有新的 issue 创建时，在控制台打印一条消息。
创建一个新的插件
要创建一个新的 Probot 插件，请执行以下操作：
- 使用上面的安装命令安装 create-probot-plugin 包。
- 在终端中，使用以下命令创建一个新的插件：
create-probot-plugin my-probot-plugin
- 进入新创建的插件文件夹：
cd my-probot-plugin
- 在终端中，安装所需的依赖项：
npm install
- 在编辑器中，打开
src/index.ts文件，并根据需要编写您的插件行为。例如：
import { Application, Context } from 'probot'
export = (app: Application) => {
app.on('issues.opened', async (context: Context) => {
const issueComment = context.issue({ body: 'Thanks for opening this issue!' })
await context.github.issues.createComment(issueComment)
})
}- 保存您的更改并运行以下命令启动您的插件：
npm start
- 在 GitHub 上，为您的应用创建一个 OAuth 应用，并将应用程序重定向 URI 设置为
http://localhost:3000/login/callback。 - 使用以下命令在终端中配置您的应用程序密钥和密钥：
export APP_ID=12345 export PRIVATE_KEY=$(cat /path/to/private-key.pem)
- 测试您的插件，完成后将其部署到生产环境中。
结论
Create-probot-plugin 是一个非常实用的 npm 包，它为开发者提供了快速开发和部署插件的方法，以扩展他们的 GitHub 应用程序的功能。希望本文能够帮助您快速入门。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005600b81e8991b448dddb4