前言
在前端开发过程中，经常需要监听文件的变化，以便自动编译、刷新页面等操作。而 npm 包 sane 就提供了一种方便快捷地实现这些操作的方式。本篇文章将详细介绍如何使用 sane 进行文件监听和处理。
安装
首先需要安装 sane。可以通过 npm 进行安装：
npm install --save-dev sane
基本使用
Sane 提供了一个简单、易用的 API 用于监听文件的变化。下面是一个基本的示例：
const Sane = require('sane');
const watcher = new Sane('/path/to/directory', {
glob: ['**/*'],
});
watcher.on('change', (filepath, root, stat) => {
console.log(`File ${filepath} changed`);
});上述代码创建了一个监听 /path/to/directory 目录下所有文件变化的 watcher。当目录下的任何文件发生变化时，change 事件会被触发，回调函数会接收三个参数：
filepath：发生变化的文件路径。root：监听的根目录。stat：文件状态对象。
配置选项
除了基本用法外，Sane 还提供了一些配置选项，可以更灵活地定制监听行为。以下是一些常用的选项：
glob
类型：string | string[]
默认值：['**/*']
表示需要监听的文件列表。可以使用通配符进行模糊匹配，例如 '*.js' 表示监听所有 JavaScript 文件。
watchman
类型：boolean
默认值：true
是否使用 Watchman 进行文件监听。Watchman 是 Facebook 开源的一款优秀的文件监视器，在性能和稳定性方面都表现出色。如果没有安装 Watchman 或者不想使用 Watchman，可以将该选项设置为 false，此时 Sane 会使用 Node.js 的 fs.watch 进行文件监听。
poll
类型：number | boolean
默认值：undefined
当 watchman 选项被禁用或失败时，会自动切换到轮询模式。poll 选项用于控制轮询间隔时间。如果将其设置为 false，则禁用轮询模式；如果设置为数值类型，则表示以毫秒为单位的间隔时间。
ignored
类型：string | RegExp | (filepath: string) => boolean
默认值：undefined
忽略某些文件或目录。可以使用字符串、正则表达式或回调函数来指定忽略规则。例如，/node_modules/ 表示忽略所有位于 node_modules 目录下的文件或目录。
示例代码
以下是一个完整的示例代码，演示了如何使用 sane 监听文件变化并执行相应操作：
-- -------------------- ---- -------
----- ---- - ----------------
----- - ---- - - -------------------------
----- ------- - --- -------------------------- -
----- --------------
-------- ---------------
---
-------------------- ---------- -- -
----------------- ----------- ----------
----- ------- - ----- ----------- --------------------------- ----------
------------- ----- ------- ------- -- -
-- ----- -
--------------------- -- ------- ------------- -----
-------
-
--------------------- --------------
---
---该示例会监听 /path/to/directory 目录下所有 .scss 文件的变化，并在文件发生变化时执行 sass 命令编译对应的 CSS 文件。同时，忽略了位于 node_modules 目录下的文件。
总结
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/41598