feat(CLI): add git dirty check for run commands (#1618)

amirabbas-gh · web-flow · commit e74d1ef46ca0 · 2025-07-17T20:49:54.000+03:30
* feat: add dirty git checker

* feat: add dirty_git_check command into run, jssg/run and workflow/run command

* refactor: using inquire insted of std::io

* feat: add .git and git is installed check for dirty cheker

* refactor: delete condition for check git status result in porcelain
diff --git a/crates/cli/src/commands/jssg/run.rs b/crates/cli/src/commands/jssg/run.rs
@@ -8,6 +8,8 @@ use codemod_sandbox::sandbox::{
 };
 use std::{path::Path, sync::Arc};
 
+use crate::dirty_git_check;
+
 #[derive(Args, Debug)]
 pub struct Command {
     /// Path to the JavaScript file to execute
@@ -39,6 +41,10 @@ pub struct Command {
     /// File extensions to process (comma-separated)
     #[arg(long)]
     pub extensions: Option<String>,
+
+    /// Allow dirty git status
+    #[arg(long)]
+    pub allow_dirty: bool,
 }
 
 pub async fn handler(args: &Command) -> Result<()> {
@@ -60,6 +66,8 @@ pub async fn handler(args: &Command) -> Result<()> {
     let mut config = ExecutionConfig::new(filesystem, resolver, loader, script_base_dir);
     let mut walk_options = WalkOptions::default();
 
+    dirty_git_check::dirty_check(args.allow_dirty)?;
+
     // Apply command line options
     if args.no_gitignore {
         walk_options.respect_gitignore = false;
diff --git a/crates/cli/src/commands/run.rs b/crates/cli/src/commands/run.rs
@@ -6,6 +6,7 @@ use std::path::{Path, PathBuf};
 use std::process::Command as ProcessCommand;
 
 use crate::auth_provider::CliAuthProvider;
+use crate::dirty_git_check;
 use crate::workflow_runner::{run_workflow, WorkflowRunConfig};
 use butterflow_core::engine::Engine;
 use butterflow_core::registry::{RegistryClient, RegistryConfig, RegistryError};
@@ -35,12 +36,18 @@ pub struct Command {
     /// Additional arguments to pass to the codemod
     #[arg(last = true)]
     args: Vec<String>,
+
+    /// Allow dirty git status
+    #[arg(long)]
+    allow_dirty: bool,
 }
 
 pub async fn handler(engine: &Engine, args: &Command) -> Result<()> {
     // Create auth provider
     let auth_provider = CliAuthProvider::new()?;
 
+    dirty_git_check::dirty_check(args.allow_dirty)?;
+
     // Get cache directory and default registry from config
     let cache_dir = get_cache_dir()?;
     let config = auth_provider.storage.load_config()?;
diff --git a/crates/cli/src/commands/workflow/run.rs b/crates/cli/src/commands/workflow/run.rs
@@ -3,6 +3,7 @@ use butterflow_core::engine::Engine;
 use butterflow_core::utils;
 use clap::Args;
 
+use crate::dirty_git_check;
 use crate::workflow_runner::{resolve_workflow_source, run_workflow, WorkflowRunConfig};
 
 #[derive(Args, Debug)]
@@ -14,6 +15,10 @@ pub struct Command {
     /// Workflow parameters (format: key=value)
     #[arg(long = "param", value_name = "KEY=VALUE")]
     params: Vec<String>,
+
+    /// Allow dirty git status
+    #[arg(long)]
+    allow_dirty: bool,
 }
 
 /// Run a workflow
@@ -32,6 +37,8 @@ pub async fn handler(engine: &Engine, args: &Command) -> Result<()> {
         wait_for_completion: true,
     };
 
+    dirty_git_check::dirty_check(args.allow_dirty)?;
+
     // Run workflow using the extracted workflow runner
     run_workflow(engine, config).await?;
 
diff --git a/crates/cli/src/dirty_git_check.rs b/crates/cli/src/dirty_git_check.rs
@@ -0,0 +1,30 @@
+use anyhow::Result;
+use inquire::Confirm;
+use std::path::Path;
+use std::process::Command;
+
+pub fn dirty_check(allow_dirty: bool) -> Result<()> {
+    if !allow_dirty
+        && Command::new("git").arg("--version").output().is_ok()
+        && Path::new(".git").exists()
+    {
+        let output = Command::new("git")
+            .args(["status", "--porcelain"])
+            .output()
+            .expect("Failed to run git");
+
+        if !output.stdout.is_empty() {
+            let answer =
+                Confirm::new("⚠️  You have uncommitted changes. Do you want to continue anyway?")
+                    .with_default(false)
+                    .with_help_message("Press 'y' to continue or 'n' to abort")
+                    .prompt()?;
+
+            if !answer {
+                return Err(anyhow::anyhow!("Aborting due to uncommitted changes"));
+            }
+        }
+    }
+
+    Ok(())
+}
diff --git a/crates/cli/src/main.rs b/crates/cli/src/main.rs
@@ -6,6 +6,7 @@ mod ascii_art;
 mod auth;
 mod auth_provider;
 mod commands;
+mod dirty_git_check;
 mod engine;
 mod workflow_runner;
 use ascii_art::print_ascii_art;
