npm 包 can-i-chime-in 使用教程

阅读时长 3 分钟读完

在前端开发中,经常需要用到多个人协作开发,这个时候就需要进行沟通和协调。有时候就会遇到一些人没有及时回复,导致进度缓慢,影响开发效率。可以通过使用 npm 包 can-i-chime-in 来解决这个问题。

什么是 can-i-chime-in

can-i-chime-in 是一个 npm 包,它可以检测项目的进度,并在某些情况下向某些人发出提示信息,以便及时响应。

can-i-chime-in 支持以下几种情况:

  • 检测某个文件是否修改;
  • 检测某个文件是否新增;
  • 检测某个文件是否删除;
  • 检测某个文件是否重命名;
  • 检测某个文件的内容是否发生变化;
  • 检测某个目录下的文件是否发生变化。

可以设置多个检测规则,可以设置多个通知人。

can-i-chime-in 会使用 Slack API 发送消息,因此需要先安装 Slack API。

如何使用 can-i-chime-in

安装 can-i-chime-in

通过 npm 安装:

安装 Slack API:

配置 can-i-chime-in

在项目的根目录下新建 can-i-chime-in.config.js 文件,然后添加如下内容:

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

这里配置了三个规则:

  • 检测 src/components 目录下是否新增了文件,新增文件时发送 '新增了组件' 消息,并通知 zhangsan 和 lisi;
  • 检测 src/components 目录下是否修改了文件,修改文件时发送 '修改了组件' 消息,并通知 zhangsan 和 lisi;
  • 检测 src/components 目录下是否删除了文件,删除文件时发送 '删除了组件' 消息,并通知 zhangsan 和 lisi。

其中,slack.token 是 Slack API 的 token,slack.channel 是消息发送的频道。

启动 can-i-chime-in

在 package.json 中添加如下脚本:

然后执行以下命令启动 can-i-chime-in:

当检测到符合规则的事件发生时,can-i-chime-in 会发送消息,并@通知人。

示例代码

可以在 GitHub 上找到 can-i-chime-in 的示例代码

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

纠错
反馈