backhopper-xref 0.37.0

Whole-program cross-reference analysis for Erlang projects: undefined-call detection, dead-export detection, reverse traversal, behaviour conformance, cross-tag diff
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

// Copyright (C) 2026 Michael S. Klishin and Contributors
// SPDX-License-Identifier: Apache-2.0 OR MIT
// See LICENSE-APACHE and LICENSE-MIT for details.

//! Whole-program cross-reference analysis for Erlang projects.
//!
//! This is the consumer-facing façade. Build an [`Xref`] with
//! [`XrefBuilder`], then run [predefined analyses](analysis) (dead-export
//! detection, behaviour conformance, cycle detection).
//!
//! The test-suite-selection adapter [`suites`] consumes the graph to
//! answer "which `_SUITE` modules should I run for this diff?".

pub mod analysis;
pub mod builder;
pub mod display;
pub mod errors;
pub mod result;
pub mod suites;
pub mod xref;

pub use builder::XrefBuilder;
pub use errors::XrefError;
pub use result::{
    AnalysisResult, AppDependencies, CalleeEntry, CalleesOf, CallerEntry, CallersOf,
    DeprecatedCall, DeprecatedFunctionCalls, ExportsNotUsed, LocalsNotUsed, ModuleCallers,
    ModuleDependencies, NonConformance, UndefinedFunctionCall, UndefinedFunctionCalls,
    UnresolvedCalls, UnusedExport, UnusedLocal,
};
pub use suites::{SuiteRef, is_suite_module, suites_referencing, suites_referencing_mfas};
pub use xref::Xref;

pub use backhopper_xref_graph::{
    CallGraph, CallKind, CallTarget, Deprecation, DeprecationTier, FunctionRef, FunctionSig,
    Functions, Loc, Modules, Position, Relation, Vertex, VertexSet,
};
pub use backhopper_xref_reader::{
    ApplicationAssignment, ModuleData, ProjectLayout, ReadError, ReadOutput, ReadWarning,
    SourceReader,
};