Monocle -- a tool for watching things
Have you ever wanted to watch a folder and all of its files/nested folders for changes. well now you can!
npm install monocle
Watch a directory:
var monocle =monocle;
The listener will recive an object with the following
name: <filename>path: <filepath-relative>fullPath: <filepath-absolute>parentDir: <parentDir-relative>fullParentDir: <parentDir-absolute>stat: <see fsstats>
When a new file is added to the directoy it triggers a file change and thus will be passed to your specified listener.
The two filters are passed through to
readdirp. More documentation can be found here
Watch a list of files:
Just watch path
Just an alias of
watchDirectory so you don't need to tell if that's a file or a directory by yourself. Parameter passed to
path can be a
string or a
Force to use fs.watch
You can use the USE_FS_WATCH env variable set to true, to force this behavior regardless of platform.
Why not just use fs.watch ?
- file watching is really bad cross platforms in node
- you need to be smart when using fs.watch as compared to fs.watchFile
- Monocle takes care of this logic for you!
- windows systems use fs.watch
- osx and linux uses fs.watchFile