Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 919 Bytes

README.md

File metadata and controls

45 lines (30 loc) · 919 Bytes

watch-detector

Build Status

Utility for selecting the best options for sane:

watcher options:

  • watchman: if a valid version of watchman is installed, we will prefer this.
  • node: use node's built in watcher, if watchman is not present.

future options:

  • fs-events: #6

usage

yarn add watch-detector
const WatchDetector = require('watch-detector');
const sane = require('sane');

let detector = new WatchDetector();
let saneOptions = {
  /* sane options */
};

let options = detector.findBestWatcherOption(saneOptions)
/* options's watcher selection will be based on various heuristics */
sane(root, options);

optional

new WatchDetector({
  ui: /* console-ui instance */,
  fs: /* fs instance */
});