chokidar
npmv5.0.0TypeScriptMinimal and efficient cross-platform file watching library
Safe to adopt
Yes — chokidar scores well across adoption, maintenance, weight, supply chain, and licensing. No download data reported for this package yet. Last published 288 days ago. 5 releases in the last 2 years.
- ?Adoption: grade ?, Not reported by this registry.
No download data reported for this package yet.
- BMaintenance: grade B, Good.
Last published 288 days ago. 5 releases in the last 2 years.
- AWeight: grade A, Excellent.
Pulls in 1 transitive package, about 80 KB installed (at least — some of the tree is still being crawled).
- BSupply chain: grade B, Good.
This package has a single maintainer (bus factor of 1).
- ALicense: grade A, Excellent.
MIT — permissive, with no copyleft found in the dependency tree.
Grades are computed deterministically from registry metadata collected by PackageGraph — downloads, dependents, publish dates, the resolved dependency tree, maintainer count, and declared licenses. No third-party scores are used.
Install cost
What you actually take on by adding chokidar to a project.
Runtime packages this one declares itself.
Distinct packages in the full runtime tree, deduplicated the way a package manager would.
Unpacked size of this package plus its entire runtime tree.
Longest resolved dependency chain below this package.
Part of this dependency tree has not been crawled yet, so these figures are a lower bound rather than a final total.
Compatibility
- Node.js
- node >= 20.19.0
- Module format
- ESM only
- TypeScript
- Types included
- Install scripts
- None
Quick start
A usage example from the chokidar README.
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,chokidar vs the alternatives
Packages solving a similar problem in the npm ecosystem, compared on the signals that drive an adoption decision.
| Package | Weekly downloads | Dependents | License | Last release |
|---|---|---|---|---|
| chokidarthis page | 0 | 3 | MIT | 9 months ago |
| fb-watchman | 0 | 3 | Apache-2.0 | 1 day ago |
| normalize-path | 72.6M | 1 | MIT | 1 day ago |
| anymatch | 0 | 1 | ISC | 1 day ago |
| callsites | 136.7M | 1 | MIT | 1 day ago |
| mime | 136.4M | 6 | MIT | 1 day ago |
Dependencies
Declared by chokidar v5.0.0. Runtime dependencies are installed with the package; dev dependencies are not.
Runtime (1)
Dev (6)
Used by
Popular packages that depend on chokidar.
Relationship graph
Dependencies (left) and dependents (right) of chokidar.
Frequently installed together
An extremely fast JavaScript and CSS bundler and minifier.
Generates and consumes source maps
A native C++ Node module for querying and subscribing to filesystem events. Used by Parcel 2.
Immutable Data Collections
Node.js library that communicates with Embedded Dart Sass using the Embedded Sass protocol
Vite DevTools
A pure JavaScript implementation of Sass.
TypeScript Execute (tsx): Node.js enhanced with esbuild to run TypeScript & ESM files
TypeScript definitions for node
Tool for transforming styles with JS plugins
JavaScript parser and stringifier for YAML
Open stuff like URLs, files, executables. Cross-platform.
Release history
3 releases in the last two years, typically about 68 days apart.
| Version | Published | Size | License |
|---|---|---|---|
| 5.0.0latest | 9 months ago | 80 KB | MIT |
| 4.0.3 | 1 year ago | 145 KB | MIT |
| 4.0.2 | 1 year ago | 145 KB | MIT |
| 4.0.1 | 1 year ago | 251 KB | MIT |
| 4.0.0 | 2 years ago | 250 KB | MIT |
| 3.6.0 | 2 years ago | 88 KB | MIT |
| 3.5.3 | 4 years ago | 88 KB | MIT |
| 3.5.2 | 5 years ago | 88 KB | MIT |
| 3.5.1 | 5 years ago | 87 KB | MIT |
| 3.5.0 | 5 years ago | 87 KB | MIT |
| 3.4.3 | 5 years ago | 88 KB | MIT |
| 3.4.2 | 6 years ago | 88 KB | MIT |
| 3.4.1 | 6 years ago | 87 KB | MIT |
| 3.4.0 | 6 years ago | 87 KB | MIT |
| 3.3.1 | 6 years ago | 86 KB | MIT |
Overview
chokidar is an npm package that minimal and efficient cross-platform file watching library. It has 3 known dependents in the graph. The latest version is 5.0.0, released under the MIT license.
Who should use it
Teams working in the npm ecosystem who need minimal and efficient cross-platform file watching library and value a focused solution.
When not to use it
Consider an alternative if you need to or if a more actively-maintained option better fits your npm stack.
Pros
- Ships TypeScript type definitions.
- Clear open-source license (MIT).
Cons
- No significant drawbacks detected from available metadata.
Auto-generated from collected registry metadata. No external claims are inferred.
Maintainers
Funding
Frequently asked questions
Should I use chokidar?
Yes — chokidar scores well across adoption, maintenance, weight, supply chain, and licensing. No download data reported for this package yet. Last published 288 days ago. 5 releases in the last 2 years.
How do I install chokidar?
Run `npm install chokidar` to add chokidar to your npm project.
How many dependencies does chokidar have?
chokidar declares 7 direct dependencies and pulls in 1 packages in total once its runtime tree is resolved totalling about 80 KB on disk.
What license is chokidar released under?
chokidar is distributed under the MIT license.
How popular is chokidar?
npm does not publish download counts. Within PackageGraph's crawl, 3 known packages depend on chokidar.
Is chokidar still maintained?
The most recent release of chokidar (v5.0.0) was published 9 months ago.
Does chokidar run install scripts?
No. chokidar does not define preinstall, install, or postinstall scripts, so installing it does not execute publisher-supplied code.