npm-watch 项目使用教程

1. 项目的目录结构及介绍

npm-watch 是一个监控文件变化并执行相应 npm 脚本的工具。以下是项目的目录结构：

npm-watch/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── cli.js
├── package.json
└── watch-package.js

• .gitattributes: 指定 git 应该使用哪种行结束符风格。
• .gitignore: 指定哪些文件和目录应该被 git 忽略。
• LICENSE: 项目的许可协议文件，本项目使用 MIT 许可。
• README.md: 项目的说明文件，包含了项目的使用说明和配置指南。
• cli.js: 命令行界面脚本，用于处理命令行参数。
• package.json: 项目的元数据文件，包括项目名称、版本、描述、依赖、脚本等。
• watch-package.js: 包含 npm-watch 功能的核心代码。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本实现的。例如，你可以通过以下命令启动监控：

npm run watch

这个命令会调用 watch 脚本，该脚本在 package.json 中定义如下：

"scripts": {
  "watch": "npm-watch"
}

npm-watch 会监控你的文件系统，一旦发现指定的文件或目录发生变化，就会执行与之关联的 npm 脚本。

3. 项目的配置文件介绍

项目的配置主要通过修改 package.json 中的 watch 配置项进行。以下是一个配置示例：

{
  "watch": {
    "test": {
      "patterns": ["src", "test"],
      "extensions": "js,jsx",
      "ignore": "src/vendor/external.min.js",
      "quiet": true,
      "legacyWatch": true,
      "delay": 2500,
      "runOnChangeOnly": false
    }
  },
  "scripts": {
    "test": "tape test/*.js"
  }
}

在这个配置中：

• patterns: 指定要监控的文件模式或目录。
• extensions: 指定要监控的文件扩展名。
• ignore: 指定要忽略的文件或目录模式。
• quiet: 如果设置为 true，则不会在标准输出和标准错误输出中显示脚本名。
• legacyWatch: 如果设置为 true，则使用 nodemon 的旧版文件监控方法。
• delay: 指定在检查新文件之前要延迟的毫秒数。
• runOnChangeOnly: 如果设置为 true，则 nodemon 仅在文件更改时执行脚本，而不是在启动时执行。

通过修改这些配置项，你可以根据项目的具体需求来定制 npm-watch 的行为。