简介
files-watcher 是一个基于 Node.js 的文件监控工具，用于检测文件的改动并触发相应的操作，如重新编译、执行测试、部署等。它可以适用于前端开发中编译 Less、Sass、TypeScript 等文件的场景，也可以用于后端开发中对 Node.js 服务器的监控和操作。
本文将介绍 files-watcher 的基本用法、高级配置和示例代码，帮助读者快速上手使用该工具。
基本用法
files-watcher 的基本用法非常简单，只需要安装 NPM 包并在终端执行相应的命令即可开始监控文件。以下是该工具的安装和基本命令：
npm install -g files-watcher # 全局安装 files-watcher --watch='./src' --run='npm run build' # 监控 src 下的文件，执行 npm run build 命令
上述命令中，--watch 参数指定待监控的文件路径，--run 参数指定文件变化后需要执行的命令。如果想要同时监控多个路径，可以使用英文逗号 , 分隔多个路径。例如：
files-watcher --watch='./src,./test' --run='npm run build'
files-watcher 默认会监听添加、删除、修改三种事件，如果要限定某种类型的事件，可以使用 --ignore 参数。例如，如果只想监听文件修改事件，可以这样写：
files-watcher --watch='./src' --run='npm run build' --ignore='add,delete'
高级配置
除了基本用法外，files-watcher 还提供了一些高级配置选项，用于进一步定制化工具的行为。
--debounce
默认情况下，files-watcher 会在文件发生变化后立即执行对应的命令。如果文件发生变化的频率较高，可能会导致频繁的命令执行，降低性能。为此，files-watcher 提供了 --debounce 参数，用于设置命令执行的间隔时间（单位为毫秒）。例如，如果将 --debounce 设置为 500ms，那么在这段时间内如果有多个文件发生变化，只会执行一次命令。以下是示例命令：
files-watcher --watch='./src' --run='npm run build' --debounce=500
--max-restarts
有时候执行的命令会出现错误，导致 files-watcher 自动退出。为了避免这种情况，可以使用 --max-restarts 参数，用于设置 files-watcher 允许的最大重启次数。如果执行的命令连续出错次数超过该值，files-watcher 会停止运行。以下是示例命令：
files-watcher --watch='./src' --run='npm run build' --max-restarts=3
--silent
默认情况下，files-watcher 会输出命令执行的输出结果。如果想要禁止输出这些信息，可以使用 --silent 参数。例如：
files-watcher --watch='./src' --run='npm run build' --silent
--ext
files-watcher 会自动监控指定路径下的文件，但默认只监控常见的文件类型，如 .js、.css、.html 等。如果要自定义监控的文件类型，可以使用 --ext 参数。例如，如果要监控 .less 文件，可以这样写：
files-watcher --watch='./src' --ext='.less' --run='npm run build'
示例代码
为了帮助读者更好地理解 files-watcher 的使用，以下是一些前端开发中常见的使用场景及对应的 files-watcher 命令。
编译 Less
前端开发中常用的 CSS 预处理器之一是 Less，通过编写 Less 样式可以提高 CSS 的可维护性和可读性。 以下是使用 files-watcher 编译 Less 文件的命令：
files-watcher --watch='./src/**/*.less' --run='lessc src/main.less > dist/main.css'
该命令会监控 ./src 目录下的所有 .less 文件，当其中任何一个文件发生变化时，执行 lessc 命令将 src/main.less 编译成 dist/main.css 输出。
编译 TypeScript
TypeScript 是一种强类型的 JavaScript 超集，它可以提高代码的可读性和可维护性。以下是使用 files-watcher 编译 TypeScript 文件的命令：
files-watcher --watch='./src/**/*.ts' --run='tsc'
该命令会监控 ./src 目录下的所有 .ts 文件，当其中任何一个文件发生变化时，执行 tsc 命令将 TypeScript 编译成 JavaScript。
执行测试
测试是代码质量保障的重要环节，它可以减少代码中的 bug，并验证代码的正确性。以下是使用 files-watcher 执行测试的命令：
files-watcher --watch='./test/**/*.test.js' --run='mocha test'
该命令会监控 ./test 目录下的所有 .test.js 测试文件，当其中任何一个文件发生变化时，执行 mocha 命令执行测试用例。
总结
本文介绍了 npm 包 files-watcher 的基本用法、高级配置和示例代码。通过学习本文，读者可以在前端开发中更方便地使用该工具，提高开发效率和代码质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067354890c4f72775839a2