Skip to main content

Module runtime

Module runtime 

Source
Expand description

Programmatic runtime entry points that avoid depending on fallow-cli.

Re-exports§

pub use trace::run_trace_clone;
pub use trace::run_trace_dependency;
pub use trace::run_trace_error;
pub use trace::run_trace_export;
pub use trace::run_trace_file;
pub use trace::run_trace_import_path;

Structs§

ArchitectureProgrammaticOutput
Typed programmatic fallow architecture output before JSON serialization.
AuditProgrammaticKeySnapshot
Stable audit key snapshot used to classify introduced vs inherited findings.
AuditProgrammaticOutput
Typed programmatic audit output before JSON serialization.
BoundaryViolationsProgrammaticOutput
Typed programmatic boundary-family output before JSON serialization.
CircularDependenciesProgrammaticOutput
Typed programmatic circular-dependency output before JSON serialization.
CombinedProgrammaticOutput
Typed programmatic combined output before JSON serialization.
DeadCodeProgrammaticOutput
Typed programmatic dead-code output before JSON serialization.
DecisionSurfaceProgrammaticOutput
Typed programmatic decision-surface output before JSON serialization.
DuplicationProgrammaticOutput
Typed programmatic duplication output before JSON serialization.
EngineHealthRunner
Default health runner backed directly by fallow-engine.
FeatureFlagsProgrammaticOutput
Typed programmatic feature-flag output before JSON serialization.
HealthJsonReportInput
Inputs for serializing health JSON output through the API boundary.
HealthProgrammaticOutput
Typed programmatic health / complexity output before JSON serialization.
ProgrammaticHealthAnalysis
API-owned health analysis payload returned by programmatic runners.
ProgrammaticHealthNextStepFacts
Runtime probes used by programmatic health output assembly.
ProgrammaticHealthRun
Health runner output shared by API, NAPI, and alternate runners.
TraceCloneProgrammaticOutput
Typed programmatic duplicate-code trace output before JSON serialization.
TraceDependencyProgrammaticOutput
Typed programmatic dependency-trace output before JSON serialization.
TraceErrorProgrammaticOutput
Typed programmatic stack-trace resolution before JSON serialization.
TraceExportProgrammaticOutput
Typed programmatic export-trace output before JSON serialization. Carries either an export trace or (fallback) a class / enum / store member trace.
TraceFileProgrammaticOutput
Typed programmatic file-trace output before JSON serialization.
TraceImportPathProgrammaticOutput
Typed programmatic import-path-trace output before JSON serialization.

Enums§

TraceExportTargetOutput
The trace_export target: either a top-level export or (fallback) a class / enum / store member declared on one. Serialized untagged so the export shape stays byte-identical to the historical contract and the member shape matches the CLI’s member trace; consumers distinguish by the presence of export_name (export) vs member_name / owner_export (member).

Constants§

AUDIT_CONFIG_BASELINE_UNSUPPORTED
Error code of run_audit when the project config sets an audit baseline key, which the typed audit cannot apply. Callers that can run fallow audit instead, such as the MCP audit tool, fall back on it.
TYPE_AWARE_CONFIG_UNSUPPORTED
Error code of the typed runners when the environment or the project config turns on type-aware analysis that the caller did not request through crate::TypeAwareOptions. Callers that can run the fallow CLI instead, such as the MCP tools, fall back on it.

Traits§

ProgrammaticHealthRunner
Runner boundary for programmatic health.

Functions§

inspect_similar_code
Validate and inspect one exact candidate snapshot without rerunning global provider retrieval or ranking.
load_health_config
Load the health section of the project config for adapters that layer config-sourced coverage inputs before building options (the MCP typed route; see crate::coverage). The root and config path resolve exactly as they do for the analysis itself. Returns None when the project has no config file.
parse_similar_code_candidate_snapshot
Validate one inline bounded candidate snapshot.
plan_mutation
Builds the static mutation plan. It runs no user code.
review_similar_code
Join immutable candidate JSON with a separately authored verdict document.
run_architecture
Run the analysis of fallow architecture and return typed API output before JSON: import cycles, boundary violations and rule-pack policy violations.
run_audit
Run changed-code audit through typed programmatic runners.
run_boundary_violations
Run boundary-family analysis and return typed API output before JSON.
run_circular_dependencies
Run circular-dependency analysis and return typed API output before JSON.
run_combined
Run bare combined analysis through one programmatic analysis session.
run_complexity_with_runner
Run programmatic health / complexity and return typed API output.
run_dead_code
Run dead-code analysis and return typed API output before serialization.
run_dead_code_with_baseline
Run dead-code analysis and hide the findings of a saved dead-code baseline.
run_decision_surface
Run changed-code decision-surface analysis through the typed programmatic API.
run_duplication
Run duplication analysis and return typed API output before serialization.
run_feature_flags
Run feature-flag analysis and return typed API output before JSON.
run_health
Run programmatic health / complexity through the engine-backed runner.
run_health_with_runner
Alias for run_complexity_with_runner with a product-oriented name.
run_mutation
Plans the mutants, runs the project tests against each planned mutant, and reports the result.
run_mutation_with_progress
run_mutation that sends a MutationProgress event at the start of each run phase and after each finished mutant.
run_similar_code
Run opt-in semantic similar-code discovery through the verified local provider.
run_trace_clone
Trace duplicate-code groups by location or stable fingerprint.
run_trace_dependency
Trace where a dependency is used.
run_trace_error
Resolve a runtime stack trace’s frames against the project graph.
run_trace_export
Trace why an export is considered used or unused.
run_trace_file
Trace all graph edges for a file.
run_trace_import_path
Trace the shortest import path between two modules.
select_similar_code_candidate_snapshot
Select one bounded candidate snapshot from raw discovery JSON.
serialize_health_report_json
Serialize a health / complexity report into the stable JSON output contract.

Type Aliases§

ArchitectureOutput
Concrete fallow architecture output contract returned by typed runs.
BoundaryViolationsOutput
Concrete boundary-family output contract returned by typed runs.
CircularDependenciesOutput
Concrete circular-dependency output contract returned by typed runs.
DeadCodeOutput
Concrete dead-code output contract returned by typed programmatic runs.
DuplicationOutput
Concrete duplication output contract returned by typed programmatic runs.
FeatureFlagsOutput
Concrete feature-flag output contract returned by typed programmatic runs.
TraceClassMemberOutput
Concrete class / enum / store member trace output (the trace_export fallback when the name is a member rather than a top-level export). See issue #1744.
TraceCloneOutput
Concrete duplicate-code trace output returned by typed programmatic runs.
TraceDependencyOutput
Concrete dependency trace output returned by typed programmatic runs.
TraceErrorOutput
Concrete stack-trace resolution returned by typed programmatic runs.
TraceExportOutput
Concrete export trace output returned by typed programmatic runs.
TraceFileOutput
Concrete file trace output returned by typed programmatic runs.
TraceImportPathOutput
Concrete import-path trace output returned by typed programmatic runs.