Skip to main content

build_missing_summary_report

Function build_missing_summary_report 

Source
pub fn build_missing_summary_report(
    root: &Path,
    threshold: usize,
    filenames: &[String],
    paths: &[String],
    walk_config: &WalkConfig,
) -> MissingSummaryReport
Expand description

Build a MissingSummaryReport by walking the repository under root and checking each directory for a doc file that is present (committed at least once).

filenames lists the candidate doc filenames (e.g. ["SUMMARY.md", "CLAUDE.md"]). A directory is compliant when it has any of those files (OR semantics). Pass an empty slice to fall back to DEFAULT_FILENAMES.

paths is a list of glob patterns; only directories matching one of the patterns are checked. An empty paths slice means the rule applies to every directory (default behavior).

Directories that have never had a doc file committed are reported as missing when the total commit count (plus any uncommitted content changes) exceeds threshold.