feat: gix submodules list --dirty-suffix for dirty-information

Byron · Byron · commit afd20caadb40 · 2024-03-10T10:21:57.000+01:00
This is a submodule-centric and greatly simplified way of obtaining
describe information with dirty-suffix.

Note that `status` information is also possible, but it seems
hard to display nicely, which this command isn't great at
in the first place.
diff --git a/gitoxide-core/src/repository/submodule.rs b/gitoxide-core/src/repository/submodule.rs
@@ -3,7 +3,12 @@ use gix::{commit::describe::SelectRef, prelude::ObjectIdExt, Repository, Submodu
 
 use crate::OutputFormat;
 
-pub fn list(repo: Repository, mut out: impl std::io::Write, format: OutputFormat) -> anyhow::Result<()> {
+pub fn list(
+    repo: Repository,
+    mut out: impl std::io::Write,
+    format: OutputFormat,
+    dirty_suffix: Option<String>,
+) -> anyhow::Result<()> {
     if format != OutputFormat::Human {
         bail!("Only human output is supported for now")
     }
@@ -12,12 +17,12 @@ pub fn list(repo: Repository, mut out: impl std::io::Write, format: OutputFormat
         return Ok(());
     };
     for sm in submodules {
-        print_sm(sm, &mut out)?;
+        print_sm(sm, dirty_suffix.as_deref(), &mut out)?;
     }
     Ok(())
 }
 
-fn print_sm(sm: Submodule<'_>, out: &mut impl std::io::Write) -> anyhow::Result<()> {
+fn print_sm(sm: Submodule<'_>, dirty_suffix: Option<&str>, out: &mut impl std::io::Write) -> anyhow::Result<()> {
     let _span = gix::trace::coarse!("print_sm", path = ?sm.path());
     let state = sm.state()?;
     let mut sm_repo = sm.open()?;
@@ -48,7 +53,10 @@ fn print_sm(sm: Submodule<'_>, out: &mut impl std::io::Write) -> anyhow::Result<
                 repo.head_commit()?
                     .describe()
                     .names(SelectRef::AllRefs)
-                    .format()?
+                    .id_as_fallback(true)
+                    .try_resolve()?
+                    .expect("resolution present if ID can be used as fallback")
+                    .format_with_dirty_suffix(dirty_suffix.map(ToOwned::to_owned))?
                     .to_string()
             }
             None => {
diff --git a/src/plumbing/main.rs b/src/plumbing/main.rs
@@ -223,16 +223,23 @@ pub fn main() -> Result<()> {
         ),
         Subcommands::Submodule(platform) => match platform
             .cmds
-            .unwrap_or(crate::plumbing::options::submodule::Subcommands::List)
+            .unwrap_or(crate::plumbing::options::submodule::Subcommands::List { dirty_suffix: None })
         {
-            crate::plumbing::options::submodule::Subcommands::List => prepare_and_run(
+            crate::plumbing::options::submodule::Subcommands::List { dirty_suffix } => prepare_and_run(
                 "submodule-list",
                 trace,
                 verbose,
                 progress,
                 progress_keep_open,
                 None,
-                move |_progress, out, _err| core::repository::submodule::list(repository(Mode::Lenient)?, out, format),
+                move |_progress, out, _err| {
+                    core::repository::submodule::list(
+                        repository(Mode::Lenient)?,
+                        out,
+                        format,
+                        dirty_suffix.map(|suffix| suffix.unwrap_or_else(|| "dirty".to_string())),
+                    )
+                },
             ),
         },
         #[cfg(feature = "gitoxide-core-tools-archive")]
diff --git a/src/plumbing/options/mod.rs b/src/plumbing/options/mod.rs
@@ -875,7 +875,11 @@ pub mod submodule {
     #[derive(Debug, clap::Subcommand)]
     pub enum Subcommands {
         /// Print all direct submodules to standard output
-        List,
+        List {
+            /// Set the suffix to append if the repository is dirty (not counting untracked files).
+            #[clap(short = 'd', long)]
+            dirty_suffix: Option<Option<String>>,
+        },
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -875,7 +875,11 @@ pub mod submodule {`
`875`	`875`	`#[derive(Debug, clap::Subcommand)]`
`876`	`876`	`pub enum Subcommands {`
`877`	`877`	`/// Print all direct submodules to standard output`
`878`		`- List,`
	`878`	`+ List {`
	`879`	`+ /// Set the suffix to append if the repository is dirty (not counting untracked files).`
	`880`	`+ #[clap(short = 'd', long)]`
	`881`	`+ dirty_suffix: Option<Option<String>>,`
	`882`	`+ },`
`879`	`883`	`}`
`880`	`884`	`}`
`881`	`885`