Merge pull request #2073 from cruessler/add-tag-list

feat: add first debug version of `gix tag list`

Author: Byron

gitoxide-core/src/repository/mod.rs

@@ -44,6 +44,7 @@ pub mod remote;
 pub mod revision;
 pub mod status;
 pub mod submodule;
+pub mod tag;
 pub mod tree;
 pub mod verify;
 pub mod worktree;

gitoxide-core/src/repository/tag.rs

@@ -0,0 +1,33 @@
+pub fn list(repo: gix::Repository, out: &mut dyn std::io::Write) -> anyhow::Result<()> {
+    let platform = repo.references()?;
+
+    for mut reference in platform.tags()?.flatten() {
+        let tag = reference.peel_to_tag();
+        let tag_ref = tag.as_ref().map(gix::Tag::decode);
+
+        // `name` is the name of the file in `refs/tags/`.
+        // This applies to both lightweight and annotated tags.
+        let name = reference.name().shorten();
+        let mut fields = Vec::new();
+        match tag_ref {
+            Ok(Ok(tag_ref)) => {
+                // `tag_name` is the name provided by the user via `git tag -a/-s/-u`.
+                // It is only present for annotated tags.
+                fields.push(format!(
+                    "tag name: {}",
+                    if name == tag_ref.name { "*".into() } else { tag_ref.name }
+                ));
+                if tag_ref.pgp_signature.is_some() {
+                    fields.push("signed".into());
+                }
+
+                writeln!(out, "{name} [{fields}]", fields = fields.join(", "))?;
+            }
+            _ => {
+                writeln!(out, "{name}")?;
+            }
+        }
+    }
+
+    Ok(())
+}

src/plumbing/main.rs

@@ -17,7 +17,7 @@ use crate::{
     plumbing::{
         options::{
             attributes, commit, commitgraph, config, credential, exclude, free, fsck, index, mailmap, merge, odb,
-            revision, tree, Args, Subcommands,
+            revision, tag, tree, Args, Subcommands,
         },
         show_progress,
     },
@@ -1304,6 +1304,17 @@ pub fn main() -> Result<()> {
                 },
             ),
         },
+        Subcommands::Tag(platform) => match platform.cmds {
+            Some(tag::Subcommands::List) | None => prepare_and_run(
+                "tag-list",
+                trace,
+                auto_verbose,
+                progress,
+                progress_keep_open,
+                None,
+                move |_progress, out, _err| core::repository::tag::list(repository(Mode::Lenient)?, out),
+            ),
+        },
         Subcommands::Tree(cmd) => match cmd {
             tree::Subcommands::Entries {
                 treeish,

src/plumbing/options/mod.rs

@@ -100,6 +100,9 @@ pub enum Subcommands {
     /// Interact with commit objects.
     #[clap(subcommand)]
     Commit(commit::Subcommands),
+    /// Interact with tag objects.
+    #[clap(visible_alias = "tags")]
+    Tag(tag::Platform),
     /// Verify the integrity of the entire repository
     Verify {
         #[clap(flatten)]
@@ -928,6 +931,20 @@ pub mod commit {
     }
 }
 
+pub mod tag {
+    #[derive(Debug, clap::Parser)]
+    pub struct Platform {
+        #[clap(subcommand)]
+        pub cmds: Option<Subcommands>,
+    }
+
+    #[derive(Debug, clap::Subcommand)]
+    pub enum Subcommands {
+        /// List all tags.
+        List,
+    }
+}
+
 pub mod credential {
     #[derive(Debug, clap::Subcommand)]
     pub enum Subcommands {