feat: add gix is-clean|is-changed

It's a good way to compare the time it takes to run a full status
compared to a quick is-dirty check.

Author: Byron

gitoxide-core/src/repository/dirty.rs

@@ -0,0 +1,23 @@
+use anyhow::bail;
+
+pub enum Mode {
+    IsClean,
+    IsDirty,
+}
+
+pub fn check(repo: gix::Repository, mode: Mode, out: &mut dyn std::io::Write) -> anyhow::Result<()> {
+    let is_dirty = repo.is_dirty()?;
+    let res = match (is_dirty, mode) {
+        (false, Mode::IsClean) => Ok("The repository is clean"),
+        (true, Mode::IsClean) => Err("The repository has changes"),
+        (false, Mode::IsDirty) => Err("The repository is clean"),
+        (true, Mode::IsDirty) => Ok("The repository has changes"),
+    };
+
+    let suffix = "(not counting untracked files)";
+    match res {
+        Ok(msg) => writeln!(out, "{msg} {suffix}")?,
+        Err(msg) => bail!("{msg} {suffix}"),
+    }
+    Ok(())
+}

gitoxide-core/src/repository/mod.rs

@@ -26,6 +26,7 @@ pub use credential::function as credential;
 pub mod attributes;
 #[cfg(feature = "clean")]
 pub mod clean;
+pub mod dirty;
 #[cfg(feature = "clean")]
 pub use clean::function::clean;
 #[cfg(feature = "blocking-client")]

src/plumbing/main.rs

@@ -146,6 +146,22 @@ pub fn main() -> Result<()> {
     }
 
     match cmd {
+        Subcommands::IsClean | Subcommands::IsChanged => {
+            let mode = if matches!(cmd, Subcommands::IsClean) {
+                core::repository::dirty::Mode::IsClean
+            } else {
+                core::repository::dirty::Mode::IsDirty
+            };
+            prepare_and_run(
+                "clean",
+                trace,
+                verbose,
+                progress,
+                progress_keep_open,
+                None,
+                move |_progress, out, _err| core::repository::dirty::check(repository(Mode::Lenient)?, mode, out),
+            )
+        }
         #[cfg(feature = "gitoxide-core-tools-clean")]
         Subcommands::Clean(crate::plumbing::options::clean::Command {
             debug,

src/plumbing/options/mod.rs

@@ -130,6 +130,8 @@ pub enum Subcommands {
     /// Interact with submodules.
     #[clap(alias = "submodules")]
     Submodule(submodule::Platform),
+    IsClean,
+    IsChanged,
     /// Show which git configuration values are used or planned.
     ConfigTree,
     Status(status::Platform),