Watchman

A file watching service.

Purpose

Watchman exists to watch files and record when they actually change. It can also trigger actions (such as rebuilding assets) when matching files change.

Documentation

Head on over to https://facebook.github.io/watchman/

License

Watchman is made available under the terms of the MIT License. See the LICENSE file that accompanies this distribution for the full text of the license.

Support

Watchman is primarily maintained by the source control team at Meta Platforms, Inc. We support:

• Windows and macOS builds
• Linux builds on recent Ubuntu and Fedora releases
• Watchman's compatibility commitment
• Python, Rust, and JavaScript clients

Support for additional operating systems, release packaging, and language bindings is community-maintained:

• Homebrew
• FreeBSD
• Solaris

Please submit a GitHub issue to report any troubles.

Contributing

Please see the contributing guide.

lib.rs:

This crate provides a client to the watchman file watching service.

Start with the Connector struct and use it to connect and return a Client struct, Client::resolve_root to resolve a path and initiate a watch, and then Client::query to perform a query, or Client::subscribe to subscribe to file changes in real time.

This example shows how to connect and expand a glob from the current working directory:

use watchman_client::prelude::*;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let mut client = Connector::new().connect().await?;
  let resolved = client
     .resolve_root(CanonicalPath::canonicalize(".")?)
     .await?;

  // Basic globs -> names
  let files = client.glob(&resolved, &["**/*.rs"]).await?;
  println!("files: {:#?}", files);
  Ok(())
}