Convert Figma logo to code with AI

paulmillr logochokidar

Minimal and efficient cross-platform file watching library

10,813
574
10,813
15

Top Related Projects

26,226

Monitor for any changes in your node.js application and automatically restart the server - perfect for development

1,275

Utilities for watching file trees in node.js

Quick Overview

Chokidar is a powerful and efficient file watching library for Node.js. It provides a consistent interface for watching file system changes across different platforms, including macOS, Linux, and Windows. Chokidar aims to solve common issues with Node.js' built-in fs.watch and fs.watchFile functions, offering improved performance and reliability.

Pros

  • Cross-platform compatibility with consistent behavior
  • Efficient and performant, especially for large directory trees
  • Configurable with numerous options for fine-tuning
  • Actively maintained with good community support

Cons

  • Slightly higher memory usage compared to native Node.js watchers
  • May have occasional issues with network file systems or certain edge cases
  • Learning curve for advanced usage and configuration options

Code Examples

  1. Basic file watching:
const chokidar = require('chokidar');

const watcher = chokidar.watch('path/to/directory', {
  persistent: true,
  ignoreInitial: true
});

watcher
  .on('add', path => console.log(`File ${path} has been added`))
  .on('change', path => console.log(`File ${path} has been changed`))
  .on('unlink', path => console.log(`File ${path} has been removed`));
  1. Watching multiple paths with glob patterns:
const watcher = chokidar.watch(['src/**/*.js', 'test/**/*.js'], {
  ignored: /(^|[\/\\])\../
});

watcher.on('all', (event, path) => {
  console.log(event, path);
});
  1. Using with async/await and error handling:
const chokidar = require('chokidar');

async function watchFiles() {
  try {
    const watcher = chokidar.watch('path/to/directory');
    
    watcher.on('ready', () => console.log('Initial scan complete. Ready for changes'));
    
    for await (const event of watcher) {
      console.log(`Event ${event.eventName} occurred on ${event.path}`);
    }
  } catch (error) {
    console.error('Error occurred:', error);
  }
}

watchFiles();

Getting Started

To use Chokidar in your project, follow these steps:

  1. Install Chokidar:

    npm install chokidar
    
  2. Import and use in your JavaScript file:

    const chokidar = require('chokidar');
    
    const watcher = chokidar.watch('path/to/watch', {
      persistent: true,
      ignoreInitial: false
    });
    
    watcher
      .on('add', path => console.log(`File ${path} has been added`))
      .on('change', path => console.log(`File ${path} has been changed`))
      .on('unlink', path => console.log(`File ${path} has been removed`));
    

This basic setup will watch the specified path and log file system events to the console. Adjust the options and event handlers as needed for your specific use case.

Competitor Comparisons

26,226

Monitor for any changes in your node.js application and automatically restart the server - perfect for development

Pros of nodemon

  • Designed specifically for restarting Node.js applications
  • Built-in command-line interface for easy usage
  • Supports various file types and custom configurations

Cons of nodemon

  • More focused on Node.js, less versatile for other use cases
  • Heavier resource usage compared to Chokidar
  • May have slower file watching performance in large projects

Code Comparison

nodemon:

nodemon({
  script: 'app.js',
  ext: 'js json',
  ignore: ['node_modules/']
}).on('restart', function() {
  console.log('App restarted!');
});

Chokidar:

const chokidar = require('chokidar');

chokidar.watch('path/to/dir', {
  ignored: /(^|[\/\\])\../,
  persistent: true
}).on('change', (path) => {
  console.log(`File ${path} has been changed`);
});

Key Differences

  • nodemon is tailored for Node.js development, while Chokidar is a more general-purpose file watching library
  • Chokidar offers finer control over file watching behavior and is more lightweight
  • nodemon provides a simpler setup for Node.js projects with built-in restart functionality
  • Chokidar can be integrated into various build tools and frameworks more easily

Both libraries serve different purposes and can be chosen based on specific project requirements and use cases.

1,275

Utilities for watching file trees in node.js

Pros of watch

  • Simpler API with fewer options, making it easier to use for basic file watching tasks
  • Lightweight with minimal dependencies, resulting in a smaller package size
  • Faster initial setup time for watching directories

Cons of watch

  • Less robust handling of complex file system events and edge cases
  • Limited configurability compared to Chokidar's extensive options
  • May miss some file changes in certain scenarios, especially on Windows

Code Comparison

watch:

var watch = require('watch');
watch.createMonitor('/path/to/watch', function (monitor) {
  monitor.on("created", function (f, stat) {
    console.log("File created: " + f);
  });
});

Chokidar:

const chokidar = require('chokidar');
const watcher = chokidar.watch('/path/to/watch', {
  persistent: true,
  ignoreInitial: true
});
watcher.on('add', path => console.log(`File ${path} has been added`));

Both libraries provide file watching functionality, but Chokidar offers more advanced features and better cross-platform compatibility. Watch is simpler and lighter, which may be preferable for basic use cases. However, Chokidar's robustness and extensive options make it more suitable for complex file watching scenarios and production environments.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

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.

Aug 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.

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: /(^|[\/\\])\../, // ignore dotfiles
  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!
watcher.close().then(() => console.log('closed'));

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

  ignored: (file) => file.endsWith('.txt'),
  ignoreInitial: false,
  followSymlinks: true,
  cwd: '.',

  usePolling: false,
  interval: 100,
  binaryInterval: 300,
  alwaysStat: false,
  depth: 99,
  awaitWriteFinish: {
    stabilityThreshold: 2000,
    pollInterval: 100
  },

  ignorePermissionErrors: false,
  atomic: true // or a custom 'atomicity delay', in milliseconds (default 100)
});

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. If set to false when using fsevents to watch, no more events will be emitted after ready, even if the process continues to run.

Path filtering

  • ignored (anymatch-compatible definition) 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)
  • useFsEvents (default: true on MacOS). Whether to use the fsevents watching interface if available. When set to true explicitly and fsevents is available this supercedes the usePolling setting. When set to false on MacOS, usePolling: true becomes the default.
  • 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

If you need a CLI interface for your file watching, check out third party chokidar-cli, allowing you to execute a command on each change, or get a stdio stream of change events.

Troubleshooting

  • On Linux, sometimes there's ENOSP error:
    • bash: cannot set terminal process group (-1): Inappropriate ioctl for device bash: no job control in this shell Error: watch /home/ ENOSPC
    • This means Chokidar ran out of file handles and you'll need to increase their count by executing the following command in Terminal: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
  • Upgrade to latest chokidar, to prevent fsevents-related issues:
    • npm WARN optional dep failed, continuing fsevents@n.n.n
    • TypeError: fsevents is not a constructor

Changelog

  • v4 (Aug 28, 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 30, 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 29, 2017): Globs are now posix-style-only. Tons of bugfixes.
  • v1 (Apr 7, 2015): Glob support, symlink support, tons of bugfixes. Node 0.8+ is supported
  • v0.1 (Apr 20, 2012): Initial release, extracted from Brunch

Details in .github/full_changelog.md.

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.

NPM DownloadsLast 30 Days