Skip to main content

Module options

Module options 

Source
Available on crate feature vcs-git only.
Expand description

Configuration for a change-history walk.

Options is a plain data struct: the CLI / web / Python layers fill it in from user input, and build_history_index consumes it. Time windows are stored already resolved to seconds so the generic core never re-parses user duration strings; the parse_window helper is exposed for those front ends to perform that resolution (and to surface a typed Error on bad input).

Structs§

Options
Configuration for a single change-history walk.

Enums§

FileTypeScope
Which tracked files the change-history walk ranks (issue #576).
RiskFormula
Which composite risk-score formula to apply.

Constants§

DEFAULT_BOT_PATTERN
Default bot-author exclusion pattern (case-insensitive, matched as a substring against both the canonical author name and email). The [bot] suffixes are regex-escaped. Mirrors the well-known automation identities called out in issue #328.
DEFAULT_BUS_FACTOR_THRESHOLD
Default bus-factor coverage (abandonment) threshold (0.5, per Avelino). Re-exported from the bus-factor module so the front ends share one source of truth for the default and the validation bound.
DEFAULT_LONG_WINDOW
Default long window (12mo ≈ 365 days).
DEFAULT_RECENT_WINDOW
Default recent window (90d).

Functions§

parse_window
Parse a human time-window string into seconds.
validate_bus_factor_threshold
Validate a bus-factor coverage threshold, accepting only a finite value in the open interval (0, 1).