feat(fs-index): push watch API dependencies behind a feature flag

Signed-off-by: Tarek <[email protected]>

ark-cli/Cargo.toml

@@ -26,7 +26,7 @@ lazy_static = "1.4.0"
 canonical-path = "2.0.2"
 
 
-fs-index = { path = "../fs-index" }
+fs-index = { path = "../fs-index", features = ["watch"] }
 fs-atomic-versions = { path = "../fs-atomic-versions" }
 fs-metadata = { path = "../fs-metadata" }
 fs-properties = { path = "../fs-properties" }

fs-index/Cargo.toml

@@ -15,18 +15,22 @@ anyhow = "1.0.58"
 serde_json = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 # For the watch API
-notify = "6.1"
-notify-debouncer-full = "0.3"
-futures = "0.3"
-async-stream = "0.3"
-tokio = { version = "1.40", features = ["full"] }
+notify = { version = "6.1", optional = true }
+notify-debouncer-full = { version = "0.3", optional = true }
+futures = { version = "0.3", optional = true }
+async-stream = { version = "0.3", optional = true }
+tokio = { version = "1.40", features = ["full"], optional = true }
 
 
 fs-storage = { path = "../fs-storage" }
 
 data-error = { path = "../data-error" }
 data-resource = { path = "../data-resource" }
 
+
+[features]
+watch = ["notify", "notify-debouncer-full", "futures", "async-stream", "tokio"]
+
 [dev-dependencies]
 uuid = { version = "1.6.1", features = ["v4"] }
 # benchmarking

fs-index/README.md

@@ -15,7 +15,7 @@ The most important struct in this crate is `ResourceIndex` which comes with:
   - `get_resource_by_path`: Query a resource from the index by its path.
 - **Selective API**
   - `update_one`: Method to manually update a specific resource by selectively rescanning a single file.
-- **Watch API**
+- **Watch API** (Enable with `watch` feature)
   - `watch`: Method to watch a directory for changes and update the index accordingly.
 
 > **Note:** To see the watch API in action, run the `index_watch` example or check `ark-cli watch` command.

fs-index/src/lib.rs

@@ -1,10 +1,12 @@
 mod index;
 mod serde;
 mod utils;
+#[cfg(feature = "watch")]
 mod watch;
 
 pub use index::{IndexUpdate, ResourceIndex};
 pub use utils::load_or_build_index;
+#[cfg(feature = "watch")]
 pub use watch::{watch_index, WatchEvent};
 
 #[cfg(test)]