Struct WalkConfig 

pub struct WalkConfig {
    pub ignore_files: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
}

Configuration for directory walking behavior.

Controls which ignore files are respected and which directories are always excluded. Deserialized from [walk] in .normalize/config.toml.

[walk]
ignore_files = [".gitignore"]   # default
exclude = []                    # default (empty); `normalize init` seeds [".git/"]

Fields

ignore_files: Option<Vec<String>>

List of gitignore-format files to respect. Default: [".gitignore"]. Set to [] to disable gitignore-based exclusion entirely.

exclude: Option<Vec<String>>

Additional gitignore-style patterns to always skip. Default: empty (per Rust Default convention — opinions live in [crate::NormalizeConfig::bootstrap] in the main crate, which seeds [".git/"] for new projects).

Patterns use the same syntax as .gitignore:

• A pattern with no slash (e.g. node_modules, .git) matches any directory or file with that basename, at any depth.
• A pattern with a slash (e.g. crates/foo/build/, **/target/) is anchored relative to the project root.
• Trailing / restricts the match to directories.
• ** matches any number of path segments.

Implementations

impl WalkConfig

pub fn ignore_files(&self) -> Vec<&str>

Returns the ignore files to respect, defaulting to [".gitignore"].

pub fn exclude(&self) -> Vec<&str>

Returns the directory patterns to exclude. Empty when no patterns are configured — Default is empty per Rust convention. Opinions like “always exclude .git/” belong in a typed bootstrap constructor on the owning config (see NormalizeConfig::bootstrap), not here.

pub fn compiled_excludes(&self, root: &Path) -> Gitignore

Compile the configured exclude patterns into a gitignore matcher anchored at root.

Returns an empty matcher if no patterns are configured. Invalid patterns are silently dropped (consistent with how .gitignore itself behaves).

pub fn is_excluded_path( &self, root: &Path, rel_path: &Path, is_dir: bool, ) -> bool

Check whether a path (relative to root) matches any exclude pattern.

is_dir distinguishes directories from files (relevant for trailing-/ patterns). For repeat queries, prefer building [compiled_excludes] once and querying it directly; this method is a convenience for one-shot checks.

Trait Implementations

impl Clone for WalkConfig

fn clone(&self) -> WalkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalkConfig

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

Formats the value using the given formatter.

impl Default for WalkConfig

fn default() -> WalkConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WalkConfig

where WalkConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WalkConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Merge for WalkConfig

fn merge(self, other: Self) -> Self

impl Serialize for WalkConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.