feat: ✨ conditional builder steps for commit message textareas

Author: lucas-labs

coco/src/cli/cfg.rs

@@ -0,0 +1 @@
+

coco/src/view/sections/builder.rs

@@ -4,6 +4,7 @@ mod preview;
 mod scope;
 mod r#type;
 mod navigation {
+    pub mod commit_step;
     pub mod form_step;
 }
 

coco/src/view/sections/builder/commit.rs

@@ -1,5 +1,9 @@
 use {
-    cc_core::{config::Theme, state::MutexAppState},
+    super::navigation::commit_step::{InputType, NavigationDirection, NavigationResult},
+    cc_core::{
+        config::{CocoConfig, Theme},
+        state::MutexAppState,
+    },
     matetui::{
         component,
         ratatui::{
@@ -12,46 +16,10 @@ use {
     tui::widgets::{CocoHeader, LabeledTextArea, LabeledTextAreaTheme, StatusHint},
 };
 
-#[derive(PartialEq, Default)]
-enum InputType {
-    #[default]
-    Summary,
-    Body,
-    Footer,
-}
-
-enum NavigationResult {
-    PrevStep,
-    Input(InputType),
-    NextStep,
-}
-
-enum NavigationDirection {
-    Next,
-    Prev,
-}
-
-impl InputType {
-    fn next(&self) -> NavigationResult {
-        match self {
-            Self::Summary => NavigationResult::Input(Self::Body),
-            Self::Body => NavigationResult::Input(Self::Footer),
-            Self::Footer => NavigationResult::NextStep,
-        }
-    }
-
-    fn prev(&self) -> NavigationResult {
-        match self {
-            Self::Summary => NavigationResult::PrevStep,
-            Self::Body => NavigationResult::Input(Self::Summary),
-            Self::Footer => NavigationResult::Input(Self::Body),
-        }
-    }
-}
-
 component! {
     pub struct CommitStep {
         theme: Theme,
+        config: CocoConfig,
         app_state: MutexAppState,
         summary_input: LabeledTextArea<'static>,
         body_input: LabeledTextArea<'static>,
@@ -104,7 +72,10 @@ impl CommitStep {
         .with_subtitle("(optional) alt/shift/ctrl + enter for new line")
         .with_active(false);
 
+        let config = { app_state.lock().unwrap().config.clone() };
+
         Self {
+            config,
             active_input: InputType::Summary,
             theme: theme.clone(),
             app_state: app_state.clone(),
@@ -117,8 +88,8 @@ impl CommitStep {
 
     fn navigate(&mut self, direction: NavigationDirection) {
         let result = match direction {
-            NavigationDirection::Next => self.active_input.next(),
-            NavigationDirection::Prev => self.active_input.prev(),
+            NavigationDirection::Next => self.active_input.next(&self.config),
+            NavigationDirection::Prev => self.active_input.prev(&self.config),
         };
 
         match result {
@@ -227,16 +198,36 @@ impl Component for CommitStep {
         let header = CocoHeader::default()
             .left_fg(self.theme.get("logo:fg:1"))
             .right_fg(self.theme.get("logo:fg:2"));
-
         let title = StatusHint::new(kind, scope);
-
         f.render_widget(header, header_area);
         f.render_widget(title, title_area);
 
-        let (summary_area, body_area, footer_area) = self.get_textareas_layout(area);
+        // draw the text areas
+
+        let (summary_area, second_textarea, third_textarea) = self.get_textareas_layout(area);
 
+        // the summary is mandatory, so it's always rendered
         f.render_widget(&self.summary_input, summary_area);
-        f.render_widget(&self.body_input, body_area);
-        f.render_widget(&self.footer_input, footer_area);
+
+        // the body and footer inputs are only rendered if they are not disabled by the user
+        // in the config and if they have been active at least once (that's what the touched flag
+        // is for, and it means that the user has navigated to the input at least once)
+
+        let footer_area = {
+            if self.config.ask_body && self.body_input.is_touched() {
+                // if the body is enabled, render it and set the footer to be rendered in the
+                // third slot of the layout (provided it's enabled)
+                f.render_widget(&self.body_input, second_textarea);
+                third_textarea
+            } else {
+                // if body is disabled, render the footer in the second slot (provided it's enabled)
+                second_textarea
+            }
+        };
+
+        // render the footer if it's enabled and has been touched
+        if self.config.ask_footer && self.footer_input.is_touched() {
+            f.render_widget(&self.footer_input, footer_area);
+        }
     }
 }

coco/src/view/sections/builder/navigation/commit_step.rs

@@ -0,0 +1,56 @@
+use cc_core::config::CocoConfig;
+
+#[derive(PartialEq, Default)]
+pub enum InputType {
+    #[default]
+    Summary,
+    Body,
+    Footer,
+}
+
+pub enum NavigationResult {
+    PrevStep,
+    Input(InputType),
+    NextStep,
+}
+
+pub enum NavigationDirection {
+    Next,
+    Prev,
+}
+
+impl InputType {
+    pub fn next(&self, config: &CocoConfig) -> NavigationResult {
+        let next = match self {
+            Self::Summary => NavigationResult::Input(Self::Body),
+            Self::Body => NavigationResult::Input(Self::Footer),
+            Self::Footer => NavigationResult::NextStep,
+        };
+
+        match next {
+            NavigationResult::Input(next) if !is_step_enabled(&next, config) => next.next(config),
+            _ => next,
+        }
+    }
+
+    pub fn prev(&self, config: &CocoConfig) -> NavigationResult {
+        let prev = match self {
+            Self::Summary => NavigationResult::PrevStep,
+            Self::Body => NavigationResult::Input(Self::Summary),
+            Self::Footer => NavigationResult::Input(Self::Body),
+        };
+
+        match prev {
+            NavigationResult::Input(prev) if !is_step_enabled(&prev, config) => prev.prev(config),
+            _ => prev,
+        }
+    }
+}
+
+fn is_step_enabled(step: &InputType, config: &CocoConfig) -> bool {
+    match step {
+        InputType::Summary => true,
+        InputType::Body => config.ask_body,
+        InputType::Footer => config.ask_footer,
+    }
+}

coco/src/view/sections/builder/navigation/form_step.rs

@@ -1,59 +1,61 @@
-use cc_core::config::CocoConfig;
-use strum::{Display, EnumString};
-
-#[derive(Default, EnumString, Display, PartialEq, Eq, Clone)]
-#[strum(serialize_all = "kebab-case")]
-pub enum FormStep {
-    #[default]
-    Type,
-    Scope,
-    Commit,
-    BreakingChange,
-    Preview,
-}
-
-impl FormStep {
-    pub fn next(&self, config: &CocoConfig) -> Option<Self> {
-        let next = match self {
-            Self::Type => Self::Scope,
-            Self::Scope => Self::Commit,
-            Self::Commit => Self::BreakingChange,
-            Self::BreakingChange => Self::Preview,
-            Self::Preview => return None,
-        };
-
-        // if the next step is disabled by the config, skip it by going to the next one
-        if !is_step_enabled(&next, config) {
-            return next.next(config);
-        }
-
-        Some(next)
-    }
-
-    pub fn prev(&self, config: &CocoConfig) -> Option<Self> {
-        let prev = match self {
-            Self::Type => return None,
-            Self::Scope => Self::Type,
-            Self::Commit => Self::Scope,
-            Self::BreakingChange => Self::Commit,
-            Self::Preview => Self::BreakingChange,
-        };
-
-        // if the previous step is disabled by the config, skip it by going to the previous one
-        if !is_step_enabled(&prev, config) {
-            return prev.prev(config);
-        }
-
-        Some(prev)
-    }
-}
-
-fn is_step_enabled(step: &FormStep, config: &CocoConfig) -> bool {
-    match step {
-        FormStep::Type => true,
-        FormStep::Scope => config.ask_scope,
-        FormStep::Commit => true,
-        FormStep::BreakingChange => config.ask_breaking_change,
-        FormStep::Preview => true,
-    }
-}
+use {
+    cc_core::config::CocoConfig,
+    strum::{Display, EnumString},
+};
+
+#[derive(Default, EnumString, Display, PartialEq, Eq, Clone)]
+#[strum(serialize_all = "kebab-case")]
+pub enum FormStep {
+    #[default]
+    Type,
+    Scope,
+    Commit,
+    BreakingChange,
+    Preview,
+}
+
+impl FormStep {
+    pub fn next(&self, config: &CocoConfig) -> Option<Self> {
+        let next = match self {
+            Self::Type => Self::Scope,
+            Self::Scope => Self::Commit,
+            Self::Commit => Self::BreakingChange,
+            Self::BreakingChange => Self::Preview,
+            Self::Preview => return None,
+        };
+
+        // if the next step is disabled by the config, skip it by going to the next one
+        if !is_step_enabled(&next, config) {
+            return next.next(config);
+        }
+
+        Some(next)
+    }
+
+    pub fn prev(&self, config: &CocoConfig) -> Option<Self> {
+        let prev = match self {
+            Self::Type => return None,
+            Self::Scope => Self::Type,
+            Self::Commit => Self::Scope,
+            Self::BreakingChange => Self::Commit,
+            Self::Preview => Self::BreakingChange,
+        };
+
+        // if the previous step is disabled by the config, skip it by going to the previous one
+        if !is_step_enabled(&prev, config) {
+            return prev.prev(config);
+        }
+
+        Some(prev)
+    }
+}
+
+fn is_step_enabled(step: &FormStep, config: &CocoConfig) -> bool {
+    match step {
+        FormStep::Type => true,
+        FormStep::Scope => config.ask_scope,
+        FormStep::Commit => true,
+        FormStep::BreakingChange => config.ask_breaking_change,
+        FormStep::Preview => true,
+    }
+}

tui/src/widgets/coco_textarea.rs

@@ -48,6 +48,7 @@ pub struct LabeledTextArea<'a> {
     title: String,
     subtitle: Option<String>,
     th: LabeledTextAreaTheme,
+    touched: bool,
     active: bool,
 }
 
@@ -75,6 +76,7 @@ impl<'a> LabeledTextArea<'a> {
             title: "Title".to_string(),
             subtitle: Some("Subtitle".to_string()),
             active: true,
+            touched: true, // if it starts active, it should be considered touched already
             th,
         }
     }
@@ -102,6 +104,9 @@ impl<'a> LabeledTextArea<'a> {
         self.active = active;
 
         if active {
+            // if active, set the textarea as touched too
+            self.touched = true;
+
             // enable cursor styles
             self.inner = self
                 .inner
@@ -134,6 +139,7 @@ impl<'a> LabeledTextArea<'a> {
     /// Set the active status of the text area.
     pub fn with_active(mut self, active: bool) -> Self {
         self.set_active(active);
+        self.touched = active;
         self
     }
 
@@ -204,6 +210,14 @@ impl<'a> LabeledTextArea<'a> {
         const MIN_HEIGHT: usize = 1;
         cmp::max(self.lines().len(), MIN_HEIGHT) as u16 + 3
     }
+
+    /// Get the touched status of the text area.
+    ///
+    /// A text area is considered touched if it has been active at least once.
+    /// This is useful to know if the user has interacted with the text area.
+    pub fn is_touched(&self) -> bool {
+        self.touched
+    }
 }
 
 impl Widget for &LabeledTextArea<'_> {