cargo-brief 0.0.1

Visibility-aware Rust API extractor — pseudo-Rust output for AI agent consumption
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
70
71
72
73
74
75
76
77
78
79
80
81
82

use clap::{Parser, Subcommand};

/// Cargo subcommand wrapper.
#[derive(Parser, Debug)]
#[command(name = "cargo", bin_name = "cargo")]
pub struct Cargo {
    #[command(subcommand)]
    pub command: CargoCommand,
}

#[derive(Subcommand, Debug)]
pub enum CargoCommand {
    /// Extract and display Rust crate API as pseudo-Rust documentation.
    Brief(BriefArgs),
}

/// Core arguments for cargo-brief.
#[derive(Parser, Debug, Clone)]
pub struct BriefArgs {
    /// Target crate name to inspect
    pub crate_name: String,

    /// Module path within the crate to inspect (e.g., "my_mod::submod")
    pub module_path: Option<String>,

    /// Caller's package name (for visibility resolution)
    #[arg(long)]
    pub at_package: Option<String>,

    /// Caller's module path (determines what is visible)
    #[arg(long)]
    pub at_mod: Option<String>,

    /// How many submodule levels to recurse into
    #[arg(long, default_value = "1")]
    pub depth: u32,

    /// Recurse into all submodules (no depth limit)
    #[arg(long)]
    pub recursive: bool,

    /// Show all item kinds including blanket/auto-trait impls
    #[arg(long)]
    pub all: bool,

    // === Exclusion flags (default: all common items shown) ===
    /// Exclude structs
    #[arg(long)]
    pub no_structs: bool,

    /// Exclude enums
    #[arg(long)]
    pub no_enums: bool,

    /// Exclude traits
    #[arg(long)]
    pub no_traits: bool,

    /// Exclude free functions
    #[arg(long)]
    pub no_functions: bool,

    /// Exclude type aliases
    #[arg(long)]
    pub no_aliases: bool,

    /// Exclude constants and statics
    #[arg(long)]
    pub no_constants: bool,

    /// Exclude macros
    #[arg(long)]
    pub no_macros: bool,

    /// Nightly toolchain name (default: "nightly")
    #[arg(long, default_value = "nightly")]
    pub toolchain: String,

    /// Manifest path (passed to cargo)
    #[arg(long)]
    pub manifest_path: Option<String>,
}