npm 中文文档

Chokidar CLI


Build Status

Fast cross-platform command line utility to watch file system changes.

The underlying watch library is Chokidar, which is one of the best watch utilities for Node. Chokidar is battle-tested:

It is used in brunch, gulp, karma, PM2, browserify, webpack, BrowserSync, socketstream, derby, and many others. It has proven itself in production environments.


Prerequisites


Node.js v8.10.0 or newer

Install


If you need it only with npm scripts:

  1. ``` shell
  2. npm install chokidar-cli
  3. ```

Or globally

  1. ``` shell
  2. npm install -g chokidar-cli
  3. ```

Usage


Chokidar can be invoked using the chokidar command, without the -cli suffix.

Arguments use the form of runtime flags with string parameters, delimited by quotes. While in principal both single and double quotes are supported by chokidar-cli, the actual command line argument parsing is dependent on the operating system and shell used; for cross-platform compatibility, use double quotes (with escaping, if necessary), as single quotes are not universally supported by all operating systems.

This is particularly important when using chokidar-cli for run scripts specified in package.json. For maximum platform compatibility, make sure to use escaped double quotes around chokidar's parameters:

  1. ``` json
  2. "run": {
  3.   "chokidar": "chokidar \"**/*.js\" -c \"...\"
  4. },
  5. ```

Default behavior


By default chokidar streams changes for all patterns to stdout:

  1. ``` shell
  2. $ chokidar "**/*.js" "**/*.less"
  3. change:test/dir/a.js
  4. change:test/dir/a.less
  5. add:test/b.js
  6. unlink:test/b.js
  7. ```

Each change is represented with format event:relativepath. Possible events: add, unlink, addDir, unlinkDir, change.

Output only relative paths on each change

  1. ``` shell
  2. $ chokidar "**/*.js" "**/*.less" | cut -d ":" -f 2-
  3. test/dir/a.js
  4. test/dir/a.less
  5. test/b.js
  6. test/b.js
  7. ```

Run npm run build-jswhenever any .js file changes in the current work directory tree

`chokidar "*/.js" -c "npm run build-js"`

Watching in network directories must use polling

`chokidar "*/.less" -c "npm run build-less" --polling`

Pass the path and event details in to your custom command

`chokidar "*/.less" -c "if [ '{event}' = 'change' ]; then npm run build-less -- {path}; fi;"`

Detailed help

  1. ``` sh
  2. Usage: chokidar <pattern> [<pattern>...] [options]

  4. <pattern>:
  5. Glob pattern to specify files to be watched.
  6. Multiple patterns can be watched by separating patterns with spaces.
  7. To prevent shell globbing, write pattern inside quotes.
  8. Guide to globs: https://github.com/isaacs/node-glob#glob-primer

  10. Options:
  11.   -c, --command           Command to run after each change. Needs to be
  12.                           surrounded with quotes when command contains spaces.
  13.                           Instances of `{path}` or `{event}` within the command
  14.                           will be replaced by the corresponding values from the
  15.                           chokidar event.
  16.   -d, --debounce          Debounce timeout in ms for executing command
  17.                                                                   [default: 400]
  18.   -t, --throttle          Throttle timeout in ms for executing command
  19.                                                                   [default: 0]
  20.   -s, --follow-symlinks   When not set, only the symlinks themselves will be
  21.                           watched for changes instead of following the link
  22.                           references and bubbling events through the links path
  23.                                                       [boolean] [default: false]
  24.   -i, --ignore            Pattern for files which should be ignored. Needs to be
  25.                           surrounded with quotes to prevent shell globbing. The
  26.                           whole relative or absolute path is tested, not just
  27.                           filename. Supports glob patterns or regexes using
  28.                           format: /yourmatch/i
  29.   --initial               When set, command is initially run once
  30.                                                       [boolean] [default: false]
  31.   -p, --polling           Whether to use fs.watchFile(backed by polling) instead
  32.                           of fs.watch. This might lead to high CPU utilization.
  33.                           It is typically necessary to set this to true to
  34.                           successfully watch files over a network, and it may be
  35.                           necessary to successfully watch files in other non-
  36.                           standard situations         [boolean] [default: false]
  37.   --poll-interval         Interval of file system polling. Effective when --
  38.                           polling is set                          [default: 100]
  39.   --poll-interval-binary  Interval of file system polling for binary files.
  40.                           Effective when --polling is set         [default: 300]
  41.   --verbose               When set, output is more verbose and human readable.
  42.                                                       [boolean] [default: false]
  43.   --silent                When set, internal messages of chokidar-cli won't be
  44.                           written.                    [boolean] [default: false]
  45.   -h, --help              Show help                                    [boolean]
  46.   -v, --version           Show version number                          [boolean]

  48. Examples:
  49.   chokidar "**/*.js" -c "npm run build-js"  build when any .js file changes
  50.   chokidar "**/*.js" "**/*.less"            output changes of .js and .less
  51.                                             files

  53. ```

License


MIT