graceful-fs VS chokidar

async (config?: { /** * Overwrite the default ignored behavior */ customIgnored?: string[]; }) => { const projectRoot = getProjectRoot(); if (!projectRoot) return; // NB: fix to globally alter real fs in order to fix EMFile error that happens in TSMorph (see https://github.com/isaacs/node-graceful-fs) gracefulFs.gracefulify(realFs); console.log("Searching..."); const tsFunctions = await db.get("TsFunction"); const projectWatcherTsFunctions = tsFunctions.filter( (x) => x.explicitTypeName === "ProjectWatcher" ); const projectWatchers = projectWatcherTsFunctions .map((x) => x.name) .map((name) => sdk[name as keyof typeof sdk] as ProjectWatcher | undefined) .filter(notEmpty); log(`${projectWatchers.length} watchers gonna watch ${projectRoot}`, { type: "important", }); const startupWaitMs = 1000; setTimeout(() => { log( `There they are! \n\n${projectWatchers .map((projectWatcher) => { return `👁 👁 ${projectWatcher.name} ✅`; }) .join("\n")}`, { type: "success", } ); }, startupWaitMs); const startTimeAt = Date.now(); watch(projectRoot, { ignoreInitial: true, ignored: config?.customIgnored || [ "**/node_modules/**", "**/.next/**", "**/.expo/**", "**/build/**", "**/db/**", "**/.git/**", "**/.turbo/**", "**/generated/**", ], // alwaysStat: true, // not sure why I would need this, seems inefficient if I don't need it, I can simply run fs.stat }).on("all", (eventName, path, stats) => { if (Date.now() < startTimeAt + startupWaitMs) return; const relevantWatchers = projectWatchers.filter((watcher) => watcher.filter(eventName, path) ); oneByOne(relevantWatchers, async (projectWatcher) => { await projectWatcher(eventName, path); }); }); };

What's probably got your shorts in a knot is the contents of the node_modules directory. That directory is a cache for mode.js modules so the tutorial can function standalone without having to install anything else. Treat it as you would object code. I pulled a half-dozen of those modules at random and went to their repositories. Every one of them had unit tests: block-stream, graceful-fs, lowercase-keys, minimist, pify and safe-buffer. Nobody sane ships unit tests with their executables.

graceful-fs https://www.npmjs.com/package/graceful-fs

For this, we'll use chokidar - more specifically the chokidar-cli package. chokidar is probably the most useful file watching library for the nodejs ecosystem and it will serve us well.

tailwindcss -> chokidar -> braces -> fill-range -> to-regex-range -> is-number

is-number was first published 9 years ago, when these kind of micro-packages were in vogue. braces was added as a dependency to chokidar over 6 years ago [1]. And if it ain't broke, don't fix it. I don't think the average JS dev today is going out and pulling in these deps.

[1] https://github.com/paulmillr/chokidar/commit/cbdf25563cfff7f...

The watching magic is really in the https://www.npmjs.com/package/chokidar library

> It’s typical to listen to this stream of events and use chained if-else statements to determine an action based on the type of the events that occur.

You'd think something like directory watching would have a clear set of events that would make nice objects with consistent meanings, but in my experience file watching gets crazy complicated, and can have all sorts of edge cases.

Just take a looked here for all the various edge cases that crop up: https://github.com/paulmillr/chokidar/issues

Then you have linux, windows, macos, and maybe you want to abstract over some underlying implementation like chokidar vs fb/watchman vs webpack/watchpack. Every new OS release could also cause things to change.

So usually its going to be a bunch of if-else statements hacked together to get around edge cases, and have to be revisited later on.

Any attempt to abstract this into objects, just obfuscates things. And OO forces you to name things, when in fact they might be un-nameable. `FileSystemModifyEventExceptWhenXAndYAndSometimesZ`.

The behavior might rely on a series of events together, so the object hierarchy must be re-worked.

OO has this rosy idea that we just have to come up with the perfect hierarchy, but things change in unexpected ways, and everything must have a descriptive noun.

Next, you can use a library like chokidar to listen for changes in your source directory. Create a ws server, and whenever a file changes, send a message.

As another has mentioned, nodemon uses chokidar under the hood for the actual file watching part.

At the end of the day, ironically, Nodemon does not even implement file watching functionality. It is a thin wrapper around chokidar (see source code), and the way it is being used is neither efficient (CPU and your battery usage) or performant. So it is not a false argument, just perhaps not the most appealing.

for file watching, it might use something similar to https://www.npmjs.com/package/chokidar

First, we need to install chokidar to enable watching and automatically refreshing our files.