在前端开发中，文件监控是一个非常重要的环节，特别是在一些项目中，需要对某些文件进行实时监听，以便在文件变化时进行重新编译或处理。为了满足这一需求，我们可以使用 fsmonitor 这个 npm 包来实现文件的监控操作。本文将会详细介绍 fsmonitor 的使用方法，并为大家提供一些实用的示例代码。
安装
在使用 fsmonitor 前，我们首先需要安装它。在终端（Terminal）中输入以下命令即可：
--- ------- ---------- ---------
需要注意的是，fsmonitor 可以通过 CLI 进行使用，但本文主要介绍其在代码中的使用方法。
监控文件变化
接下来，让我们来看一下如何使用 fsmonitor 来监控文件变化。
----- -- - -------------- ----- --------- - --------------------- ----- ---- - ----- ----- ------- - --- -- --- --------------------- -------- -------- -- - -------------------- -- ------ ---
以上是使用 fsmonitor 的基本代码。其中，PATH 参数指的是所要监控的文件或目录的路径；OPTIONS 参数是一个可选对象，用于设置其他配置项。此外，还需要传入一个回调函数，该函数会在文件有变化时被回调，从而进行相应的逻辑处理。在本例中，我们将变化信息输出到终端中进行展示。
需要注意的是，当文件发生变化时，fsmonitor 会返回一个包含变化信息的对象，该对象包括以下属性：
type：变化的类型，包括'created'、'deleted'、'modified'三种；path：发生变化的文件或目录的路径；checkTime：变化发生的时间戳；oldStat：变化前的文件或目录状态；newStat：变化后的文件或目录状态。
使用 fsmonitor 监控文件变化操作就是这样简单。
配置项
我们在上面的代码中提到了 OPTIONS 参数，下面让我们来详细介绍一下 fsmonitor 中可用的配置项。
persistent
该选项表示监控是否应该持续进行，即是否应该在每次变化发生后重新开始监控。默认为 true。
interval
该选项指定了检查文件变化的时间间隔，单位是毫秒。默认值为 100。
ignoreDotFiles
该选项决定是否排除以点开头的文件或目录，默认为 true，即排除。
ignoreCommonPatterns
该选项用于指定需要被排除的文件或目录，可以传入正则表达式或函数。
ignoreCustomPatterns
该选项用于指定需要被排除的文件或目录，可以传入正则表达式或函数。不同于 ignoreCommonPatterns，该选项指定的排除项仅在 persistent 为 true 时生效。
ignoreHiddenFiles
该选项表示是否排除隐藏文件或目录，默认为 true。
ignoreFiles
该选项用于指定需要被排除的文件，可以传入正则表达式或函数。
ignoreDirectories
该选项用于指定需要被排除的目录，可以传入正则表达式或函数。
ignoreChangeCheck
该选项表示是否检查文件变化，默认为 false。如果设为 true，当文件发生变化时，fsmonitor 将无法检测到这些变化。这样做的目的是将 CPU 使用率降到最小。
示例代码
为了帮助大家更好地了解 fsmonitor 的使用方法，以下是一些示例代码。
监控某个目录下的所有文件
----- -- - -------------- ----- --------- - --------------------- ----- ---- - ------- --------------------- - --------- ---- -- -------- -- - -------------------- ---
在这个例子中，我们传入了 interval 配置项，将检测周期设为了 1000 毫秒，即 1 秒。
监控某个文件夹下的.md文件
----- -- - -------------- ----- --------- - --------------------- ----- ---- - ------- --------------------- - ------------ ------- -- -------- -- - -------------------- ---
在这个例子中，我们使用了 ignoreFiles 配置项，将以 .md 结尾的 .md 文件排除掉。
排除某个文件夹下的.ds_store文件
----- -- - -------------- ----- --------- - --------------------- ----- ---- - ------- --------------------- - --------------------- -------------------------- ------------------ ----- -- -------- -- - -------------------- ---
在这个例子中，我们使用了两个配置项。ignoreCustomPatterns 可以传入正则表达式或函数，指定需要被排除的文件或目录。由于我们需要排除的是 .DS_Store 文件，因此将其指定为了正则表达式 /\.DS_Store/。
此外，由于我们只需要在文件发生变化时被触发，而不需要不断重新监控所有文件，因此我们将 ignoreChangeCheck 设为了 true。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/71191