首页
/ `node-dev` 使用教程

`node-dev` 使用教程

2024-08-10 15:32:52作者:何将鹤

1. 项目目录结构及介绍

node-dev 是一个简单的工具,用于在Linux系统上自动重新加载Node.js应用以响应文件变动。项目的目录结构如下:

.
├── README.md       # 项目说明文档
├── index.js        # 主要的源代码实现
├── manager.js      # 管理器文件,处理监控和重启逻辑
├── node-dev.sh     # shell脚本,用于全局安装后的命令行调用
├── package.json    # 项目配置和依赖
└── npmignore        # 忽略文件列表

README.md 包含了项目的基本信息和使用指南。

index.js 是核心模块,实现了基于inotify的文件监控功能。

manager.js 是一个小型的管理器,负责启动和管理监控进程。

node-dev.sh 全局安装后,这个脚本使得node-dev 可以通过命令行方便地调用。

package.json 描述了项目元数据以及依赖库。

npmignore 文件列出了在打包或发布时应该忽略的文件和路径。

2. 项目的启动文件介绍

启动文件是你的Node.js应用程序入口点,即你要运行的JavaScript文件。例如,通常命名为app.js。当你执行node-dev app.js命令时,node-dev 将监控app.js及其相关依赖,当这些文件发生改动时,它会自动重启你的应用。

简单使用示例

$ node-dev app.js

这将启动你的应用并监听文件变化。

3. 项目的配置文件介绍

node-dev 并没有固定的配置文件,但可以通过命令行参数或者自定义manager.js来设置选项。以下是可调整的一些关键选项:

  • run: 要运行的js文件路径。
  • watchDir: 需要递归监控的目录,默认值为空。
  • ignoredPaths: 不需要被监控的文件或路径数组。可以是字符串、正则表达式或判断函数。

如果你想要自定义行为,可以直接修改manager.js,或者基于它创建自己的监控和自动重载脚本。

在不提供配置文件的情况下,node-dev 默认只监控指定的run文件及其关联文件,且忽略/public目录下的文件、扩展名为.db.dirtydb的文件,以及所有以.开头的隐藏目录。

若需自定义配置,你可以这样修改manager.js:

var manager = require("dev")({
  run: '/path/to/app.js',
  watchDir: '/path/to/watch',
  ignoredPaths: ['/public', /\.gif$/, function(path) { return path.includes('temp') }],
  debug: true // 启用额外的日志输出
});
manager.start();

这样便可以根据自己的需求定制监控规则和行为。


请注意,由于node-dev 依赖于Linux系统的inotify,因此它只适用于Linux操作系统。对于其他OS,推荐使用像pm2nodemon这样的替代方案。

登录后查看全文
热门项目推荐
相关项目推荐