chokidar vs rollup vs webpack vs browserify vs watchify vs grunt-contrib-watch vs parcel vs gulp-watch
JavaScript Build Tools and File Watchers Comparison
1 Year
chokidarrollupwebpackbrowserifywatchifygrunt-contrib-watchparcelgulp-watchSimilar Packages:
What's JavaScript Build Tools and File Watchers?

These packages are essential tools in modern web development that help manage and optimize the workflow of building and serving JavaScript applications. They facilitate module bundling, file watching, and asset optimization, allowing developers to streamline their development process and improve application performance. Each tool has its unique features and use cases, catering to different project requirements and developer preferences.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
chokidar64,212,42211,224149 kB242 months agoMIT
rollup29,931,60225,5942.69 MB5863 days agoMIT
webpack28,121,01265,0435.21 MB2447 days agoMIT
browserify1,472,63114,648363 kB3965 months agoMIT
watchify553,9221,788-394 years agoMIT
grunt-contrib-watch306,8061,980-1287 years agoMIT
parcel204,36443,66343.9 kB6202 months agoMIT
gulp-watch123,613640-707 years agoMIT
Feature Comparison: chokidar vs rollup vs webpack vs browserify vs watchify vs grunt-contrib-watch vs parcel vs gulp-watch

Bundling

  • chokidar:

    Chokidar does not bundle files; instead, it focuses on file watching. It efficiently monitors changes in files and directories, triggering callbacks when changes occur, making it a great companion for other build tools.

  • rollup:

    Rollup focuses on bundling ES modules, allowing for tree-shaking to eliminate dead code and reduce bundle size. It is particularly well-suited for libraries and applications that prioritize performance and modularity.

  • webpack:

    Webpack is a comprehensive bundler that supports various module formats and optimizations. It allows for complex configurations, enabling features like code splitting and lazy loading, making it ideal for large applications.

  • browserify:

    Browserify allows you to use Node.js-style modules in the browser, bundling them into a single file that can be included in your HTML. It resolves dependencies and transforms code as needed, making it suitable for projects that rely heavily on modular JavaScript.

  • watchify:

    Watchify extends Browserify by adding file watching capabilities, allowing for faster development cycles. It rebuilds only the changed files, making it efficient for iterative development.

  • grunt-contrib-watch:

    Grunt-contrib-watch watches files and runs specified tasks when changes are detected. It integrates seamlessly with Grunt, allowing you to automate tasks like linting, compiling, and testing as part of your build process.

  • parcel:

    Parcel automatically bundles your application without requiring configuration. It detects dependencies and optimizes the output for production, making it an excellent choice for developers who want simplicity without sacrificing performance.

  • gulp-watch:

    Gulp-watch provides a similar file-watching capability but within the Gulp ecosystem. It allows you to define tasks that run in response to file changes, enabling a more flexible and efficient build process.

File Watching

  • chokidar:

    Chokidar excels in file watching, providing a high-performance solution that can monitor file changes with minimal resource usage. It supports various events and is highly customizable for different use cases.

  • rollup:

    Rollup does not include file watching by default, but it can be integrated with other tools to achieve this functionality. Its primary focus is on bundling rather than development workflows.

  • webpack:

    Webpack includes a powerful dev server with hot module replacement, enabling real-time updates to your application as you make changes, significantly enhancing the development experience.

  • browserify:

    Browserify does not include built-in file watching; however, it can be combined with Watchify to enable this feature, allowing developers to rebuild bundles on-the-fly during development.

  • watchify:

    Watchify is specifically designed to add file watching to Browserify, allowing for incremental builds and a faster feedback loop during development.

  • grunt-contrib-watch:

    Grunt-contrib-watch is designed specifically for watching files and executing tasks in response to changes. It is straightforward to set up and integrates well with existing Grunt tasks.

  • parcel:

    Parcel includes built-in file watching capabilities, automatically rebuilding and reloading your application as you make changes, providing a smooth development experience without additional configuration.

  • gulp-watch:

    Gulp-watch offers a flexible way to watch files and trigger Gulp tasks, allowing for a more streamlined development experience. It supports streaming and can handle multiple file types efficiently.

Configuration Complexity

  • chokidar:

    Chokidar requires minimal configuration, focusing on file watching functionality. It can be easily integrated into existing Node.js applications without complex setup.

  • rollup:

    Rollup requires some configuration, especially for advanced features like plugins and optimizations. However, it is generally straightforward for basic use cases focused on ES module bundling.

  • webpack:

    Webpack is highly configurable, which can be both a strength and a challenge. Its extensive options allow for powerful customizations, but the learning curve can be steep for newcomers.

  • browserify:

    Browserify has a relatively simple configuration process, especially for basic use cases. It allows developers to get started quickly without extensive setup, making it accessible for smaller projects.

  • watchify:

    Watchify inherits Browserify's configuration style, making it easy to set up for those already familiar with Browserify. It adds minimal complexity for enabling file watching.

  • grunt-contrib-watch:

    Grunt-contrib-watch requires a Grunt configuration file, which can become complex as the number of tasks increases. However, it provides a clear structure for task automation.

  • parcel:

    Parcel is known for its zero-configuration philosophy, allowing developers to start building applications without any setup. It automatically handles most configurations, making it ideal for quick projects.

  • gulp-watch:

    Gulp-watch offers a more flexible approach to configuration, allowing developers to define tasks in a straightforward manner. Its streaming nature can simplify complex workflows, but it may require more initial setup compared to simpler tools.

Ecosystem and Community

  • chokidar:

    Chokidar is well-supported within the Node.js community and is often used in conjunction with other tools, making it a reliable choice for file watching tasks.

  • rollup:

    Rollup has a dedicated community focused on module bundling, especially for libraries. Its emphasis on ES modules and tree-shaking has made it a popular choice among developers prioritizing performance.

  • webpack:

    Webpack boasts one of the largest communities among build tools, with extensive documentation, plugins, and integrations. It is widely adopted in the industry, making it a safe choice for complex applications.

  • browserify:

    Browserify has a solid community and a range of plugins available, but it is not as actively maintained as some newer tools. It is still widely used for projects that require simple module bundling.

  • watchify:

    Watchify is a niche tool primarily used by those who already use Browserify. Its community is smaller but still active among developers looking for incremental builds.

  • grunt-contrib-watch:

    Grunt-contrib-watch benefits from the larger Grunt ecosystem, which includes numerous plugins for various tasks. However, Grunt's popularity has declined in favor of newer tools like Gulp and Webpack.

  • parcel:

    Parcel has a growing community and is gaining traction for its simplicity and performance. It is particularly popular among developers looking for an easy-to-use bundler with minimal configuration.

  • gulp-watch:

    Gulp-watch is part of the Gulp ecosystem, which has a vibrant community and a wide array of plugins. Gulp's streaming approach has gained popularity for its efficiency and flexibility.

Performance Optimization

  • chokidar:

    Chokidar is optimized for performance when watching files, using efficient file system events to minimize resource usage and improve responsiveness.

  • rollup:

    Rollup excels in performance optimization, particularly for libraries, by using tree-shaking to eliminate unused code and produce smaller bundles. It is ideal for performance-critical applications.

  • webpack:

    Webpack offers extensive performance optimization features, including code splitting, lazy loading, and caching strategies. It is highly configurable, allowing developers to tailor optimizations to their specific needs.

  • browserify:

    Browserify provides basic optimizations for bundling but may not be as efficient as newer tools for larger applications. It is suitable for smaller projects where simplicity is key.

  • watchify:

    Watchify enhances Browserify's performance during development by enabling incremental builds, allowing developers to see changes quickly without rebuilding the entire bundle.

  • grunt-contrib-watch:

    Grunt-contrib-watch can introduce some overhead due to its task-based nature, but it can be optimized through careful task management and configuration.

  • parcel:

    Parcel automatically optimizes your application during the build process, including code splitting and asset optimization, which can significantly enhance performance without manual intervention.

  • gulp-watch:

    Gulp-watch is designed for performance, leveraging streams to handle file changes efficiently without unnecessary overhead, making it a good choice for larger projects.

How to Choose: chokidar vs rollup vs webpack vs browserify vs watchify vs grunt-contrib-watch vs parcel vs gulp-watch
  • chokidar:

    Select Chokidar for efficient file watching in Node.js applications. It is ideal for scenarios where you need to monitor file changes and trigger actions without the overhead of a full build tool.

  • rollup:

    Select Rollup if you need to create optimized bundles for libraries or applications, focusing on ES modules and tree-shaking to reduce bundle size.

  • webpack:

    Choose Webpack for a powerful and highly configurable module bundler that supports complex applications, code splitting, and a rich ecosystem of plugins and loaders.

  • browserify:

    Choose Browserify if you need to bundle Node.js-style modules for use in the browser, especially if you want to maintain a simple setup without a complex build process.

  • watchify:

    Use Watchify if you want to enhance Browserify's capabilities with file watching, allowing for incremental builds during development without restarting the entire process.

  • grunt-contrib-watch:

    Opt for Grunt with grunt-contrib-watch if you're already using Grunt as your task runner and need a straightforward way to watch files and run tasks automatically on changes.

  • parcel:

    Choose Parcel for a zero-configuration bundler that automatically handles dependencies and optimizations, making it great for quick prototypes and smaller projects.

  • gulp-watch:

    Use Gulp with gulp-watch if you prefer a streaming build system that allows for more complex workflows and task automation, especially when working with multiple file types and transformations.

README for chokidar

Chokidar Weekly downloads

Minimal and efficient cross-platform file watching library

Why?

There are many reasons to prefer Chokidar to raw fs.watch / fs.watchFile in 2024:

  • Events are properly reported
    • macOS events report filenames
    • events are not reported twice
    • changes are reported as add / change / unlink instead of useless rename
  • Atomic writes are supported, using atomic option
    • Some file editors use them
  • Chunked writes are supported, using awaitWriteFinish option
    • Large files are commonly written in chunks
  • File / dir filtering is supported
  • Symbolic links are supported
  • Recursive watching is always supported, instead of partial when using raw events
    • Includes a way to limit recursion depth

Chokidar relies 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. The fs.watch-based implementation is the default, which avoids polling and keeps CPU usage down. Be advised that chokidar will initiate watchers recursively for everything within scope of the paths that have been specified, so be judicious about not wasting system resources by watching much more than needed. For some cases, fs.watchFile, which utilizes polling and uses more resources, is used.

Made for Brunch in 2012, it is now used in ~30 million repositories and has proven itself in production environments.

Sep 2024 update: v4 is out! It decreases dependency count from 13 to 1, removes support for globs, adds support for ESM / Common.js modules, and bumps minimum node.js version from v8 to v14. Check out upgrading.

Getting started

Install with npm:

npm install chokidar

Use it in your code:

import chokidar from 'chokidar';

// One-liner for current directory
chokidar.watch('.').on('all', (event, path) => {
  console.log(event, path);
});


// Extended options
// ----------------

// Initialize watcher.
const watcher = chokidar.watch('file, dir, or array', {
  ignored: (path, stats) => stats?.isFile() && !path.endsWith('.js'), // only watch js files
  persistent: true
});

// Something to use when events are received.
const log = console.log.bind(console);
// Add event listeners.
watcher
  .on('add', path => log(`File ${path} has been added`))
  .on('change', path => log(`File ${path} has been changed`))
  .on('unlink', path => log(`File ${path} has been removed`));

// More possible events.
watcher
  .on('addDir', path => log(`Directory ${path} has been added`))
  .on('unlinkDir', path => log(`Directory ${path} has been removed`))
  .on('error', error => log(`Watcher error: ${error}`))
  .on('ready', () => log('Initial scan complete. Ready for changes'))
  .on('raw', (event, path, details) => { // internal
    log('Raw event info:', event, path, details);
  });

// 'add', 'addDir' and 'change' events also receive stat() results as second
// argument when available: https://nodejs.org/api/fs.html#fs_class_fs_stats
watcher.on('change', (path, stats) => {
  if (stats) console.log(`File ${path} changed size to ${stats.size}`);
});

// Watch new files.
watcher.add('new-file');
watcher.add(['new-file-2', 'new-file-3']);

// Get list of actual paths being watched on the filesystem
let watchedPaths = watcher.getWatched();

// Un-watch some files.
await watcher.unwatch('new-file');

// Stop watching. The method is async!
await watcher.close().then(() => console.log('closed'));

// Full list of options. See below for descriptions.
// Do not use this example!
chokidar.watch('file', {
  persistent: true,

  // ignore .txt files
  ignored: (file) => file.endsWith('.txt'),
  // watch only .txt files
  // ignored: (file, _stats) => _stats?.isFile() && !file.endsWith('.txt'),

  awaitWriteFinish: true, // emit single event when chunked writes are completed
  atomic: true, // emit proper events when "atomic writes" (mv _tmp file) are used

  // The options also allow specifying custom intervals in ms
  // awaitWriteFinish: {
  //   stabilityThreshold: 2000,
  //   pollInterval: 100
  // },
  // atomic: 100,

  interval: 100,
  binaryInterval: 300,

  cwd: '.',
  depth: 99,

  followSymlinks: true,
  ignoreInitial: false,
  ignorePermissionErrors: false,
  usePolling: false,
  alwaysStat: false,
});

chokidar.watch(paths, [options])

  • paths (string or array of strings). Paths to files, dirs to be watched recursively.
  • options (object) Options object as defined below:

Persistence

  • persistent (default: true). Indicates whether the process should continue to run as long as files are being watched.

Path filtering

  • ignored function, regex, or path. Defines files/paths to be ignored. The whole relative or absolute path is tested, not just filename. If a function with two arguments is provided, it gets called twice per path - once with a single argument (the path), second time with two arguments (the path and the fs.Stats object of that path).
  • ignoreInitial (default: false). If set to false then add/addDir events are also emitted for matching paths while instantiating the watching as chokidar discovers these file paths (before the ready event).
  • followSymlinks (default: true). When false, only the symlinks themselves will be watched for changes instead of following the link references and bubbling events through the link's path.
  • cwd (no default). The base directory from which watch paths are to be derived. Paths emitted with events will be relative to this.

Performance

  • usePolling (default: false). Whether to use fs.watchFile (backed by polling), or fs.watch. If polling leads to high CPU utilization, consider setting this to false. It is typically necessary to set this to true to successfully watch files over a network, and it may be necessary to successfully watch files in other non-standard situations. Setting to true explicitly on MacOS overrides the useFsEvents default. You may also set the CHOKIDAR_USEPOLLING env variable to true (1) or false (0) in order to override this option.
  • Polling-specific settings (effective when usePolling: true)
    • interval (default: 100). Interval of file system polling, in milliseconds. You may also set the CHOKIDAR_INTERVAL env variable to override this option.
    • binaryInterval (default: 300). Interval of file system polling for binary files. (see list of binary extensions)
  • alwaysStat (default: false). If relying upon the fs.Stats object that may get passed with add, addDir, and change events, set this to true to ensure it is provided even in cases where it wasn't already available from the underlying watch events.
  • depth (default: undefined). If set, limits how many levels of subdirectories will be traversed.
  • awaitWriteFinish (default: false). By default, the add event will fire when a file first appears on disk, before the entire file has been written. Furthermore, in some cases some change events will be emitted while the file is being written. In some cases, especially when watching for large files there will be a need to wait for the write operation to finish before responding to a file creation or modification. Setting awaitWriteFinish to true (or a truthy value) will poll file size, holding its add and change events until the size does not change for a configurable amount of time. The appropriate duration setting is heavily dependent on the OS and hardware. For accurate detection this parameter should be relatively high, making file watching much less responsive. Use with caution.
    • options.awaitWriteFinish can be set to an object in order to adjust timing params:
    • awaitWriteFinish.stabilityThreshold (default: 2000). Amount of time in milliseconds for a file size to remain constant before emitting its event.
    • awaitWriteFinish.pollInterval (default: 100). File size polling interval, in milliseconds.

Errors

  • ignorePermissionErrors (default: false). Indicates whether to watch files that don't have read permissions if possible. If watching fails due to EPERM or EACCES with this set to true, the errors will be suppressed silently.
  • atomic (default: true if useFsEvents and usePolling are false). Automatically filters out artifacts that occur when using editors that use "atomic writes" instead of writing directly to the source file. If a file is re-added within 100 ms of being deleted, Chokidar emits a change event rather than unlink then add. If the default of 100 ms does not work well for you, you can override it by setting atomic to a custom value, in milliseconds.

Methods & Events

chokidar.watch() produces an instance of FSWatcher. Methods of FSWatcher:

  • .add(path / paths): Add files, directories for tracking. Takes an array of strings or just one string.
  • .on(event, callback): Listen for an FS event. Available events: add, addDir, change, unlink, unlinkDir, ready, raw, error. Additionally all is available which gets emitted with the underlying event name and path for every event other than ready, raw, and error. raw is internal, use it carefully.
  • .unwatch(path / paths): Stop watching files or directories. Takes an array of strings or just one string.
  • .close(): async Removes all listeners from watched files. Asynchronous, returns Promise. Use with await to ensure bugs don't happen.
  • .getWatched(): Returns an object representing all the paths on the file system being watched by this FSWatcher instance. The object's keys are all the directories (using absolute paths unless the cwd option was used), and the values are arrays of the names of the items contained in each directory.

CLI

Check out third party chokidar-cli, which allows to execute a command on each change, or get a stdio stream of change events.

Troubleshooting

Sometimes, Chokidar runs out of file handles, causing EMFILE and ENOSP errors:

  • bash: cannot set terminal process group (-1): Inappropriate ioctl for device bash: no job control in this shell
  • Error: watch /home/ ENOSPC

There are two things that can cause it.

  1. Exhausted file handles for generic fs operations
    • Can be solved by using graceful-fs, which can monkey-patch native fs module used by chokidar: let fs = require('fs'); let grfs = require('graceful-fs'); grfs.gracefulify(fs);
    • Can also be solved by tuning OS: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p.
  2. Exhausted file handles for fs.watch
    • Can't seem to be solved by graceful-fs or OS tuning
    • It's possible to start using usePolling: true, which will switch backend to resource-intensive fs.watchFile

All fsevents-related issues (WARN optional dep failed, fsevents is not a constructor) are solved by upgrading to v4+.

Changelog

  • v4 (Sep 2024): remove glob support and bundled fsevents. Decrease dependency count from 13 to 1. Rewrite in typescript. Bumps minimum node.js requirement to v14+
  • v3 (Apr 2019): massive CPU & RAM consumption improvements; reduces deps / package size by a factor of 17x and bumps Node.js requirement to v8.16+.
  • v2 (Dec 2017): globs are now posix-style-only. Tons of bugfixes.
  • v1 (Apr 2015): glob support, symlink support, tons of bugfixes. Node 0.8+ is supported
  • v0.1 (Apr 2012): Initial release, extracted from Brunch

Upgrading

If you've used globs before and want do replicate the functionality with v4:

// v3
chok.watch('**/*.js');
chok.watch("./directory/**/*");

// v4
chok.watch('.', {
  ignored: (path, stats) => stats?.isFile() && !path.endsWith('.js'), // only watch js files
});
chok.watch('./directory');

// other way
import { glob } from 'node:fs/promises';
const watcher = watch(await Array.fromAsync(glob('**/*.js')));

// unwatching
// v3
chok.unwatch('**/*.js');
// v4
chok.unwatch(await glob('**/*.js'));

Also

Why was chokidar named this way? What's the meaning behind it?

Chowkidar is a transliteration of a Hindi word meaning 'watchman, gatekeeper', चौकीदार. This ultimately comes from Sanskrit _ चतुष्क_ (crossway, quadrangle, consisting-of-four). This word is also used in other languages like Urdu as (چوکیدار) which is widely used in Pakistan and India.

License

MIT (c) Paul Miller (https://paulmillr.com), see LICENSE file.