feat: Add an option to amend a TODO in the commit message if not all DoD checks are ticked

TODO:
- [ ] Relevant documentation (code comments, READMEs, etc.) is updated.

Author: cladam

src/main.rs

@@ -5,7 +5,7 @@ use std::fs;
 use anyhow::{Result, Context};
 use clap::Parser;
 use colored::Colorize;
-use dialoguer::{MultiSelect, theme::ColorfulTheme};
+use dialoguer::{MultiSelect, theme::ColorfulTheme, Confirm};
 
 #[derive(Debug, Deserialize)]
 struct DodConfig {
@@ -21,12 +21,22 @@ fn read_dod_config() -> Result<DodConfig> {
     Ok(config)
 }
 
-fn run_checklist_interactive(checklist: &[String]) -> Result<bool> {
+fn run_checklist_interactive(checklist: &[String]) -> anyhow::Result<Vec<usize>> {
     let selections = MultiSelect::with_theme(&ColorfulTheme::default())
         .with_prompt("Please confirm each item before committing:")
-        .items(&checklist)
+        .items(checklist)
         .interact()?;
-    Ok(selections.len() == checklist.len())
+    Ok(selections)
+}
+
+fn build_todo_footer(checklist: &[String], checked_indices: &[usize]) -> String {
+    let mut footer = String::from("\nTODO:\n");
+    for (i, item) in checklist.iter().enumerate() {
+        if !checked_indices.contains(&i) {
+            footer.push_str(&format!("- [ ] {}\n", item));
+        }
+    }
+    footer
 }
 
 fn main() -> anyhow::Result<()> {
@@ -44,19 +54,27 @@ fn main() -> anyhow::Result<()> {
         }
         cli::Commands::Commit { r#type, scope, message, no_verify} => {
             println!("--- Committing changes ---");
+            let scope_part = scope.map_or("".to_string(), |s| format!("({})", s));
+            let header = format!("{}{}: {}", r#type, scope_part, message);
+            let mut commit_message = format!("{}", header);
+
             if !no_verify {
+                let checked = run_checklist_interactive(&config.checklist)?;
+                if Confirm::with_theme(&ColorfulTheme::default())
+                    .with_prompt("Warning: Not all DoD items were checked. Proceed by adding a 'TODO' list to the commit message? (Y/n)")
+                    .interact()?
+                {
+                    let todo_footer = build_todo_footer(&config.checklist, &checked);
+                    commit_message.push_str(&todo_footer);
+                } else {
+                    println!("Commit aborted.");
+                    return Ok(());
+                }
                 if config.issue_reference_required.unwrap_or(false) {
                     println!("{}", "Issue reference is required for commits.".red());
                     return Err(anyhow::anyhow!("Issue reference required"));
                 }
-                if !run_checklist_interactive(&config.checklist)? {
-                    println!("Not all checklist items confirmed. Commit aborted.");
-                    return Ok(());
-                }
             }
-            let scope_part = scope.map_or("".to_string(), |s| format!("({})", s));
-            let header = format!("{}{}: {}", r#type, scope_part, message);
-            let commit_message = format!("{}", header);
 
             println!("{}", format!("Commit message will be:\n---\n{}\n---", commit_message).blue());
             // Stage changes first, before any other operations.