Skip to main content

WorktreeWatchConfig

Struct WorktreeWatchConfig 

Source
pub struct WorktreeWatchConfig {
Show 15 fields pub forbidden_paths: Vec<String>, pub forbidden_folders: Vec<String>, pub banned_words: Vec<String>, pub idle_after_seconds: Option<u64>, pub cold_after_seconds: Option<u64>, pub hot_commit_check_seconds: Option<u64>, pub warm_commit_check_seconds: Option<u64>, pub cold_commit_check_seconds: Option<u64>, pub max_commit_checks_per_tick: Option<usize>, pub parent_rescan_seconds: Option<u64>, pub rank_persist_seconds: Option<u64>, pub max_hot_repos: Option<usize>, pub max_fs_watches: Option<usize>, pub spool_retention_days: Option<u64>, pub repo_ranks: Vec<WorktreeWatchRepoRank>,
}
Expand description

Client-side filters + adaptive scheduling for xbp worktree-watch (never sent to the server).

Configured in the global ~/.xbp/config.yaml (or platform equivalent) and in ~/.xbp/.xbp-worktree-ignore (gitignore-style patterns; mcps/ is seeded by default):

worktree_watch:
  forbidden_paths:
    - secrets/
    - apps/web/.env.local
  forbidden_folders:
    - .cache
    - coverage
  banned_words:
    - credential
    - private-key
  # Adaptive resource control (defaults shown)
  idle_after_seconds: 180        # no FS activity → warm
  cold_after_seconds: 600        # no activity → cold (unwatch FS; release Windows locks)
  hot_commit_check_seconds: 12
  warm_commit_check_seconds: 120
  cold_commit_check_seconds: 300
  parent_rescan_seconds: 300
  rank_persist_seconds: 120
  max_hot_repos: 4
  max_fs_watches: 6              # concurrent recursive FS watches (hot+warm budget)
  max_commit_checks_per_tick: 6  # cap git HEAD probes per loop (CPU)
  spool_retention_days: 7        # prune synced jsonl + old .seen markers
  repo_ranks:                    # maintained by the watcher (activity score)
    - root: C:/Users/you/Documents/GitHub/xbp
      score: 12.5
      last_event_at: "2026-07-22T12:00:00Z"
      rank: 1

Fields§

§forbidden_paths: Vec<String>

Relative path prefixes (repo-root relative). Nested under a watched tree is still blocked. Examples: secrets, secrets/, apps/web/.turbo, **/dist is NOT glob — use folder names.

§forbidden_folders: Vec<String>

Directory / path-segment names blocked anywhere in the relative path.

§banned_words: Vec<String>

Case-insensitive substrings; if any appear in the relative path, the path is ignored.

§idle_after_seconds: Option<u64>

Seconds without FS mutations before a repo cools from hot → warm (default 180).

§cold_after_seconds: Option<u64>

Seconds without activity before warm → cold (unwatch FS handles; default 600).

§hot_commit_check_seconds: Option<u64>

How often to poll git rev-parse HEAD for hot repos (default 12).

§warm_commit_check_seconds: Option<u64>

Commit check interval for warm repos (default 120).

§cold_commit_check_seconds: Option<u64>

Commit check interval for cold repos (default 300).

§max_commit_checks_per_tick: Option<usize>

Max git HEAD probes per watch loop tick under a parent cover (default 6). Caps CPU when dozens of warm repos would otherwise all fire at once.

§parent_rescan_seconds: Option<u64>

Discover new/vanished repos under a parent cover (default 180).

§rank_persist_seconds: Option<u64>

How often to write repo_ranks back into global config (default 60).

§max_hot_repos: Option<usize>

Cap how many repos stay in the hot tier at once (default 6).

§max_fs_watches: Option<usize>

Max concurrent recursive filesystem watches under a parent cover (default 8). Hot repos are preferred; remaining budget goes to highest-score warm repos.

§spool_retention_days: Option<u64>

Days to keep .synced.*.jsonl and old dedupe .seen markers (default 7).

§repo_ranks: Vec<WorktreeWatchRepoRank>

Activity ranking (highest score first). Updated by the watcher.

Implementations§

Source§

impl WorktreeWatchConfig

Source

pub fn idle_after_seconds(&self) -> u64

Source

pub fn cold_after_seconds(&self) -> u64

Source

pub fn hot_commit_check_seconds(&self) -> u64

Source

pub fn warm_commit_check_seconds(&self) -> u64

Source

pub fn cold_commit_check_seconds(&self) -> u64

Source

pub fn parent_rescan_seconds(&self) -> u64

Source

pub fn rank_persist_seconds(&self) -> u64

Source

pub fn max_hot_repos(&self) -> usize

Source

pub fn max_fs_watches(&self) -> usize

Concurrent recursive FS watches under a parent cover (default 6).

Source

pub fn max_commit_checks_per_tick(&self) -> usize

Max git HEAD probes per parent-watch loop iteration (default 6).

Source

pub fn spool_retention_days(&self) -> u64

Trait Implementations§

Source§

impl Clone for WorktreeWatchConfig

Source§

fn clone(&self) -> WorktreeWatchConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WorktreeWatchConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for WorktreeWatchConfig

Source§

fn default() -> WorktreeWatchConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WorktreeWatchConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for WorktreeWatchConfig

Source§

fn eq(&self, other: &WorktreeWatchConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for WorktreeWatchConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for WorktreeWatchConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more