rust/glint: Add fix mode (#2813)

Signed-off-by: Ryan Northey <[email protected]>

Author: phlax

rust/glint/Cargo.toml

@@ -13,3 +13,4 @@ serde_json = "1.0"
 
 [dev-dependencies]
 serde_json = "1.0"
+tempfile = "3.0"

rust/glint/src/args.rs

@@ -5,6 +5,9 @@ use std::path::PathBuf;
 #[command(name = "glint")]
 #[command(about = "Lint files for whitespace issues", long_about = None)]
 pub struct Args {
+    #[arg(short, long)]
+    pub fix: bool,
+
     #[arg(required = true)]
     pub paths: Vec<PathBuf>,
 }

rust/glint/src/fix.rs

@@ -0,0 +1,64 @@
+use anyhow::{Context, Result};
+use std::fs;
+use std::path::Path;
+
+#[derive(Debug)]
+pub struct FixResult {
+    pub trailing_whitespace_fixed: usize,
+    pub tabs_converted: usize,
+    pub final_newline_added: bool,
+}
+
+pub fn fix_file(path: &Path) -> Result<Option<FixResult>> {
+    let content = fs::read_to_string(path)
+        .with_context(|| format!("Failed to read file: {}", path.display()))?;
+
+    let mut fixed_lines = Vec::new();
+    let mut trailing_whitespace_fixed = 0;
+    let mut tabs_converted = 0;
+    let mut changed = false;
+
+    for line in content.lines() {
+        let mut fixed_line = line.to_string();
+
+        let tab_count = fixed_line.chars().filter(|&c| c == '\t').count();
+
+        if tab_count > 0 {
+            fixed_line = fixed_line.replace('\t', "    ");
+            tabs_converted += tab_count;
+            changed = true;
+        }
+
+        let trimmed = fixed_line.trim_end();
+        if trimmed.len() < fixed_line.len() {
+            fixed_line = trimmed.to_string();
+            trailing_whitespace_fixed += 1;
+            changed = true;
+        }
+
+        fixed_lines.push(fixed_line);
+    }
+
+    let needs_final_newline = !content.is_empty() && !content.ends_with('\n');
+    let mut fixed_content = fixed_lines.join("\n");
+
+    if !content.is_empty() && content.ends_with('\n') {
+        fixed_content.push('\n');
+    } else if needs_final_newline {
+        fixed_content.push('\n');
+        changed = true;
+    }
+
+    if changed {
+        fs::write(path, fixed_content)
+            .with_context(|| format!("Failed to write file: {}", path.display()))?;
+
+        Ok(Some(FixResult {
+            trailing_whitespace_fixed,
+            tabs_converted,
+            final_newline_added: needs_final_newline,
+        }))
+    } else {
+        Ok(None)
+    }
+}

rust/glint/src/main.rs

@@ -1,6 +1,7 @@
 mod args;
 mod check;
 mod files;
+mod fix;
 
 use anyhow::Result;
 use clap::Parser;
@@ -13,7 +14,8 @@ use std::sync::{
 };
 
 use crate::args::Args;
-use crate::files::{FileIssues, find_files, process_file};
+use crate::files::{FileIssues, find_files, process_file, should_exclude};
+use crate::fix::fix_file;
 
 #[derive(Debug, Serialize, Deserialize)]
 struct LintResult {
@@ -28,8 +30,29 @@ struct Summary {
     total_issues: usize,
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+struct FixResult {
+    files: HashMap<String, FixedFileInfo>,
+    summary: FixSummary,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+struct FixedFileInfo {
+    trailing_whitespace_fixed: usize,
+    tabs_converted: usize,
+    final_newline_added: bool,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+struct FixSummary {
+    total_files: usize,
+    files_fixed: usize,
+    total_fixes: usize,
+}
+
 fn main() -> Result<()> {
     let args = Args::parse();
+
     let mut all_files = Vec::new();
     for path in &args.paths {
         if !path.exists() {
@@ -44,8 +67,72 @@ fn main() -> Result<()> {
         return Ok(());
     }
 
+    if args.fix {
+        let mut fixed_files = HashMap::new();
+        let mut error_count = 0;
+        let mut total_files_checked = 0;
+
+        for file in &all_files {
+            if should_exclude(file) {
+                continue;
+            }
+
+            total_files_checked += 1;
+
+            match fix_file(file) {
+                Ok(Some(result)) => {
+                    fixed_files.insert(
+                        file.display().to_string(),
+                        FixedFileInfo {
+                            trailing_whitespace_fixed: result.trailing_whitespace_fixed,
+                            tabs_converted: result.tabs_converted,
+                            final_newline_added: result.final_newline_added,
+                        },
+                    );
+                }
+                Ok(None) => {
+                    // No fixes needed for this file
+                }
+                Err(e) => {
+                    eprintln!("Error fixing {}: {}", file.display(), e);
+                    error_count += 1;
+                }
+            }
+        }
+
+        if error_count > 0 {
+            std::process::exit(1);
+        }
+
+        if !fixed_files.is_empty() {
+            let files_fixed = fixed_files.len();
+            let total_fixes: usize = fixed_files
+                .values()
+                .map(|f| {
+                    f.trailing_whitespace_fixed
+                        + f.tabs_converted
+                        + if f.final_newline_added { 1 } else { 0 }
+                })
+                .sum();
+
+            let result = FixResult {
+                files: fixed_files,
+                summary: FixSummary {
+                    total_files: total_files_checked,
+                    files_fixed,
+                    total_fixes,
+                },
+            };
+
+            println!("{}", serde_json::to_string_pretty(&result)?);
+        }
+
+        return Ok(());
+    }
+
     let file_issues = Mutex::new(HashMap::new());
     let had_error = AtomicBool::new(false);
+
     all_files
         .par_iter()
         .for_each(|file| match process_file(file) {
@@ -61,8 +148,6 @@ fn main() -> Result<()> {
         });
 
     let files = file_issues.into_inner().unwrap();
-
-    // Calculate summary
     let total_files = all_files.len();
     let files_with_issues = files.len();
     let total_issues: usize = files.values().map(|f| f.total_issues()).sum();
@@ -76,13 +161,9 @@ fn main() -> Result<()> {
         },
     };
 
-    // Output JSON
     println!("{}", serde_json::to_string_pretty(&result)?);
-
-    // Exit with non-zero status if there were issues
     if files_with_issues > 0 || had_error.load(Ordering::Relaxed) {
         std::process::exit(1);
     }
-
     Ok(())
 }

rust/glint/tests/fixtures/bad.txt.expected_fix.json

@@ -0,0 +1,14 @@
+{
+  "files": {
+    "tests/fixtures/bad.txt": {
+      "trailing_whitespace_fixed": 7,
+      "tabs_converted": 12,
+      "final_newline_added": true
+    }
+  },
+  "summary": {
+    "total_files": 1,
+    "files_fixed": 1,
+    "total_fixes": 20
+  }
+}

rust/glint/tests/fixtures/bad.txt.expected_fixed

@@ -0,0 +1,50 @@
+This is line 1 with trailing spaces
+    This line 2 starts with a tab
+ This line 3 starts with a space
+Line 4 is normal
+Line 5 has trailing tabs
+    Another tab-indented line (6)
+Line 7 is clean
+ Space-indented line 8
+Line 9 is normal
+Line 10 ends with mixed whitespace
+    Tab line 11
+Line 12 is clean
+Line 13 is normal
+ Space line 14
+Line 15 has a trailing space
+Line 16 is clean
+    Tab line 17
+Line 18 is normal
+Line 19 is clean
+Line 20 with trailing whitespace
+ Space line 21
+Line 22 is normal
+    Tab line 23
+Line 24 is clean
+Line 25 is normal
+Line 26 is clean
+ Space line 27
+Line 28 is normal
+Line 29 is clean
+Line 30 has many trailing spaces
+    Tab line 31
+Line 32 is normal
+ Space line 33
+Line 34 is clean
+Line 35 is normal
+Line 36 is clean
+    Tab line 37
+Line 38 is normal
+Line 39 is clean
+Line 40 with subtle trailing space
+ Space line 41
+Line 42 is normal
+    Tab line 43
+Line 44 is clean
+Line 45 is normal
+Line 46 is clean
+ Space line 47
+Line 48 is normal
+Line 49 is clean
+Line 50 is the last line with no newline

rust/glint/tests/fixtures/bad2.txt.expected_fix.json

@@ -0,0 +1,14 @@
+{
+  "files": {
+    "tests/fixtures/bad2.txt": {
+      "trailing_whitespace_fixed": 2,
+      "tabs_converted": 3,
+      "final_newline_added": true
+    }
+  },
+  "summary": {
+    "total_files": 1,
+    "files_fixed": 1,
+    "total_fixes": 6
+  }
+}

rust/glint/tests/fixtures/bad2.txt.expected_fixed

@@ -0,0 +1,7 @@
+Line 1 is clean
+Line 2 has trailing space
+    Tab indented line 3
+Line 4 is normal
+Line 5 ends with tabs
+ Space indented line 6
+Line 7 is the last line without newline

rust/glint/tests/fixtures/bad3.txt.expected_fix.json

@@ -0,0 +1,14 @@
+{
+  "files": {
+    "tests/fixtures/bad3.txt": {
+      "trailing_whitespace_fixed": 4,
+      "tabs_converted": 2,
+      "final_newline_added": false
+    }
+  },
+  "summary": {
+    "total_files": 1,
+    "files_fixed": 1,
+    "total_fixes": 6
+  }
+}

rust/glint/tests/fixtures/bad3.txt.expected_fixed

@@ -0,0 +1,7 @@
+This file only has trailing whitespace issues
+Line 2 also has trailing spaces
+Line 3 is clean
+Line 4 has a tab at the end
+Line 5 is clean
+Line 6 has mixed trailing whitespace
+Final line with newline