code-graph-cli 3.0.1

Code intelligence engine for TypeScript/JavaScript/Rust/Python/Go — query the dependency graph instead of reading source files.
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

use std::path::PathBuf;

/// Output format for graph export.
#[derive(
    Clone, Copy, Debug, PartialEq, Eq, clap::ValueEnum, serde::Serialize, serde::Deserialize,
)]
pub enum ExportFormat {
    /// Graphviz DOT format (default). Suitable for large graphs and tooling.
    Dot,
    /// Mermaid flowchart format. Best for small-to-medium graphs in markdown.
    Mermaid,
}

/// Granularity level for exported nodes.
#[derive(
    Clone,
    Copy,
    Debug,
    PartialEq,
    Eq,
    clap::ValueEnum,
    serde::Serialize,
    serde::Deserialize,
    Default,
)]
pub enum Granularity {
    /// One node per symbol (function, struct, etc.). Most detailed; may exceed Mermaid limits.
    Symbol,
    /// One node per file (default). Good balance of detail and readability.
    #[default]
    File,
    /// One node per package/crate. Best for high-level architecture overview.
    Package,
}

/// Parameters controlling a graph export operation.
pub struct ExportParams {
    /// Output format: DOT or Mermaid.
    pub format: ExportFormat,
    /// Granularity level: symbol, file, or package.
    pub granularity: Granularity,
    /// Restrict export to nodes whose file paths start with this prefix.
    pub root_filter: Option<PathBuf>,
    /// Export a named symbol and its N-hop neighborhood (BFS outward).
    pub symbol_filter: Option<String>,
    /// Hop depth for --symbol neighborhood BFS (default: 1).
    pub depth: usize,
    /// Exclude files/symbols matching these glob patterns.
    pub exclude_patterns: Vec<String>,
    /// Absolute path to the project root (used for relative path labels and workspace discovery).
    pub project_root: PathBuf,
    /// Write output to stdout instead of a file (read by caller, not export_graph).
    /// Callers (`main.rs`) check this flag themselves on ExportResult;
    /// export_graph itself does not read it — hence the suppression.
    #[allow(dead_code)]
    pub stdout: bool,
}

/// Result of a graph export operation.
pub struct ExportResult {
    /// The rendered graph content (DOT or Mermaid text).
    pub content: String,
    /// Number of nodes in the exported graph (at chosen granularity).
    pub node_count: usize,
    /// Number of edges in the exported graph.
    pub edge_count: usize,
    /// Advisory warnings (e.g. scale guard messages). Already printed to stderr by export_graph.
    pub warnings: Vec<String>,
}