cargo-brief 0.5.1

Visibility-aware Rust API extractor — pseudo-Rust output for AI agent consumption
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
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
pub mod cli;
pub mod cross_crate;
pub mod model;
pub mod remote;
pub mod render;
pub mod resolve;
pub mod rustdoc_json;
pub mod search;

/// Clean cached remote crate workspaces. Empty spec = all.
pub fn clean_cache(spec: &str) -> anyhow::Result<()> {
    remote::clean_cache(spec)
}

use std::collections::{HashMap, HashSet};
use std::path::Path;

use anyhow::{Context, Result};
use rustdoc_types::{Id, ItemEnum, Visibility};

use cli::{ApiArgs, FilterArgs, SearchArgs};
use model::{CrateModel, compute_reachable_set};

/// Result of glob re-export expansion. Contains both the item names (for Phase 1
/// individual `pub use` lines) and the full source models (for Phase 2 inlining).
struct GlobExpansionResult {
    /// Phase 1 data: source crate → sorted list of public item names
    item_names: HashMap<String, Vec<String>>,
    /// Phase 2 data: source crate → full CrateModel
    source_models: HashMap<String, CrateModel>,
}

/// Run the API extraction pipeline and return the rendered output string.
pub fn run_api_pipeline(args: &ApiArgs) -> Result<String> {
    if let Some(spec) = &args.remote.crates {
        return run_remote_api_pipeline(args, spec);
    }

    // Step 0: Load cargo metadata and resolve target
    if args.global.verbose {
        eprintln!(
            "[cargo-brief] Resolving target '{}'...",
            args.target.crate_name
        );
    }
    let metadata = resolve::load_cargo_metadata(args.target.manifest_path.as_deref())
        .context("Failed to load cargo metadata")?;

    let resolved = resolve::resolve_target(
        &args.target.crate_name,
        args.target.module_path.as_deref(),
        &metadata,
    )
    .context("Failed to resolve target")?;

    // Step 1: Generate rustdoc JSON
    if args.global.verbose {
        eprintln!(
            "[cargo-brief] Running cargo rustdoc for '{}'...",
            resolved.package_name
        );
    }
    let json_path = rustdoc_json::generate_rustdoc_json(
        &resolved.package_name,
        &args.global.toolchain,
        args.target.manifest_path.as_deref(),
        true, // always document private items for visibility filtering
        &metadata.target_dir,
        args.global.verbose,
    )
    .with_context(|| {
        format!(
            "Failed to generate rustdoc JSON for crate '{}'",
            resolved.package_name
        )
    })?;

    // Step 2: Parse JSON
    if args.global.verbose {
        eprintln!("[cargo-brief] Parsing rustdoc JSON...");
    }
    let krate = rustdoc_json::parse_rustdoc_json(&json_path)
        .with_context(|| format!("Failed to parse rustdoc JSON at '{}'", json_path.display()))?;

    // Step 3: Build model
    let model = CrateModel::from_crate(krate);

    // Step 4: Determine if observer is in the same crate
    let observer_crate = args
        .target
        .at_package
        .as_deref()
        .or(metadata.current_package.as_deref());
    let same_crate = match observer_crate {
        Some(obs) => obs == resolved.package_name || obs.replace('-', "_") == model.crate_name(),
        None => false,
    };
    let reachable = if !same_crate {
        Some(compute_reachable_set(&model))
    } else {
        None
    };

    // Step 5: Render
    let mut output = render::render_module_api(
        &model,
        resolved.module_path.as_deref(),
        args,
        args.target.at_mod.as_deref(),
        same_crate,
        reachable.as_ref(),
    );

    // Step 6: Expand glob re-exports
    let result = expand_glob_reexports(
        &model,
        resolved.module_path.as_deref(),
        &args.global.toolchain,
        args.target.manifest_path.as_deref(),
        &metadata.target_dir,
        args.global.verbose,
    );

    apply_glob_expansions(&mut output, &result, args.expand_glob, &args.filter);

    Ok(output)
}

/// Run the search pipeline and return the rendered output string.
pub fn run_search_pipeline(args: &SearchArgs) -> Result<String> {
    // When --crates is used, the first positional (crate_name) is redundant since
    // the crate is specified by --crates. If pattern is empty and crate_name is not
    // "self", treat crate_name as the pattern (mirrors api subcommand behavior).
    let args =
        if args.remote.crates.is_some() && args.pattern.is_empty() && args.crate_name != "self" {
            let mut args = args.clone();
            args.pattern = std::mem::take(&mut args.crate_name);
            args.crate_name = "self".to_string();
            std::borrow::Cow::Owned(args)
        } else {
            std::borrow::Cow::Borrowed(args)
        };
    let args = args.as_ref();

    // Validate: need either a pattern or --methods-of
    if args.pattern.is_empty() && args.methods_of.is_none() {
        anyhow::bail!("search requires a pattern or --methods-of <TYPE>");
    }

    // --methods-of: translate into pattern + exclusion flags
    if let Some(type_name) = &args.methods_of {
        let mut args = args.clone();
        args.pattern = type_name.clone();
        args.filter.no_structs = true;
        args.filter.no_enums = true;
        args.filter.no_traits = true;
        args.filter.no_unions = true;
        args.filter.no_constants = true;
        args.filter.no_macros = true;
        args.filter.no_aliases = true;
        args.methods_of = None;
        // Leave no_functions = false (methods are functions)
        return run_search_pipeline(&args);
    }

    if let Some(spec) = &args.remote.crates {
        return run_remote_search_pipeline(args, spec);
    }

    // Local search pipeline
    if args.global.verbose {
        eprintln!("[cargo-brief] Resolving target '{}'...", args.crate_name);
    }
    let metadata = resolve::load_cargo_metadata(args.manifest_path.as_deref())
        .context("Failed to load cargo metadata")?;

    let resolved = resolve::resolve_target(&args.crate_name, None, &metadata)
        .context("Failed to resolve target")?;

    if args.global.verbose {
        eprintln!(
            "[cargo-brief] Running cargo rustdoc for '{}'...",
            resolved.package_name
        );
    }
    let json_path = rustdoc_json::generate_rustdoc_json(
        &resolved.package_name,
        &args.global.toolchain,
        args.manifest_path.as_deref(),
        true,
        &metadata.target_dir,
        args.global.verbose,
    )
    .with_context(|| {
        format!(
            "Failed to generate rustdoc JSON for crate '{}'",
            resolved.package_name
        )
    })?;

    if args.global.verbose {
        eprintln!("[cargo-brief] Parsing rustdoc JSON...");
    }
    let krate = rustdoc_json::parse_rustdoc_json(&json_path)
        .with_context(|| format!("Failed to parse rustdoc JSON at '{}'", json_path.display()))?;

    let model = CrateModel::from_crate(krate);

    let observer_crate = args
        .at_package
        .as_deref()
        .or(metadata.current_package.as_deref());
    let same_crate = match observer_crate {
        Some(obs) => obs == resolved.package_name || obs.replace('-', "_") == model.crate_name(),
        None => false,
    };
    let reachable = if !same_crate {
        Some(compute_reachable_set(&model))
    } else {
        None
    };

    let output = search::render_search(
        &model,
        &args.pattern,
        &args.filter,
        args.limit.as_deref(),
        args.at_mod.as_deref(),
        same_crate,
        reachable.as_ref(),
    );
    Ok(output)
}

/// Run the remote search pipeline.
fn run_remote_search_pipeline(args: &SearchArgs, spec: &str) -> Result<String> {
    let (name, _) = remote::parse_crate_spec(spec);
    if args.global.verbose {
        eprintln!("[cargo-brief] Resolving workspace for '{name}'...");
    }
    let (workspace, _resolved_version) =
        remote::resolve_workspace(spec, args.remote.features.as_deref(), args.remote.no_cache)
            .with_context(|| format!("Failed to create workspace for '{name}'"))?;

    let manifest_path = workspace
        .path()
        .join("Cargo.toml")
        .to_string_lossy()
        .into_owned();

    let metadata = resolve::load_cargo_metadata(Some(&manifest_path))
        .context("Failed to load cargo metadata for remote crate")?;

    if args.global.verbose {
        eprintln!("[cargo-brief] Running cargo rustdoc for '{name}'...");
    }
    let json_path = rustdoc_json::generate_rustdoc_json_cached(
        &name,
        &args.global.toolchain,
        Some(&manifest_path),
        true,
        &metadata.target_dir,
        args.global.verbose,
    )
    .with_context(|| format!("Failed to generate rustdoc JSON for remote crate '{name}'"))?;

    if args.global.verbose {
        eprintln!("[cargo-brief] Parsing rustdoc JSON...");
    }
    let krate = rustdoc_json::parse_rustdoc_json_cached(&json_path)?;
    let model = CrateModel::from_crate(krate);
    let reachable = Some(compute_reachable_set(&model));
    let has_cross_crate = cross_crate::root_has_cross_crate_reexports(&model);

    let mut output = search::render_search(
        &model,
        &args.pattern,
        &args.filter,
        args.limit.as_deref(),
        None,
        false,
        reachable.as_ref(),
    );

    // Cross-crate search: discover sub-crates, search each
    if has_cross_crate {
        if args.global.verbose {
            eprintln!("[cargo-brief] Discovering cross-crate re-exports...");
        }
        let sub_crates = cross_crate::discover_all_reexported_crates(
            &model,
            &args.global.toolchain,
            Some(&manifest_path),
            &metadata.target_dir,
            args.global.verbose,
        );
        for sub in &sub_crates {
            let sub_reachable = Some(compute_reachable_set(&sub.model));
            let sub_output = search::render_search(
                &sub.model,
                &args.pattern,
                &args.filter,
                args.limit.as_deref(),
                None,
                false,
                sub_reachable.as_ref(),
            );
            output.push_str(&sub_output);
        }
    }

    Ok(output)
}

/// Run the remote API pipeline for a crate fetched via a cached or temp workspace.
fn run_remote_api_pipeline(args: &ApiArgs, spec: &str) -> Result<String> {
    // When --crates is used, the first positional arg (crate_name) may actually be
    // a module path (e.g., `cargo brief api --crates bevy ecs` → crate_name="ecs").
    // Merge it into module_path if it's not "self".
    let module_path = if args.target.crate_name != "self" && args.target.module_path.is_none() {
        Some(args.target.crate_name.clone())
    } else {
        args.target.module_path.clone()
    };

    let (name, _) = remote::parse_crate_spec(spec);
    if args.global.verbose {
        eprintln!("[cargo-brief] Resolving workspace for '{name}'...");
    }
    let (workspace, resolved_version) =
        remote::resolve_workspace(spec, args.remote.features.as_deref(), args.remote.no_cache)
            .with_context(|| format!("Failed to create workspace for '{name}'"))?;

    let manifest_path = workspace
        .path()
        .join("Cargo.toml")
        .to_string_lossy()
        .into_owned();

    let metadata = resolve::load_cargo_metadata(Some(&manifest_path))
        .context("Failed to load cargo metadata for remote crate")?;

    if args.global.verbose {
        eprintln!("[cargo-brief] Running cargo rustdoc for '{name}'...");
    }
    let json_path = rustdoc_json::generate_rustdoc_json_cached(
        &name,
        &args.global.toolchain,
        Some(&manifest_path),
        true, // include private modules so facade crate internals are visible
        &metadata.target_dir,
        args.global.verbose,
    )
    .with_context(|| format!("Failed to generate rustdoc JSON for remote crate '{name}'"))?;

    if args.global.verbose {
        eprintln!("[cargo-brief] Parsing rustdoc JSON...");
    }
    let krate = rustdoc_json::parse_rustdoc_json_cached(&json_path)?;
    let model = CrateModel::from_crate(krate);
    let reachable = Some(compute_reachable_set(&model));
    let has_cross_crate = cross_crate::root_has_cross_crate_reexports(&model);

    // Build enriched crate header with version + features
    let crate_header = build_remote_crate_header(
        &name,
        resolved_version.as_deref(),
        workspace.path(),
        args.remote.features.as_deref(),
    );

    let mut output = if let Some(ref module_path) = module_path {
        // --- Module targeting with cross-crate resolution ---
        if model.find_module(module_path).is_some() {
            // Found locally — render normally
            render_remote_normal(
                &model,
                Some(module_path),
                args,
                &manifest_path,
                &metadata.target_dir,
                reachable.as_ref(),
            )?
        } else {
            if args.global.verbose {
                eprintln!(
                    "[cargo-brief] Module '{module_path}' not found locally, trying cross-crate resolution..."
                );
            }
            if let Some(resolution) = cross_crate::resolve_cross_crate_module(
                &model,
                module_path,
                &args.global.toolchain,
                Some(&manifest_path),
                &metadata.target_dir,
                args.global.verbose,
            ) {
                // Cross-crate resolved: use sub-crate model
                let sub_reachable = Some(compute_reachable_set(&resolution.model));
                let mut output = render::render_module_api(
                    &resolution.model,
                    resolution.inner_module_path.as_deref(),
                    args,
                    None,
                    false,
                    sub_reachable.as_ref(),
                );

                let result = expand_glob_reexports(
                    &resolution.model,
                    resolution.inner_module_path.as_deref(),
                    &args.global.toolchain,
                    Some(&manifest_path),
                    &metadata.target_dir,
                    args.global.verbose,
                );
                apply_glob_expansions(&mut output, &result, args.expand_glob, &args.filter);
                output
            } else {
                // Fall through to normal render (will produce "module not found" error)
                render_remote_normal(
                    &model,
                    Some(module_path),
                    args,
                    &manifest_path,
                    &metadata.target_dir,
                    reachable.as_ref(),
                )?
            }
        }
    } else if args.recursive && has_cross_crate {
        // --- Recursive mode with cross-crate expansion ---
        if args.global.verbose {
            eprintln!("[cargo-brief] Discovering cross-crate re-exports...");
        }
        let mut output = render::render_module_api(
            &model,
            module_path.as_deref(),
            args,
            None,
            false,
            reachable.as_ref(),
        );

        let result = expand_glob_reexports(
            &model,
            module_path.as_deref(),
            &args.global.toolchain,
            Some(&manifest_path),
            &metadata.target_dir,
            args.global.verbose,
        );
        apply_glob_expansions(&mut output, &result, args.expand_glob, &args.filter);

        let sub_crates = cross_crate::discover_all_reexported_crates(
            &model,
            &args.global.toolchain,
            Some(&manifest_path),
            &metadata.target_dir,
            args.global.verbose,
        );
        for sub in &sub_crates {
            let sub_reachable = Some(compute_reachable_set(&sub.model));
            let sub_output = render::render_module_api(
                &sub.model,
                None,
                args,
                None,
                false,
                sub_reachable.as_ref(),
            );
            output.push_str(&format!(
                "\n// --- module {} (from sub-crate {}) ---\n",
                sub.display_name,
                sub.model.crate_name()
            ));
            output.push_str(&sub_output);
        }

        output
    } else {
        // --- Normal mode ---
        render_remote_normal(
            &model,
            module_path.as_deref(),
            args,
            &manifest_path,
            &metadata.target_dir,
            reachable.as_ref(),
        )?
    };

    // Enrich the first `// crate <name>` header with version + features
    if let Some(header) = &crate_header {
        if let Some(first_newline) = output.find('\n') {
            let first_line = &output[..first_newline];
            if first_line.starts_with("// crate ") {
                output.replace_range(..first_newline, header);
            }
        }
    }

    Ok(output)
}

/// Build an enriched `// crate name[version] features = [...]` header for remote crates.
/// Returns None if version cannot be determined.
fn build_remote_crate_header(
    crate_name: &str,
    resolved_version: Option<&str>,
    workspace_dir: &Path,
    features: Option<&str>,
) -> Option<String> {
    let version = resolved_version
        .map(|v| v.to_string())
        .or_else(|| remote::resolve_crate_version(workspace_dir, crate_name))?;
    let mut header = format!("// crate {crate_name}[{version}]");
    if let Some(feats) = features {
        let feat_list: Vec<&str> = feats.split(',').map(|s| s.trim()).collect();
        let formatted = feat_list
            .iter()
            .map(|f| format!("\"{f}\""))
            .collect::<Vec<_>>()
            .join(", ");
        header.push_str(&format!(" features = [{formatted}]"));
    }
    Some(header)
}

/// Render a remote crate in normal (non-search, non-cross-crate) mode.
fn render_remote_normal(
    model: &CrateModel,
    module_path: Option<&str>,
    args: &ApiArgs,
    manifest_path: &str,
    target_dir: &Path,
    reachable: Option<&HashSet<Id>>,
) -> Result<String> {
    let mut output = render::render_module_api(model, module_path, args, None, false, reachable);

    let result = expand_glob_reexports(
        model,
        module_path,
        &args.global.toolchain,
        Some(manifest_path),
        target_dir,
        args.global.verbose,
    );
    apply_glob_expansions(&mut output, &result, args.expand_glob, &args.filter);

    Ok(output)
}

/// Apply glob expansion results to the rendered output.
fn apply_glob_expansions(
    output: &mut String,
    result: &GlobExpansionResult,
    expand_glob: bool,
    filter: &FilterArgs,
) {
    if expand_glob && !result.source_models.is_empty() {
        // Phase 2: inline full definitions from source crates
        let mut seen_names = HashSet::new();
        for (source, source_model) in &result.source_models {
            let rendered = render::render_inlined_items(source_model, filter, &mut seen_names);
            let pattern = format!("pub use {source}::*;");
            replace_glob_lines(output, &pattern, &rendered);
        }
    } else if !result.item_names.is_empty() {
        // Phase 1: individual pub use lines
        for (source, items) in &result.item_names {
            let pattern = format!("pub use {source}::*;");
            let mut replacement = String::new();
            for name in items {
                replacement.push_str(&format!("pub use {source}::{name};\n"));
            }
            replace_glob_lines(output, &pattern, &replacement);
        }
    }
}

/// Find and replace all lines whose normalized content matches `pattern`.
///
/// Normalization: trim whitespace, collapse multiple spaces.
/// Replacement lines inherit the original line's indentation.
fn replace_glob_lines(output: &mut String, pattern: &str, replacement: &str) {
    loop {
        let Some((start, end, indent)) = find_normalized_line(output, pattern) else {
            break;
        };
        let indented: String = replacement
            .lines()
            .map(|l| {
                if l.is_empty() {
                    "\n".to_string()
                } else {
                    format!("{indent}{l}\n")
                }
            })
            .collect();
        output.replace_range(start..end, &indented);
    }
}

/// Find the first line in `text` whose trimmed, space-collapsed content equals `pattern`.
/// Returns `(start_byte, end_byte, indent_str)`.
fn find_normalized_line(text: &str, pattern: &str) -> Option<(usize, usize, String)> {
    let mut start = 0;
    for line in text.split('\n') {
        let end = start + line.len() + 1; // +1 for '\n'
        let normalized: String = line.split_whitespace().collect::<Vec<_>>().join(" ");
        if normalized == pattern {
            let indent = &line[..line.len() - line.trim_start().len()];
            return Some((start, end.min(text.len()), indent.to_string()));
        }
        start = end;
    }
    None
}

/// Detect glob re-exports in the target module and expand each by generating
/// rustdoc JSON for the source crate and enumerating its public items.
///
/// Returns both item names (for Phase 1 `pub use` lines) and source models
/// (for Phase 2 full definition inlining).
fn expand_glob_reexports(
    model: &CrateModel,
    target_module_path: Option<&str>,
    toolchain: &str,
    manifest_path: Option<&str>,
    target_dir: &Path,
    verbose: bool,
) -> GlobExpansionResult {
    let target_item = if let Some(path) = target_module_path {
        model.find_module(path)
    } else {
        model.root_module()
    };

    let Some(target_item) = target_item else {
        return GlobExpansionResult {
            item_names: HashMap::new(),
            source_models: HashMap::new(),
        };
    };

    let mut item_names = HashMap::new();
    let mut source_models = HashMap::new();

    for (_id, child) in model.module_children(target_item) {
        let ItemEnum::Use(use_item) = &child.inner else {
            continue;
        };
        if !use_item.is_glob {
            continue;
        }

        let source = &use_item.source;

        // Generate JSON for the source crate (pub items only, no private items)
        let Ok(json_path) = rustdoc_json::generate_rustdoc_json(
            source,
            toolchain,
            manifest_path,
            false,
            target_dir,
            verbose,
        ) else {
            continue;
        };
        let Ok(source_krate) = rustdoc_json::parse_rustdoc_json(&json_path) else {
            continue;
        };

        let source_model = CrateModel::from_crate(source_krate);
        let Some(root) = source_model.root_module() else {
            continue;
        };

        let mut items: Vec<String> = source_model
            .module_children(root)
            .iter()
            .filter(|(_, item)| matches!(item.visibility, Visibility::Public))
            .filter(|(_, item)| !matches!(item.inner, ItemEnum::Module(_)))
            .filter_map(|(_, item)| {
                // Use items store their name in inner.use.name, not item.name
                item.name.clone().or_else(|| {
                    if let ItemEnum::Use(u) = &item.inner {
                        Some(u.name.clone())
                    } else {
                        None
                    }
                })
            })
            .collect();

        items.sort();
        items.dedup();
        item_names.insert(source.clone(), items);
        source_models.insert(source.clone(), source_model);
    }

    GlobExpansionResult {
        item_names,
        source_models,
    }
}