1195bfbe11
systemic gap argus flagged on PR #798 (timeline verb). every `pub fn run` in hive-forge/src/verbs/*.rs lacked a `# Errors` block — violates Rust API guidelines + obscures the failure surface for operators reading the source. uniform doc per verb category: - pure GET + print verbs: "transport error from the Forgejo REST call + I/O error from stdout" - body-from-file verbs (comment/comment_edit/issue_create/issue_edit/ pr_create): adds 'I/O error from --body-file/stdin input' - file-upload verbs (attach-issue, attach-comment): adds 'file read/exist check' - pr_create: also mentions the --push shellout 23 `pub fn run` signatures touched. no behaviour change; pure documentation sweep. cargo test green (38 tests).
37 lines
1 KiB
Rust
37 lines
1 KiB
Rust
//! `branches [pattern] [repo]` — list branches, optionally filtered.
|
|
|
|
use anyhow::Result;
|
|
use clap::Args as ClapArgs;
|
|
use serde_json::Value;
|
|
|
|
use crate::client::Client;
|
|
|
|
#[derive(ClapArgs)]
|
|
pub struct Args {
|
|
/// Substring pattern to filter branch names.
|
|
pattern: Option<String>,
|
|
}
|
|
|
|
/// # Errors
|
|
///
|
|
/// Propagates any transport error from the Forgejo REST call
|
|
/// (network unreachable, 4xx/5xx response, token missing/invalid)
|
|
/// and any I/O error from writing the response to stdout.
|
|
pub fn run(client: &Client, args: Args) -> Result<()> {
|
|
let repo = client.repo();
|
|
let v = client.get_json(&format!("/repos/{repo}/branches?limit=100"))?;
|
|
let names: Vec<&str> = v
|
|
.as_array()
|
|
.map(|a| {
|
|
a.iter()
|
|
.filter_map(|b| b.get("name").and_then(Value::as_str))
|
|
.collect()
|
|
})
|
|
.unwrap_or_default();
|
|
for n in names {
|
|
if args.pattern.as_deref().is_none_or(|p| n.contains(p)) {
|
|
println!("{n}");
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|