Enum FileTypeScope 

pub enum FileTypeScope {
    Metrics,
    All,
    Custom(Vec<String>),
}

Available on crate feature vcs-git only.

Which tracked files the change-history walk ranks (issue #576).

Applied as an additional extension-only filter on top of the --paths / --include / --exclude globs (AND semantics): a file must pass both to be ranked. The check never reads blob content, so a language detected only by an in-file modeline (Emacs / Vim) — never by its extension — is treated as out-of-scope under Metrics; this is the one documented divergence from the content-aware bca metrics walk.

Variants

Metrics

Only files bca computes metrics for — the same set bca metrics would analyze, resolved by extension via get_language_for_file. The default: it keeps the change-history ranking aligned with the AST hotspot tables (which only cover files-with-metrics) and keeps high-churn non-source files (CHANGELOG.md, Cargo.lock, CI config) out of the risk ranking. Extension-less files (Makefile, Dockerfile, LICENSE) and unknown extensions are excluded.

All

Every tracked, non-binary, non-symlink text file — the behaviour before the metrics default was introduced.

Custom(Vec<String>)

A user-supplied allow-list of file extensions, normalised to lowercase with any leading dot stripped (rs, py, toml). A file is in scope iff its lowercased extension is in the list.

Implementations

impl FileTypeScope

pub fn includes(&self, path: &Path) -> bool

Whether path is in scope, judged by extension only (no blob content is read, so this stays a cheap pre-filter on the file enumeration).

Trait Implementations

impl Clone for FileTypeScope

fn clone(&self) -> FileTypeScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileTypeScope

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

Formats the value using the given formatter.

impl Default for FileTypeScope

fn default() -> FileTypeScope

Returns the “default value” for a type.

impl Eq for FileTypeScope

impl FromStr for FileTypeScope

fn from_str(s: &str) -> Result<Self, Error>

Parse the user-facing scope: the keywords metrics / all, or any other value as a comma-separated custom extension list. The single source of truth shared by the CLI (--file-types), the bca.toml [vcs] file_types key, the web front end, and Python.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for FileTypeScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileTypeScope