Skip to main content

HealthExecutionOptions

Struct HealthExecutionOptions 

Source
pub struct HealthExecutionOptions<'a> {
Show 51 fields pub root: &'a Path, pub config_path: &'a Option<PathBuf>, pub output: OutputFormat, pub no_cache: bool, pub threads: usize, pub quiet: bool, pub complexity_breakdown: bool, pub thresholds: HealthThresholdOverrides, pub top: Option<usize>, pub sort: HealthSort, pub production: bool, pub production_override: Option<bool>, pub allow_remote_extends: bool, pub changed_since: Option<&'a str>, pub diff_index: Option<&'a DiffIndex>, pub use_shared_diff_index: bool, pub workspace: Option<&'a [String]>, pub changed_workspaces: Option<&'a str>, pub scope: Option<PathBuf>, pub baseline: Option<&'a Path>, pub save_baseline: Option<&'a Path>, pub baseline_mode: HealthBaselineMode, pub baseline_mode_explicit: bool, pub complexity: bool, pub file_scores: bool, pub coverage_gaps: bool, pub config_activates_coverage_gaps: bool, pub hotspots: bool, pub ownership: bool, pub ownership_emails: Option<EmailMode>, pub targets: bool, pub css: bool, pub css_deep: bool, pub force_full: bool, pub score_only_output: bool, pub enforce_coverage_gap_gate: bool, pub effort: Option<EffortEstimate>, pub score: bool, pub gates: HealthGateOptions, pub since: Option<&'a str>, pub min_commits: Option<u32>, pub explain: bool, pub summary: bool, pub save_snapshot: Option<PathBuf>, pub trend: bool, pub coverage_inputs: HealthCoverageInputs<'a>, pub performance: bool, pub runtime_coverage: Option<RuntimeCoverageOptions>, pub churn_file: Option<&'a Path>, pub analysis_identity: SemanticAnalysisIdentity, pub group_by: Option<GroupByMode>,
}
Expand description

Command-neutral inputs needed to execute a health analysis.

These fields are shared runner inputs rather than rendering concerns.

Fields§

§root: &'a Path

Project root to analyze.

§config_path: &'a Option<PathBuf>

Explicit config file path; None triggers automatic discovery.

§output: OutputFormat

Output format of the run; badge output implies the score section.

§no_cache: bool

Bypass the parse cache for this run.

§threads: usize

Worker thread count for parsing and analysis.

§quiet: bool

Suppress progress notes on stderr.

§complexity_breakdown: bool

Include per-decision-point complexity contributions in typed findings.

This changes the produced health result shape, so it belongs to the runner input contract rather than CLI rendering options.

§thresholds: HealthThresholdOverrides

Complexity threshold overrides on top of the resolved config.

§top: Option<usize>

Cap on rendered findings per section.

§sort: HealthSort

Sort criteria for complexity findings.

§production: bool

Raw production-only request flag; folded into production_override when the tri-state override is unset.

§production_override: Option<bool>

Tri-state production override: Some forces production-only analysis on or off regardless of config, None defers to the config value.

§allow_remote_extends: bool

Permit extends config inheritance from remote URLs.

§changed_since: Option<&'a str>

Git ref limiting findings to files changed since it.

§diff_index: Option<&'a DiffIndex>

Pre-built diff index scoping findings to changed lines.

§use_shared_diff_index: bool

True when diff_index came from the process-shared diff source rather than a health-specific one.

§workspace: Option<&'a [String]>

Workspace member paths limiting the analysis scope.

§changed_workspaces: Option<&'a str>

Git ref selecting only workspaces with changes since it.

§scope: Option<PathBuf>

Positional [PATH] scope: root-joined absolute file or directory inside the root. Consumed CLI-side as one more workspace root (prefix scope), so it composes with workspace the way multiple workspace roots compose. None means whole-project scope.

§baseline: Option<&'a Path>

Baseline file to compare finding counts against.

§save_baseline: Option<&'a Path>

Path to write the run’s finding counts as a new baseline.

§baseline_mode: HealthBaselineMode

Controls both halves of the baseline lifecycle: which buckets save_baseline writes and how a loaded baseline is matched. An identity save writes count and identity buckets, a count save writes count buckets only.

§baseline_mode_explicit: bool

Whether baseline_mode was requested explicitly rather than defaulted. A defaulted count save refuses to overwrite a baseline that carries identity buckets, because dropping them breaks later identity-mode comparisons; an explicit count request is treated as intent to downgrade.

§complexity: bool

Render the complexity findings section.

§file_scores: bool

Render the per-file health scores section.

§coverage_gaps: bool

Render the static coverage gaps section.

§config_activates_coverage_gaps: bool

Let config-enabled coverage settings activate the coverage gaps section even when it was not requested on this run.

§hotspots: bool

Render the churn-based hotspots section.

§ownership: bool

Attribute hotspots to owners.

§ownership_emails: Option<EmailMode>

How owner identities are rendered (names or emails).

§targets: bool

Render the refactoring targets section.

§css: bool

Render the CSS / styling analytics section.

§css_deep: bool

Scan all stylesheets for the CSS section instead of only changed files.

§force_full: bool

Analyze the full project even when only a subset of sections was requested, because scores and snapshots need complete data.

§score_only_output: bool

True when the score is the only requested surface, so output can skip section rendering entirely.

§enforce_coverage_gap_gate: bool

Fail the run on coverage gaps instead of reporting them advisorily.

§effort: Option<EffortEstimate>

Effort estimation mode for refactoring targets.

§score: bool

Compute and render the overall health score.

§gates: HealthGateOptions

Exit gate thresholds.

§since: Option<&'a str>

Churn lookback window for hotspots (90d, 6m, 1y, or an ISO date).

§min_commits: Option<u32>

Minimum commit count for a file to qualify as churn evidence.

§explain: bool

Include score-derivation explanations in the rendered output.

§summary: bool

Render the condensed summary view instead of full sections.

§save_snapshot: Option<PathBuf>

Path to persist a health snapshot for later trend comparison.

§trend: bool

Render the score trend against previously saved snapshots.

§coverage_inputs: HealthCoverageInputs<'a>

Istanbul coverage inputs for CRAP scoring.

§performance: bool

Print per-phase timing diagnostics.

§runtime_coverage: Option<RuntimeCoverageOptions>

Runtime coverage sidecar options, when runtime analysis was requested.

§churn_file: Option<&'a Path>

Pre-recorded churn data file replacing live git log analysis.

§analysis_identity: SemanticAnalysisIdentity

Compatibility identity persisted with snapshots and checked by trends.

§group_by: Option<GroupByMode>

Optional grouping mode for typed health output.

Trait Implementations§

Source§

impl<'a> Clone for HealthExecutionOptions<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for HealthExecutionOptions<'a>

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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