Struct Analyzer 

pub struct Analyzer<State = Unconfigured> { /* private fields */ }

Fast standalone analyzer for module graphs.

Uses the typestate pattern to ensure that analysis can only be performed after at least one entry point has been configured. This prevents runtime errors and makes the API more type-safe.

Example

use fob_graph::{Analyzer, Result};

let analysis = Analyzer::new()
    .entry("src/index.ts")  // Transitions to Configured state
    .external(vec!["react", "lodash"])
    .path_alias("@", "./src")
    .analyze()  // Only available on Configured
    .await?;

println!("Unused exports: {}", analysis.unused_exports()?.len());

Implementations

impl Analyzer<Unconfigured>

pub fn new() -> Self

Create a new analyzer with default configuration.

Returns an analyzer in the Unconfigured state. You must call entry() before you can call analyze().

pub fn entry(self, path: impl Into<PathBuf>) -> Analyzer<Configured>

Add a single entry point.

This transitions the analyzer to the Configured state, allowing analyze() to be called.

impl<State> Analyzer<State>

pub fn entries( self, paths: impl IntoIterator<Item = impl Into<PathBuf>>, ) -> Analyzer<Configured>

Add multiple entry points.

This method is available in both Unconfigured and Configured states. If called on Unconfigured, it transitions to Configured.

pub fn external( self, packages: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Mark packages as external (not analyzed).

pub fn path_alias(self, from: impl Into<String>, to: impl Into<String>) -> Self

Add a path alias for import resolution.

Example: path_alias("@", "./src") makes “@/components/Button” resolve to “./src/components/Button”.

pub fn path_aliases(self, aliases: FxHashMap<String, String>) -> Self

Set multiple path aliases at once.

pub fn follow_dynamic_imports(self, follow: bool) -> Self

Whether to follow dynamic imports (default: false).

pub fn include_type_imports(self, include: bool) -> Self

Whether to include TypeScript type-only imports (default: true).

pub fn max_depth(self, depth: Option<usize>) -> Self

Set maximum depth for graph traversal (DoS protection).

Default: 1000

pub fn max_modules(self, modules: Option<usize>) -> Self

Set maximum number of modules to process (DoS protection).

Default: 100,000

pub fn runtime(self, runtime: Arc<dyn Runtime>) -> Self

Set the runtime for filesystem operations.

If not set, will attempt to use a default runtime.

pub fn cwd(self, cwd: impl Into<PathBuf>) -> Self

Set the current working directory.

impl Analyzer<Configured>

pub async fn analyze(self) -> Result<AnalysisResult>

Execute the analysis with default options.

Returns an AnalysisResult containing the module graph and statistics.

This method is only available on Analyzer<Configured>, ensuring that at least one entry point has been set.

pub async fn analyze_with_options( self, options: AnalyzeOptions, ) -> Result<AnalysisResult>

Execute the analysis with custom options.

This method allows you to specify framework rules and control whether usage counts are computed.

Arguments

• options - Analysis options including framework rules and usage count settings

Returns

An AnalysisResult containing the module graph and statistics.

This method is only available on Analyzer<Configured>, ensuring that at least one entry point has been set.

Trait Implementations

impl Default for Analyzer<Unconfigured>

fn default() -> Self

Returns the “default value” for a type.