feat: add first debug version of gix branch list

Author: cruessler

gitoxide-core/src/repository/branch.rs

@@ -0,0 +1,68 @@
+use crate::OutputFormat;
+
+pub enum Kind {
+    Local,
+    All,
+}
+
+impl Kind {
+    fn includes_local_branches(&self) -> bool {
+        match self {
+            Self::Local | Self::All => true,
+        }
+    }
+
+    fn includes_remote_branches(&self) -> bool {
+        match self {
+            Self::Local => false,
+            Self::All => true,
+        }
+    }
+}
+
+pub struct Options {
+    pub kind: Kind,
+}
+
+pub fn list(
+    repo: gix::Repository,
+    out: &mut dyn std::io::Write,
+    format: OutputFormat,
+    options: Options,
+) -> anyhow::Result<()> {
+    if format != OutputFormat::Human {
+        anyhow::bail!("JSON output isn't supported");
+    }
+
+    let platform = repo.references()?;
+
+    if options.kind.includes_local_branches() {
+        let mut branch_names: Vec<String> = platform
+            .local_branches()?
+            .flatten()
+            .map(|branch| branch.name().shorten().to_string())
+            .collect();
+
+        branch_names.sort();
+
+        for branch_name in branch_names {
+            writeln!(out, "{branch_name}")?;
+        }
+    }
+
+    if options.kind.includes_remote_branches() {
+        let mut branch_names: Vec<String> = platform
+            .remote_branches()?
+            .flatten()
+            .map(|branch| branch.name().shorten().to_string())
+            .collect();
+
+        branch_names.sort();
+
+        for branch_name in branch_names {
+            writeln!(out, "{branch_name}")?;
+        }
+    }
+
+    Ok(())
+}

gitoxide-core/src/repository/mod.rs

@@ -6,6 +6,7 @@ use gix::bstr::BString;
 
 #[cfg(feature = "archive")]
 pub mod archive;
+pub mod branch;
 pub mod cat;
 pub use cat::function::cat;
 pub mod blame;

src/plumbing/main.rs

@@ -16,8 +16,8 @@ use gix::bstr::{io::BufReadExt, BString};
 use crate::{
     plumbing::{
         options::{
-            attributes, commit, commitgraph, config, credential, exclude, free, fsck, index, mailmap, merge, odb,
-            revision, tag, tree, Args, Subcommands,
+            attributes, branch, commit, commitgraph, config, credential, exclude, free, fsck, index, mailmap, merge,
+            odb, revision, tag, tree, Args, Subcommands,
         },
         show_progress,
     },
@@ -509,6 +509,26 @@ pub fn main() -> Result<()> {
                 )
             },
         ),
+        Subcommands::Branch(platform) => match platform.cmds {
+            Some(branch::Subcommands::List) | None => {
+                use core::repository::branch::{Kind, Options};
+
+                let kind = if platform.all { Kind::All } else { Kind::Local };
+                let options = Options { kind };
+
+                prepare_and_run(
+                    "branch-list",
+                    trace,
+                    auto_verbose,
+                    progress,
+                    progress_keep_open,
+                    None,
+                    move |_progress, out, _err| {
+                        core::repository::branch::list(repository(Mode::Lenient)?, out, format, options)
+                    },
+                )
+            }
+        },
         #[cfg(feature = "gitoxide-core-tools-corpus")]
         Subcommands::Corpus(crate::plumbing::options::corpus::Platform { db, path, cmd }) => {
             let reverse_trace_lines = progress;

src/plumbing/options/mod.rs

@@ -83,6 +83,9 @@ pub enum Subcommands {
     /// Subcommands for creating worktree archives.
     #[cfg(feature = "gitoxide-core-tools-archive")]
     Archive(archive::Platform),
+    /// Interact with branches.
+    #[clap(visible_alias = "branches")]
+    Branch(branch::Platform),
     /// Remove untracked files from the working tree.
     #[cfg(feature = "gitoxide-core-tools-clean")]
     Clean(clean::Command),
@@ -236,6 +239,24 @@ pub mod archive {
     }
 }
 
+pub mod branch {
+    #[derive(Debug, clap::Parser)]
+    pub struct Platform {
+        #[clap(subcommand)]
+        pub cmds: Option<Subcommands>,
+
+        /// List remote-tracking as well as local branches.
+        #[clap(long, short = 'a')]
+        pub all: bool,
+    }
+
+    #[derive(Debug, clap::Subcommand)]
+    pub enum Subcommands {
+        /// List all tags.
+        List,
+    }
+}
+
 pub mod status {
     use gix::bstr::BString;