fs-extra vs chokidar vs watchpack vs fsevents vs gaze vs node-watch
File Watching and Management Libraries Comparison
1 Year
fs-extrachokidarwatchpackfseventsgazenode-watchSimilar Packages:
What's File Watching and Management Libraries?

These libraries provide functionality for monitoring file system changes, enabling developers to build applications that respond to file modifications in real-time. They are essential for tasks such as live reloading during development, automated build processes, and file synchronization. Each library has its own strengths and use cases, catering to different needs in file watching and management.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
fs-extra104,758,2229,52455.3 kB15a month agoMIT
chokidar64,004,48111,225149 kB242 months agoMIT
watchpack27,163,13938156.4 kB146 months agoMIT
fsevents23,236,328572173 kB11a year agoMIT
gaze2,418,7141,153-697 years agoMIT
node-watch584,82734126.1 kB62 years agoMIT
Feature Comparison: fs-extra vs chokidar vs watchpack vs fsevents vs gaze vs node-watch

Performance

  • fs-extra:

    fs-extra's performance is generally tied to the native fs module, but it adds overhead due to its additional features. It is suitable for tasks that require extended functionalities rather than raw performance.

  • chokidar:

    Chokidar is highly optimized for performance, using native file system events where available and falling back to polling when necessary. This makes it capable of handling thousands of files efficiently without consuming excessive resources.

  • watchpack:

    Watchpack is optimized for build systems and can efficiently handle file changes in large projects, making it suitable for applications that require real-time updates during development.

  • fsevents:

    fsevents provides excellent performance on macOS by leveraging native APIs for file system notifications, making it the fastest option for file watching on that platform.

  • gaze:

    Gaze is lightweight and performs well for small to medium-sized projects. However, it may not be as efficient as Chokidar for larger file sets due to its reliance on polling for changes.

  • node-watch:

    node-watch is designed to be simple and effective for basic file watching needs. Its performance is adequate for smaller projects, but it may struggle with larger directories due to its polling mechanism.

Cross-Platform Support

  • fs-extra:

    fs-extra is also cross-platform, providing consistent file system functionalities regardless of the operating system.

  • chokidar:

    Chokidar works seamlessly across all major platforms (Windows, macOS, Linux), making it a versatile choice for cross-platform applications.

  • watchpack:

    Watchpack is designed to work across platforms, making it suitable for projects that need to support various operating systems.

  • fsevents:

    fsevents is specific to macOS and is not available on other platforms. It is primarily used for optimizing file watching on macOS systems.

  • gaze:

    Gaze supports multiple platforms, but its performance may vary depending on the underlying file system event support on each OS.

  • node-watch:

    node-watch is cross-platform and works on Windows, macOS, and Linux, making it a good choice for applications targeting multiple environments.

Ease of Use

  • fs-extra:

    fs-extra is user-friendly and extends the native fs module, making it easy for developers familiar with fs to adopt its additional functionalities.

  • chokidar:

    Chokidar has a straightforward API that makes it easy to set up and use for file watching tasks, with extensive documentation to assist developers.

  • watchpack:

    Watchpack has a more complex API due to its advanced features, which may require a steeper learning curve for developers new to file watching.

  • fsevents:

    fsevents is a lower-level library that may require more understanding of file system events, making it less user-friendly for those unfamiliar with native APIs.

  • gaze:

    Gaze is known for its simplicity and ease of use, making it a great choice for developers looking for a quick solution to monitor file changes without complex configurations.

  • node-watch:

    node-watch is very simple to use, with minimal setup required, making it ideal for quick implementations of file watching.

Use Cases

  • fs-extra:

    fs-extra is best suited for file management tasks that require additional methods, such as copying, moving, and removing files and directories.

  • chokidar:

    Chokidar is ideal for applications that require real-time file watching, such as live-reloading web development tools and build systems.

  • watchpack:

    Watchpack is designed for build tools and applications that need to efficiently monitor large sets of files for changes, making it ideal for Webpack and similar systems.

  • fsevents:

    fsevents is perfect for macOS applications that need to respond to file system changes quickly and efficiently, especially in development environments.

  • gaze:

    Gaze is suitable for smaller projects or when a simple file watching solution is needed without the overhead of more complex libraries.

  • node-watch:

    node-watch is great for basic file monitoring tasks, such as watching configuration files or assets that trigger rebuilds in development.

Community and Support

  • fs-extra:

    fs-extra is well-supported with a strong community, and its documentation is comprehensive, making it easy for developers to find help.

  • chokidar:

    Chokidar has a large and active community, providing extensive support and resources for developers. It is widely used in the Node.js ecosystem.

  • watchpack:

    Watchpack benefits from being part of the Webpack ecosystem, which has a large community and extensive support resources available.

  • fsevents:

    fsevents has a smaller community due to its platform-specific nature, but it is well-documented for macOS developers.

  • gaze:

    Gaze has a moderate community presence, and while it may not have as much support as larger libraries, it is still well-documented for basic use cases.

  • node-watch:

    node-watch has a smaller community, which may limit available resources, but it is straightforward enough that many developers can implement it without extensive support.

How to Choose: fs-extra vs chokidar vs watchpack vs fsevents vs gaze vs node-watch
  • fs-extra:

    Select fs-extra if you need extended file system methods that are not available in the native fs module. It provides additional functionalities like recursive directory creation and file copying, which can simplify file management tasks in your application.

  • chokidar:

    Choose Chokidar for its efficiency and performance in watching file changes. It is designed to handle large numbers of files and directories with minimal resource usage, making it ideal for applications that require high performance and scalability.

  • watchpack:

    Select Watchpack if you are working with Webpack or need a more advanced file watching solution. It is designed to work well with build systems and can efficiently handle file changes in large projects.

  • fsevents:

    Opt for fsevents if you are developing on macOS and require low-level file system event notifications. It is optimized for macOS and can provide better performance for file watching on that platform compared to other libraries.

  • gaze:

    Use Gaze for its simplicity and ease of use. It is a lightweight solution for monitoring file changes and is suitable for smaller projects or when you need a straightforward implementation without complex configurations.

  • node-watch:

    Choose node-watch for a minimalistic approach to file watching. It is easy to set up and works well for basic file monitoring needs without the overhead of more complex libraries.

README for fs-extra

Node.js: fs-extra

fs-extra adds file system methods that aren't included in the native fs module and adds promise support to the fs methods. It also uses graceful-fs to prevent EMFILE errors. It should be a drop in replacement for fs.

npm Package License build status downloads per month JavaScript Style Guide

Why?

I got tired of including mkdirp, rimraf, and ncp in most of my projects.

Installation

npm install fs-extra

Usage

CommonJS

fs-extra is a drop in replacement for native fs. All methods in fs are attached to fs-extra. All fs methods return promises if the callback isn't passed.

You don't ever need to include the original fs module again:

const fs = require('fs') // this is no longer necessary

you can now do this:

const fs = require('fs-extra')

or if you prefer to make it clear that you're using fs-extra and not fs, you may want to name your fs variable fse like so:

const fse = require('fs-extra')

you can also keep both, but it's redundant:

const fs = require('fs')
const fse = require('fs-extra')

ESM

There is also an fs-extra/esm import, that supports both default and named exports. However, note that fs methods are not included in fs-extra/esm; you still need to import fs and/or fs/promises seperately:

import { readFileSync } from 'fs'
import { readFile } from 'fs/promises'
import { outputFile, outputFileSync } from 'fs-extra/esm'

Default exports are supported:

import fs from 'fs'
import fse from 'fs-extra/esm'
// fse.readFileSync is not a function; must use fs.readFileSync

but you probably want to just use regular fs-extra instead of fs-extra/esm for default exports:

import fs from 'fs-extra'
// both fs and fs-extra methods are defined

Sync vs Async vs Async/Await

Most methods are async by default. All async methods will return a promise if the callback isn't passed.

Sync methods on the other hand will throw if an error occurs.

Also Async/Await will throw an error if one occurs.

Example:

const fs = require('fs-extra')

// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
  .then(() => console.log('success!'))
  .catch(err => console.error(err))

// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// Sync:
try {
  fs.copySync('/tmp/myfile', '/tmp/mynewfile')
  console.log('success!')
} catch (err) {
  console.error(err)
}

// Async/Await:
async function copyFiles () {
  try {
    await fs.copy('/tmp/myfile', '/tmp/mynewfile')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

copyFiles()

Methods

Async

Sync

NOTE: You can still use the native Node.js methods. They are promisified and copied over to fs-extra. See notes on fs.read(), fs.write(), & fs.writev()

What happened to walk() and walkSync()?

They were removed from fs-extra in v2.0.0. If you need the functionality, walk and walkSync are available as separate packages, klaw and klaw-sync.

Third Party

CLI

fse-cli allows you to run fs-extra from a console or from npm scripts.

TypeScript

If you like TypeScript, you can use fs-extra with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra

File / Directory Watching

If you want to watch for changes to files or directories, then you should use chokidar.

Obtain Filesystem (Devices, Partitions) Information

fs-filesystem allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.

Misc.

Hacking on fs-extra

Wanna hack on fs-extra? Great! Your help is needed! fs-extra is one of the most depended upon Node.js packages. This project uses JavaScript Standard Style - if the name or style choices bother you, you're gonna have to get over it :) If standard is good enough for npm, it's good enough for fs-extra.

js-standard-style

What's needed?

  • First, take a look at existing issues. Those are probably going to be where the priority lies.
  • More tests for edge cases. Specifically on different platforms. There can never be enough tests.
  • Improve test coverage.

Note: If you make any big changes, you should definitely file an issue for discussion first.

Running the Test Suite

fs-extra contains hundreds of tests.

  • npm run lint: runs the linter (standard)
  • npm run unit: runs the unit tests
  • npm run unit-esm: runs tests for fs-extra/esm exports
  • npm test: runs the linter and all tests

When running unit tests, set the environment variable CROSS_DEVICE_PATH to the absolute path of an empty directory on another device (like a thumb drive) to enable cross-device move tests.

Windows

If you run the tests on the Windows and receive a lot of symbolic link EPERM permission errors, it's because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7 However, I didn't have much luck doing this.

Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows. I open the Node.js command prompt and run as Administrator. I then map the network drive running the following command:

net use z: "\\vmware-host\Shared Folders"

I can then navigate to my fs-extra directory and run the tests.

Naming

I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:

  • https://github.com/jprichardson/node-fs-extra/issues/2
  • https://github.com/flatiron/utile/issues/11
  • https://github.com/ryanmcgrath/wrench-js/issues/29
  • https://github.com/substack/node-mkdirp/issues/17

First, I believe that in as many cases as possible, the Node.js naming schemes should be chosen. However, there are problems with the Node.js own naming schemes.

For example, fs.readFile() and fs.readdir(): the F is capitalized in File and the d is not capitalized in dir. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: fs.mkdir(), fs.rmdir(), fs.chown(), etc.

We have a dilemma though. How do you consistently name methods that perform the following POSIX commands: cp, cp -r, mkdir -p, and rm -rf?

My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too.

So, if you want to remove a file or a directory regardless of whether it has contents, just call fs.remove(path). If you want to copy a file or a directory whether it has contents, just call fs.copy(source, destination). If you want to create a directory regardless of whether its parent directories exist, just call fs.mkdirs(path) or fs.mkdirp(path).

Credit

fs-extra wouldn't be possible without using the modules from the following authors:

License

Licensed under MIT

Copyright (c) 2011-2024 JP Richardson