Skip to main content

FallowConfig

Struct FallowConfig 

Source
pub struct FallowConfig {
Show 34 fields pub schema: Option<String>, pub extends: Vec<String>, pub entry: Vec<String>, pub ignore_patterns: Vec<String>, pub framework: Vec<ExternalPluginDef>, pub workspaces: Option<WorkspaceConfig>, pub ignore_dependencies: Vec<String>, pub ignore_unresolved_imports: Vec<String>, pub ignore_exports: Vec<IgnoreExportRule>, pub ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>, pub ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>, pub ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig, pub ignore_decorators: Vec<String>, pub used_class_members: Vec<UsedClassMemberRule>, pub duplicates: DuplicatesConfig, pub health: HealthConfig, pub rules: RulesConfig, pub boundaries: BoundaryConfig, pub flags: FlagsConfig, pub security: SecurityConfig, pub fix: FixConfig, pub resolve: ResolveConfig, pub production: ProductionConfig, pub plugins: Vec<String>, pub dynamically_loaded: Vec<String>, pub overrides: Vec<ConfigOverride>, pub codeowners: Option<String>, pub public_packages: Vec<String>, pub regression: Option<RegressionConfig>, pub audit: AuditConfig, pub sealed: bool, pub include_entry_exports: bool, pub auto_imports: bool, pub cache: CacheConfig,
}

Fields§

§schema: Option<String>§extends: Vec<String>§entry: Vec<String>§ignore_patterns: Vec<String>§framework: Vec<ExternalPluginDef>§workspaces: Option<WorkspaceConfig>§ignore_dependencies: Vec<String>§ignore_unresolved_imports: Vec<String>§ignore_exports: Vec<IgnoreExportRule>§ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>§ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>§ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig§ignore_decorators: Vec<String>§used_class_members: Vec<UsedClassMemberRule>§duplicates: DuplicatesConfig§health: HealthConfig§rules: RulesConfig§boundaries: BoundaryConfig§flags: FlagsConfig§security: SecurityConfig§fix: FixConfig§resolve: ResolveConfig§production: ProductionConfig§plugins: Vec<String>§dynamically_loaded: Vec<String>§overrides: Vec<ConfigOverride>§codeowners: Option<String>§public_packages: Vec<String>§regression: Option<RegressionConfig>§audit: AuditConfig§sealed: bool§include_entry_exports: bool§auto_imports: bool§cache: CacheConfig

Implementations§

Source§

impl FallowConfig

Source

pub fn load(path: &Path) -> Result<Self, Report>

Load config from a fallow config file (TOML or JSON/JSONC).

The format is detected from the file extension:

  • .toml → TOML
  • .json → JSON (with JSONC comment stripping)

Supports extends for config inheritance. Extended configs are loaded and deep-merged before this config’s values are applied.

User-supplied glob patterns (entry, ignorePatterns, dynamicallyLoaded, duplicates.ignore, health.ignore, boundaries.zones[].patterns, overrides[].files, ignoreExports[].file, ignoreCatalogReferences[].consumer) are validated against absolute paths, .. traversal segments, and invalid glob syntax. Loading fails loud on any rejection so silent no-match configs surface to the user. See issue #463.

§Errors

Returns an error when the config file cannot be read, merged, or deserialized, or when any user-supplied glob pattern is rejected.

Source

pub fn validate_user_globs(&self) -> Result<(), Vec<GlobValidationError>>

Validate all user-supplied glob patterns and directory paths in this config.

Accumulates errors from every glob- or path-bearing field so the user sees ALL offending values in one run rather than fixing them one at a time.

Covered filesystem glob fields: entry, ignorePatterns, dynamicallyLoaded, duplicates.ignore, health.ignore, overrides[].files, ignoreExports[].file, ignoreCatalogReferences[].consumer, boundaries.zones[].patterns, plus every glob-bearing field on inline framework[] plugin definitions (entry points, always-used, config patterns, used-exports patterns, and fileExists detection patterns; the last reaches glob::glob on disk so a .. segment there is a real path traversal).

Covered specifier glob fields: ignoreUnresolvedImports. These match raw import strings, so parent-relative specifiers like ../generated/** are valid and only glob syntax is checked.

Covered directory-path fields: boundaries.zones[].root and boundaries.zones[].autoDiscover. These are literal paths (not globs), so only the absolute-path + traversal checks apply.

§Errors

Returns a non-empty Vec of glob_validation::GlobValidationError when any field contains a rejected value.

Source

pub fn find_config_path(start: &Path) -> Option<PathBuf>

Find the config file path without loading it. Searches the same locations as find_and_load.

Source

pub fn find_and_load(start: &Path) -> Result<Option<(Self, PathBuf)>, String>

Find and load config, searching from start up to the project root.

§Errors

Returns an error if a config file is found but cannot be read or parsed.

Source

pub fn json_schema() -> Value

Generate JSON Schema for the configuration format.

Source

pub fn validate_resolved_boundaries( &self, root: &Path, ) -> Result<(), Vec<ZoneValidationError>>

Validate boundary zone references and zone-root-prefix conflicts AFTER preset and auto-discover expansion.

Runs the same expand sequence as FallowConfig::resolve (preset expansion gated on tsconfig rootDir, then expand_auto_discover) before invoking BoundaryConfig::validate_zone_references and BoundaryConfig::validate_root_prefixes, so Bulletproof-style presets whose authored rule references logical groups (features) still load cleanly.

Call sites (runtime_support::load_config_for_analysis in the CLI, core::lib::config_for_project for LSP and programmatic embedders) surface every collected error in a single rendered diagnostic, then exit with code 2. Previously these failures emitted tracing::error! and continued, producing a flood of false-positive boundary violations at analysis time (#468).

root is the project root used by expand_auto_discover to scan for child directories. Caller is responsible for passing the same root it later hands to resolve().

§Errors

Returns a non-empty Vec<ZoneValidationError> aggregating every offending zone reference and redundant-root-prefix pattern; the empty case becomes Ok(()).

Source§

impl FallowConfig

Source

pub fn resolve( self, root: PathBuf, output: OutputFormat, threads: usize, no_cache: bool, quiet: bool, cache_max_size_mb: Option<u32>, ) -> ResolvedConfig

Resolve into a fully resolved config with compiled globs.

Trait Implementations§

Source§

impl Debug for FallowConfig

Source§

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

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

impl Default for FallowConfig

Source§

fn default() -> FallowConfig

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

impl<'de> Deserialize<'de> for FallowConfig

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 JsonSchema for FallowConfig

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Serialize for FallowConfig

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

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<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<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
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<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