npm 包 @loklaan/npm-hook-slack 使用教程

阅读时长 3 分钟读完

前言

在开发过程中,为了协调团队成员之间的工作,我们通常都会使用 Slack 或其他类似的团队沟通工具。本文介绍了一款能够将 npm 发布过程中的信息发送到 Slack 的 npm 包 @loklaan/npm-hook-slack,并提供了详细的使用教程。

安装

在进行安装前,我们需要先在 Slack 中为我们的 npm 项目创建一个 App,然后获取该 App 的 Webhook URL。

配置

首先,我们需要在项目根目录下新建一个 .npmrc 文件,并在其中添加以下内容:

其中,@YOUR_NPM_USERNAME 是您的 NPM 用户名,hook-servers 中的 https://npm-hook-slack.your-server.com/ 是 @loklaan/npm-hook-slack 的服务地址。

接下来,我们需要进行一些配置,在项目根目录下新建一个 .npmhookrc 文件,并在其中添加以下内容:

-- -------------------- ---- -------
-
  ---------- -----
  ---------- --------------------
  ----------- ------------------
  ------------- -----------
  ---------- --------------------
  --------- -
    -------
    ----------
    --------------
    -----------
    ----------
    -----------------
    -----------
    ---------------
    -------------
  -
-

其中,webhook 是在 Slack 中创建的 Incoming Webhooks 的 URL,username 是项目的名称,icon_emoji 是发送消息在 Slack 上显示的图标,channel 是消息将要发送到的 Slack 频道,fields 是要显示的 npm 包信息的字段,更多信息请参考 @loklaan/npm-hook-slack 的文档。

最后,我们需要在 package.json 文件中添加钩子,即在文件中添加一个 postpublish 脚本:

-- -------------------- ---- -------
-
  ------- -------------
  ---------- --------
  ---------- -
    -------------- --------------- ---------------- -- -----
  --
  --------------- -
    ---
  -
-

这样,每次发布 NPM 包时都会发送一条消息到我们在 Slack 中指定的频道。

使用

在以上步骤完成后,我们就可以使用 npm publish 命令将包发布到 NPM,同时,在 Slack 中也会收到我们发布包的信息。以下是一个示例代码:

总结

@loklaan/npm-hook-slack 是一个很好用的工具,它能够方便地将 NPM 发布信息发送到 Slack,这样我们就能够很方便地进行团队协作。本文提供了详细的使用方法,希望能够帮助大家更好地使用该工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055d3e81e8991b448db08e

纠错
反馈