Crate fallow_engine

Expand description

Typed analysis engine facade for fallow consumers.

fallow-core remains the internal orchestration backend. This crate owns the typed boundary that editor, API, and embedding surfaces can depend on without calling deprecated core entry points directly.

Re-exports§

pub use health::ComplexityRunOptions;
pub use health::ComplexitySectionOptions;
pub use health::DerivedComplexityOptions;
pub use health::DerivedHealthSections;
pub use health::HealthAnalysisResult;
pub use health::HealthCoverageInputs;
pub use health::HealthExecutionOptions;
pub use health::HealthGateOptions;
pub use health::HealthRunOptions;
pub use health::HealthRunOptionsInput;
pub use health::HealthSectionOptions;
pub use health::HealthSharedParseData;
pub use health::HealthSort;
pub use health::HealthThresholdOverrides;
pub use health::RuntimeCoverageOptions;
pub use health::derive_complexity_sections;
pub use health::derive_health_run_options;
pub use health::derive_health_sections;
pub use health::validate_coverage_root_absolute;

Modules§

baseline
cache: Parse cache helpers exposed through the engine boundary.
changed_files: Changed-file helpers exposed through the engine boundary for editor and embedding surfaces.
churn: Git churn helpers and types exposed through the engine boundary.
codeowners: CODEOWNERS file parser and ownership lookup.
cross_reference: Cross-reference helpers exposed through the engine boundary.
dead_code: Dead-code result helpers exposed through the engine boundary.
discover: Discovery helpers and types exposed through the engine boundary.
duplicates: Duplication result types exposed through the engine boundary.
error
extract: Extracted semantic types exposed through the engine boundary.
flags: Feature flag analysis owned by the engine boundary.
git_env: Git process environment helpers exposed through the engine boundary.
graph: Module graph types exposed through the engine boundary.
health: Typed health result contracts exposed through the engine boundary.
plugins: Plugin registry helpers and types exposed through the engine boundary.
public_api: Public API graph helpers exposed through the engine boundary.
resolve: Module resolution types exposed through the engine boundary.
results: Analysis result types exposed through the engine boundary.
security: Security metadata helpers exposed through the engine boundary.
suppress: Suppression helpers exposed for editor and embedding surfaces.
trace: Read-only trace helpers exposed through the engine boundary.
trace_chain: Symbol trace types exposed through the engine boundary.
validate
vital_signs: Vital signs computation and snapshot persistence.

Structs§

AnalysisDiscovery: Reusable discovery prelude for a resolved project.
AnalysisResults: Complete analysis results.
AnalysisSession: Reusable engine session for one resolved project.
AnalysisSessionParts: Owned session parts for runners that need to continue an existing pipeline.
CloneFamily: A clone family: a set of clone groups that share the same file set.
CloneGroup: A group of code clones – the same (or normalized-equivalent) code appearing in multiple places.
CloneInstance: A single instance of duplicated code at a specific location.
DeadCodeAnalysis: Typed dead-code analysis result.
DeadCodeAnalysisArtifacts: Typed dead-code analysis result with all reusable pipeline artifacts.
DeadCodeAnalysisOutput: Typed dead-code analysis result with retained parser artifacts.
DeadCodeAnalysisWithHashes: Typed dead-code analysis result with per-file source hashes.
DefaultIgnoreSkips: Human-format-only skipped-file stats for built-in duplicates ignores.
DiscoveredFile: A discovered source file on disk.
DuplicationAnalysis: Typed duplication analysis result.
DuplicationReport: Overall duplication analysis report.
DuplicationStats: Aggregate duplication statistics.
EngineError: Error type exposed by the typed engine boundary.
FileId: Compact file identifier.
MirroredDirectory: A detected mirrored directory pattern: two directory prefixes that contain identical files (e.g., src/ and deno/lib/).
ModuleInfo: Extracted module information from a single file.
ProjectAnalysisOutput: Typed project analysis result combining dead-code and duplication outputs.
ProjectConfig: Resolved project config plus the config file path when one was loaded.
ProjectConfigOptions: Scalar config-loading knobs for one analysis family.
RefactoringSuggestion: A refactoring suggestion for a clone family.

Functions§

analyze: Run dead-code analysis for a resolved config.
analyze_retaining_modules: Run dead-code analysis while retaining module and file artifacts.
analyze_with_file_hashes: Run dead-code analysis with source hashes for drift-sensitive fixers.
analyze_with_parse_result: Run dead-code analysis from pre-parsed modules.
analyze_with_trace: Run dead-code analysis with trace timings and retained graph artifacts.
analyze_with_usages: Run dead-code analysis with export usage collection for a resolved config.
analyze_with_usages_and_complexity: Run dead-code analysis with export usage and retained complexity artifacts.
changed_files: Resolve changed files for a git ref relative to a project root.
config_for_project: Resolve the analysis config for a project.
config_for_project_analysis: Resolve config for a specific analysis without depending on the CLI crate.
discover_files_with_plugin_scopes: Discover source files for a resolved config, including plugin scopes.
find_duplicates: Run duplication detection on a discovered file set.
find_duplicates_touching_files_with_defaults: Run focused duplication detection and include metadata about built-in ignored files.
find_duplicates_with_defaults: Run duplication detection and include metadata about built-in ignored files.
health_shared_parse_data_from_artifacts: Build health shared parse data from retained dead-code artifacts.
resolve_cache_max_size_bytes: Resolve the parse-cache size limit for a resolved config.
trace_symbol_chain: Run symbol-level call-chain tracing through the engine boundary.

Type Aliases§

EngineResult: Result alias for typed engine operations.

Crate fallow_engine

Crate fallow_engine Copy item path

Re-exports§

Modules§

Structs§

Functions§

Type Aliases§

Crate fallow_engine