Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 08-Aug-2017 | - | ||||
bser/ | H | 03-May-2022 | - | 116 | 89 | |
README.md | H A D | 08-Aug-2017 | 1.2 KiB | 35 | 24 | |
package.json | H A D | 08-Aug-2017 | 708 | 36 | 35 |
README.md
1# fb-watchman 2 3`fb-watchman` is a filesystem watcher that uses the 4[Watchman](https://facebook.github.io/watchman/) file watching service from 5Facebook. 6 7Watchman provides file change notification services using very 8efficient recursive watches and also allows more advanced change matching and 9filesystem tree querying operations using 10[a powerful expression syntax](https://facebook.github.io/watchman/docs/file-query.html#expressions). 11 12## Install 13 14You should [install Watchman]( 15https://facebook.github.io/watchman/docs/install.html) to make the most of this 16module. 17 18Then simply: 19 20``` 21$ npm install fb-watchman 22``` 23 24## Key Concepts 25 26- Watchman recursively watches directories. 27- Each watched directory is called a `root`. 28- You must initiate a `watch` on a `root` using the `watch-project` command prior to subscribing to changes 29- Rather than separately watching many sibling directories, `watch-project` consolidates and re-uses existing watches relative to a project root (the location of your `.watchmanconfig` or source control repository root) 30- change notifications are relative to the project root 31 32## How do I use it? 33 34[Read the NodeJS watchman documentation](https://facebook.github.io/watchman/docs/nodejs.html) 35