Chokidar is a solution for all the users of Node.js fs.watch who are tired of it not reporting filenames on MacOS and events at all when using editors like Sublime on MacOS. Node.js fs.watch often reports events twice, emits most changes as rename, and it does not provide an easy way to recursively watch file trees nor supports recursive watching on Linux. Same as with Node.js fs.watchFile. Therefore, Chokidar resolves these problems. Initially made for Brunch (an ultra-swift web app build tool), it is now used in Microsoft's Visual Studio Code, gulp, karma, PM2, browserify, webpack, BrowserSync, and many others. It has proven itself in production environments. Chokidar does still rely on the Node.js core fs module, but when using fs.watch and fs.watchFile for watching, it normalizes the events it receives, often checking for truth by getting file stats and/or dir contents.

Features

  • On MacOS, chokidar by default uses a native extension exposing the Darwin FSEvents API
  • On most other platforms, the fs.watch-based implementation is the default
  • Chokidar will initiate watchers recursively for everything within scope of the paths that have been specified
  • The whole relative or absolute path is tested, not just filenames
  • Support for ARM Macs with Apple Silicon
  • Support for directory-based symlinks

Project Samples

Project Activity

See All Activity >

License

MIT License

Follow Chokidar

Chokidar Web Site

You Might Also Like
MongoDB Atlas runs apps anywhere Icon
MongoDB Atlas runs apps anywhere

Deploy in 115+ regions with the modern database for every enterprise.

MongoDB Atlas gives you the freedom to build and run modern applications anywhere—across AWS, Azure, and Google Cloud. With global availability in over 115 regions, Atlas lets you deploy close to your users, meet compliance needs, and scale with confidence across any geography.
Start Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Chokidar!

Additional Project Details

Operating Systems

Linux, Mac, Windows

Programming Language

JavaScript

Related Categories

JavaScript Data Visualization Software, JavaScript Libraries

Registered

2021-07-21